TrakEM2_/src/main/java/ini/trakem2/display/MipMapImage.java

   1 /**
   2  * License: GPL
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License 2
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  16  */
  17 package ini.trakem2.display;
  18
  19 import java.awt.Image;
  20
  21 /**
  22  * <p>A MipMap is a container for an {@link Image} and its corresponding
  23  * inverse <em>x</em>/<em>y</em> scale relative to an original {@link Image}
  24  * it was generated from.</p>
  25  *
  26  * <p>In a scale pyramid as used for mipmap generation, the inverse scale for
  27  * both <em>x</em> and <em>y</em> is usually<p>
  28  *
  29  * <p><em>s</em> = 2<sup>level</sup></p>
  30  *
  31  * <p>Note that the exact scale cannot be inferred from the sizes of the mipmap
  32  * {@link Image} and its origin because the number of pixels is an integer in
  33  * both {@link Image Images}.
  34  *
  35  * @author Stephan Saalfeld <saalfeld@mpi-cbg.de>
  36  */
  37 public final class MipMapImage
  38 {
  39         final public Image image;
  40         final public double scaleX, scaleY;
  41
  42         public MipMapImage( final Image image, final double scaleX, final double scaleY )
  43         {
  44                 this.image = image;
  45                 this.scaleX = scaleX;
  46                 this.scaleY = scaleY;
  47         }
  48 }