AbstractMultiLevelSource (SNAP Engine API)

java.lang.Object
- com.bc.ceres.glevel.support.AbstractMultiLevelSource

All Implemented Interfaces:

MultiLevelSource

Direct Known Subclasses:

ColoredBandImageMultiLevelSource, ColoredMaskImageMultiLevelSource, DefaultMultiLevelSource, FileMultiLevelSource, GenericMultiLevelSource, TiledFileMultiLevelSource
```
public abstract class AbstractMultiLevelSource
extends Object
implements MultiLevelSource
```
An abstract base class for MultiLevelSource implementations. Level images are cached unless reset() is called. Subclasses are asked to implement createImage(int).

Field Summary
- Fields inherited from interface com.bc.ceres.glevel.MultiLevelSource
  NULL

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractMultiLevelSource(MultiLevelModel multiLevelModel)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractMultiLevelSource(MultiLevelModel multiLevelModel)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`checkLevel(int level)` Utility method which checks if a given level is valid.
`protected abstract RenderedImage`	`createImage(int level)` Called by `getImage(int)` if a level image is requested for the first time.
`RenderedImage`	`getImage(int level)` Gets the `RenderedImage` at the given resolution level.
`static Dimension`	`getImageDimension(int width, int height, double scale)` Deprecated. since Ceres 0.14, lower-level resolutions of image pyramids are computed in the JPEG2000-style, that is `newSize=(int)ceil(scale * size)` (ceiling integer), while JAI is `newSize=(int)ceil(scale * size - 0.5)` (rounding to nearest integer). Please use `getImageRectangle(int, int, int, int, double)` instead.
`static Rectangle`	`getImageRectangle(int minX, int minY, int width, int height, double scale)` Deprecated. since Ceres 0.14, lower-level resolutions of image pyramids are computed in the JPEG2000-style, that is `newSize=(int)ceil(scale * size)` (ceiling integer), while JAI is `newSize=(int)ceil(scale * size - 0.5)` (rounding to nearest integer). Please use `getImageRectangle(int, int, int, int, double)` instead.
`Shape`	`getImageShape(int level)` Gets the shape of the area where this image's raster data contains valid pixels at the given resolution level.
`MultiLevelModel`	`getModel()` Gets the layout model for the multi-resolution image supported by this `LevelImageSource`.
`void`	`reset()` Removes all cached level images and also disposes any `PlanarImage`s among them.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractMultiLevelSource
```
protected AbstractMultiLevelSource(MultiLevelModel multiLevelModel)
```
- Method Detail
  - getModel
```
public MultiLevelModel getModel()
```
    Description copied from interface: MultiLevelSource
    
    Gets the layout model for the multi-resolution image supported by this LevelImageSource.
    
    Specified by:
    
    getModel in interface MultiLevelSource
    
    Returns:
    
    the multi-resolution image model.
  - getImage
```
public RenderedImage getImage(int level)
```
    Gets the RenderedImage at the given resolution level. Unless reset() is called, the method will always return the same image instance at the same resolution level. If a level image is requested for the first time, the method calls createImage(int) in order to retrieve the actual image instance.
    
    Specified by:
    
    getImage in interface MultiLevelSource
    
    Parameters:
    
    level - The resolution level.
    
    Returns:
    
    The RenderedImage at the given resolution level.
  - getImageShape
```
public Shape getImageShape(int level)
```
    Description copied from interface: MultiLevelSource
    
    Gets the shape of the area where this image's raster data contains valid pixels at the given resolution level. The method returns null, if the entire image raster contains valid pixels.
    
    Specified by:
    
    getImageShape in interface MultiLevelSource
    
    Parameters:
    
    level - The resolution level.
    
    Returns:
    
    The shape of the area where the image has data, can be null.
  - createImage
```
protected abstract RenderedImage createImage(int level)
```
    Called by getImage(int) if a level image is requested for the first time. Note that images created via this method will be disposed when reset() is called on this multi-level image source. See getImage(int).
    The dimension of the level image created must be the same as that obtained from getImageDimension(int, int, double) for the scale associated with the given resolution level.
    
    Parameters:
    
    level - The resolution level.
    
    Returns:
    
    An instance of a RenderedImage for the given resolution level.
  - reset
```
public void reset()
```
    Removes all cached level images and also disposes any PlanarImages among them.
    Overrides should always call super.reset().
    
    Specified by:
    
    reset in interface MultiLevelSource
  - checkLevel
```
protected void checkLevel(int level)
```
    Utility method which checks if a given level is valid.
    
    Parameters:
    
    level - The resolution level.
    
    Throws:
    
    IllegalArgumentException - if level < 0 || level >= getModel().getLevelCount()
  - getImageDimension
```
@Deprecated
public static Dimension getImageDimension(int width,
                                                       int height,
                                                       double scale)
```
    Deprecated. since Ceres 0.14, lower-level resolutions of image pyramids are computed in the JPEG2000-style, that is newSize=(int)ceil(scale * size) (ceiling integer), while JAI is newSize=(int)ceil(scale * size - 0.5) (rounding to nearest integer). Please use getImageRectangle(int, int, int, int, double) instead.
    
    Computes the dimension of an image at a certain level. The image dimension computed is the same as that obtained from javax.media.jai.operator.ScaleDescriptor.create(...).
    
    Parameters:
    
    width - The width of the image in pixels at level zero.
    
    height - The height of the image in pixels at level zero.
    
    scale - The scale at the level of interest.
    
    Returns:
    
    the dimension of the image at the level of interest.
  - getImageRectangle
```
@Deprecated
public static Rectangle getImageRectangle(int minX,
                                                       int minY,
                                                       int width,
                                                       int height,
                                                       double scale)
```
    Deprecated. since Ceres 0.14, lower-level resolutions of image pyramids are computed in the JPEG2000-style, that is newSize=(int)ceil(scale * size) (ceiling integer), while JAI is newSize=(int)ceil(scale * size - 0.5) (rounding to nearest integer). Please use getImageRectangle(int, int, int, int, double) instead.
    
    Computes the rectangle of an image at a certain level. The image rectangle computed is the same as that obtained from javax.media.jai.operator.ScaleDescriptor.create(...).
    
    Parameters:
    
    minX - The image's minimum X coordinate in pixels at level zero.
    
    minY - The image's minimum Y coordinate in pixels at level zero.
    
    width - The width of the image in pixels at level zero.
    
    height - The height of the image in pixels at level zero.
    
    scale - The scale at the level of interest.
    
    Returns:
    
    the dimension of the image at the level of interest.

Class AbstractMultiLevelSource

Field Summary

Fields inherited from interface com.bc.ceres.glevel.MultiLevelSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractMultiLevelSource

Method Detail

getModel

getImage

getImageShape

createImage

reset

checkLevel

getImageDimension

getImageRectangle