Package org.apache.sis.image

Class BandSelectImage

java.lang.Object

org.apache.sis.image.PlanarImage

org.apache.sis.image.ComputedImage

org.apache.sis.image.SourceAlignedImage

org.apache.sis.image.BandSelectImage

All Implemented Interfaces:

RenderedImage, Disposable

final class BandSelectImage
extends SourceAlignedImage

Selects or reorder bands from a source image. This operation avoid copying sample values; it works by modifying the sample model and color model.

Since:

1.1

Version:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private final int[]	bands	The selected bands.
private static final Set<String>	INHERITED_PROPERTIES	Properties to inherit from the source image, after bands reduction if applicable.

Fields inherited from class org.apache.sis.image.SourceAlignedImage

POSITIONAL_PROPERTIES

Fields inherited from class org.apache.sis.image.ComputedImage

sampleModel, SOURCE_PADDING_KEY

Fields inherited from class org.apache.sis.image.PlanarImage

GRID_GEOMETRY_KEY, MASK_KEY, POSITIONAL_ACCURACY_KEY, SAMPLE_RESOLUTIONS_KEY, STATISTICS_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BandSelectImage(RenderedImage source, ColorModel cm, int[] bands)	Creates a new "band select" operation for the given source.

Method Summary

Modifier and Type	Method	Description
protected Raster	computeTile(int tileX, int tileY, WritableRaster previous)	Creates a raster sharing the same data buffer than the source image but showing only a subset of the bands.
(package private) static RenderedImage	create(RenderedImage source, int[] bands)	Creates a new "band select" operation for the given source.
boolean	equals(Object object)	Compares the given object with this image for equality.
private static Object	getProperty(RenderedImage source, String key, int[] bands)	Gets a property from the given image, reducing the number of dimensions if needed.
Object	getProperty(String key)	Gets a property from this image.
String[]	getPropertyNames()	Returns the names of all recognized properties, or null if this image has no properties.
int	hashCode()	Returns a hash code value for this image.

Methods inherited from class org.apache.sis.image.SourceAlignedImage

filterPropertyNames, getColorModel, getHeight, getMinTileX, getMinTileY, getMinX, getMinY, getNumXTiles, getNumYTiles, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getWidth, prefetch

Methods inherited from class org.apache.sis.image.ComputedImage

clearErrorFlags, createTile, dispose, equalsBase, getDestination, getSampleModel, getSource, getSource, getSources, getTile, getWritableTileIndices, hashCodeBase, hasTileWriters, isTileWritable, markDirtyTiles, markTileWritable, reference, setDestination, sourceTileChanged

Methods inherited from class org.apache.sis.image.PlanarImage

copyData, getBounds, getData, getData, toString, verify

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INHERITED_PROPERTIES

private static final Set<String> INHERITED_PROPERTIES

Properties to inherit from the source image, after bands reduction if applicable.

See Also:

• getProperty(String)

bands

private final int[] bands

The selected bands.

Constructor Details

BandSelectImage

private BandSelectImage(RenderedImage source,
 ColorModel cm,
 int[] bands)

Creates a new "band select" operation for the given source. It is caller responsibility to verify the validity of given bands indices.

Parameters:

source - the image in which to select bands.

cm - the color model to associate to this image.

bands - the bands to select. Should be a clone of user-specified argument (this constructor retains the given array reference as-is, without cloning).

Method Details

create

static RenderedImage create(RenderedImage source,
 int[] bands)

Creates a new "band select" operation for the given source.

Parameters:

source - the image in which to select bands.

bands - the bands to select.

getPropertyNames

public String[] getPropertyNames()

Returns the names of all recognized properties, or null if this image has no properties.

Specified by:

getPropertyNames in interface RenderedImage

Overrides:

getPropertyNames in class PlanarImage

Returns:

names of all recognized properties, or null if none.

getProperty

public Object getProperty(String key)

Gets a property from this image.

Specified by:

getProperty in interface RenderedImage

Overrides:

getProperty in class PlanarImage

Parameters:

key - the name of the property to get.

Returns:

the property value, or Image.UndefinedProperty if none.

getProperty

private static Object getProperty(RenderedImage source,
 String key,
 int[] bands)

Gets a property from the given image, reducing the number of dimensions if needed. It is caller responsibility to verify that the given key is one of the keys enumerated in INHERITED_PROPERTIES.

computeTile

protected Raster computeTile(int tileX,
 int tileY,
 WritableRaster previous)

Creates a raster sharing the same data buffer than the source image but showing only a subset of the bands.

Specified by:

computeTile in class ComputedImage

Parameters:

tileX - the column index of the tile to compute.

tileY - the row index of the tile to compute.

previous - ignored.

Returns:

computed tile for the given indices. May be the previous tile after update but cannot be null.

hashCode

public int hashCode()

Returns a hash code value for this image.

Overrides:

hashCode in class SourceAlignedImage

equals

public boolean equals(Object object)

Compares the given object with this image for equality.

Overrides:

equals in class SourceAlignedImage