MipMapImage.java

/**
 * License: GPL
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License 2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package ini.trakem2.display;

import java.awt.Image;

/**
 * <p>A MipMap is a container for an {@link Image} and its corresponding
 * inverse <em>x</em>/<em>y</em> scale relative to an original {@link Image}
 * it was generated from.</p>
 * 
 * <p>In a scale pyramid as used for mipmap generation, the inverse scale for
 * both <em>x</em> and <em>y</em> is usually<p>
 * 
 * <p><em>s</em> = 2<sup>level</sup></p>
 * 
 * <p>Note that the exact scale cannot be inferred from the sizes of the mipmap
 * {@link Image} and its origin because the number of pixels is an integer in
 * both {@link Image Images}.
 *
 * @author Stephan Saalfeld saalfeld@mpi-cbg.de
 */
public final class MipMapImage
{
	final public Image image;
	final public double scaleX, scaleY;
	
	public MipMapImage( final Image image, final double scaleX, final double scaleY )
	{
		this.image = image;
		this.scaleX = scaleX;
		this.scaleY = scaleY;
	}
}