Package org.esa.snap.core.datamodel

Class AbstractBand

java.lang.Object

com.bc.ceres.core.ExtensibleObject

org.esa.snap.core.datamodel.ProductNode

org.esa.snap.core.datamodel.DataNode

org.esa.snap.core.datamodel.RasterDataNode

org.esa.snap.core.datamodel.AbstractBand

All Implemented Interfaces:

Extensible, Scaling, SceneTransformProvider

Direct Known Subclasses:

Band

public abstract class AbstractBand
extends RasterDataNode

The AbstractBand class provides a set of pixel access methods but does not provide an implementation of the actual reading and writing of pixel data from or into a raster.

Nested Class Summary

Nested classes/interfaces inherited from class org.esa.snap.core.datamodel.RasterDataNode

RasterDataNode.RasterDataProcessor

Field Summary

Fields inherited from class org.esa.snap.core.datamodel.RasterDataNode

INVALID_POS_TEXT, IO_ERROR_TEXT, NO_DATA_TEXT, PROPERTY_NAME_ANCILLARY_RELATIONS, PROPERTY_NAME_ANCILLARY_VARIABLES, PROPERTY_NAME_GEO_CODING, PROPERTY_NAME_IMAGE_INFO, PROPERTY_NAME_IMAGE_TO_MODEL_TRANSFORM, PROPERTY_NAME_LOG_10_SCALED, PROPERTY_NAME_MODEL_TO_SCENE_TRANSFORM, PROPERTY_NAME_NO_DATA_VALUE, PROPERTY_NAME_NO_DATA_VALUE_USED, PROPERTY_NAME_SCALING_FACTOR, PROPERTY_NAME_SCALING_OFFSET, PROPERTY_NAME_SCENE_TO_MODEL_TRANSFORM, PROPERTY_NAME_STX, PROPERTY_NAME_TIME_CODING, PROPERTY_NAME_VALID_PIXEL_EXPRESSION

Fields inherited from class org.esa.snap.core.datamodel.DataNode

PROPERTY_NAME_DATA, PROPERTY_NAME_READ_ONLY, PROPERTY_NAME_SYNTHETIC, PROPERTY_NAME_UNIT

Fields inherited from class org.esa.snap.core.datamodel.ProductNode

PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_NAME

Fields inherited from interface org.esa.snap.core.datamodel.Scaling

IDENTITY

Constructor Summary

Constructors

Constructor	Description
AbstractBand(String name, int dataType, int rasterWidth, int rasterHeight)

Method Summary

Modifier and Type	Method	Description
protected static double[]	ensureMinLengthArray(double[] array, int length)
protected static float[]	ensureMinLengthArray(float[] array, int length)
protected static int[]	ensureMinLengthArray(int[] array, int length)
void	ensureRasterData()	Ensures that raster data exists
double	getPixelDouble(int x, int y)	Gets the sample for the pixel located at (x,y) as a double value.
float	getPixelFloat(int x, int y)	Gets the sample for the pixel located at (x,y) as a float value.
int	getPixelInt(int x, int y)	Gets the sample for the pixel located at (x,y) as an integer value.
double[]	getPixels(int x, int y, int w, int h, double[] pixels, ProgressMonitor pm)	Retrieves the range of pixels specified by the coordinates as double array.
float[]	getPixels(int x, int y, int w, int h, float[] pixels, ProgressMonitor pm)	Retrieves the range of pixels specified by the coordinates as float array.
int[]	getPixels(int x, int y, int w, int h, int[] pixels, ProgressMonitor pm)	Retrieves the range of pixels specified by the coordinates as integer array.
int	getRasterHeight()
int	getRasterWidth()
abstract long	getRawStorageSize(ProductSubsetDef subsetDef)	Gets an estimated raw storage size in bytes of this product node.
void	loadRasterData(ProgressMonitor pm)	Loads the complete underlying raster data.
double[]	readPixels(int x, int y, int w, int h, double[] pixels, ProgressMonitor pm)	Retrieves the band data at the given offset (x, y), width and height as double data.
float[]	readPixels(int x, int y, int w, int h, float[] pixels, ProgressMonitor pm)	Retrieves the band data at the given offset (x, y), width and height as float data.
int[]	readPixels(int x, int y, int w, int h, int[] pixels, ProgressMonitor pm)	Retrieves the band data at the given offset (x, y), width and height as integer data.
void	setPixelDouble(int x, int y, double pixelValue)	Sets the pixel value at the given pixel coordinate to the given pixel value.
void	setPixelFloat(int x, int y, float pixelValue)	Sets the pixel at the given pixel coordinate to the given pixel value.
void	setPixelInt(int x, int y, int pixelValue)	Sets the pixel at the given pixel co-ordinate to the given pixel value.
void	setPixels(int x, int y, int w, int h, double[] pixels)	Sets a range of pixels specified by the coordinates as double array.
void	setPixels(int x, int y, int w, int h, float[] pixels)	Sets a range of pixels specified by the coordinates as float array.
void	setPixels(int x, int y, int w, int h, int[] pixels)	Sets a range of pixels specified by the coordinates as integer array.
void	unloadRasterData()	Un-loads the raster data for this band.
void	writePixels(int x, int y, int w, int h, double[] pixels, ProgressMonitor pm)	Retrieves the range of pixels specified by the coordinates as double array.
void	writePixels(int x, int y, int w, int h, float[] pixels, ProgressMonitor pm)	Retrieves the range of pixels specified by the coordinates as float array.
void	writePixels(int x, int y, int w, int h, int[] pixels, ProgressMonitor pm)	Retrieves the range of pixels specified by the coordinates as integer array.

Methods inherited from class org.esa.snap.core.datamodel.RasterDataNode

acceptVisitor, addAncillaryVariable, canBeOrthorectified, checkCompatibleRasterData, clearNoDataValue, computeStxImpl, createColorIndexedImage, createCompatibleRasterData, createCompatibleRasterData, createCompatibleSceneRasterData, createDefaultImageInfo, createDefaultImageInfo, createMultiLevelModel, createPointing, createRgbImage, createSourceImage, createTransectProfileData, dispose, fireImageInfoChanged, getAncillaryRelations, getAncillaryVariable, getAncillaryVariables, getGeoCoding, getGeophysicalDataType, getGeophysicalImage, getGeophysicalNoDataValue, getImageInfo, getImageInfo, getImageInfo, getImageToModelTransform, getModelToSceneTransform, getMultiLevelModel, getNoDataValue, getOverlayMaskGroup, getPixels, getPixels, getPixelString, getPointing, getRasterData, getRasterSize, getSampleFloat, getSampleInt, getScalingFactor, getScalingOffset, getSceneToModelTransform, getSourceImage, getStx, getStx, getTimeCoding, getValidMaskExpression, getValidMaskImage, getValidPixelExpression, getValidShape, hasIntPixels, hasRasterData, isCompatibleRasterData, isFloatingPointType, isGeophysicalImageSet, isLog10Scaled, isNoDataValueSet, isNoDataValueUsed, isPixelValid, isPixelValid, isPixelValid, isPixelWithinImageBounds, isScalingApplied, isSourceImageSet, isStxSet, isValidMaskImageSet, isValidMaskProperty, isValidMaskUsed, loadRasterData, processRasterData, quantizeRasterData, quantizeRasterData, readPixels, readPixels, readPixels, readRasterData, readRasterData, readRasterDataFully, readRasterDataFully, readValidMask, removeAncillaryVariable, removeCachedImageData, resetValidMask, scale, scaleInverse, setAncillaryRelations, setGeoCoding, setGeophysicalNoDataValue, setImageInfo, setImageInfo, setImageToModelTransform, setLog10Scaled, setModelToSceneTransform, setModified, setNoDataValue, setNoDataValueUsed, setRasterData, setScalingFactor, setScalingOffset, setSceneToModelTransform, setSourceImage, setSourceImage, setStx, setTimeCoding, setValidPixelExpression, updateExpression, writePixels, writePixels, writePixels, writeRasterData, writeRasterData, writeRasterDataFully, writeRasterDataFully

Methods inherited from class org.esa.snap.core.datamodel.DataNode

checkDataCompatibility, createCompatibleProductData, fireProductNodeDataChanged, getData, getDataElems, getDataElemSize, getDataType, getNumDataElems, getUnit, isReadOnly, isSynthetic, setData, setDataElems, setReadOnly, setSynthetic, setUnit

Methods inherited from class org.esa.snap.core.datamodel.ProductNode

fireProductNodeChanged, fireProductNodeChanged, getDescription, getDisplayName, getName, getOwner, getProduct, getProductReader, getProductReaderSafe, getProductRefString, getProductSafe, getProductWriter, getProductWriterSafe, getRawStorageSize, isModified, isPartOfSubset, isValidNodeName, removeFromFile, setDescription, setName, setNodeName, setOwner, toString

Methods inherited from class com.bc.ceres.core.ExtensibleObject

getExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractBand

public AbstractBand(String name,
                    int dataType,
                    int rasterWidth,
                    int rasterHeight)

Method Detail

getRasterWidth

public int getRasterWidth()

Specified by:

getRasterWidth in class RasterDataNode

Returns:

The width of the raster in pixels.

getRasterHeight

public int getRasterHeight()

Specified by:

getRasterHeight in class RasterDataNode

Returns:

The height of the raster in pixels.

writePixels

public void writePixels(int x,
                        int y,
                        int w,
                        int h,
                        int[] pixels,
                        ProgressMonitor pm)
                 throws IOException

Retrieves the range of pixels specified by the coordinates as integer array. Reads the data from disk if ot is not in memory yet. If the data is loaded, just copies the data.

Specified by:

writePixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be read

h - height of the pixel array to be read.

pixels - integer array to be filled with data

pm - a monitor to inform the user about progress

Throws:

IOException - if an I/O error occurs

writePixels

public void writePixels(int x,
                        int y,
                        int w,
                        int h,
                        float[] pixels,
                        ProgressMonitor pm)
                 throws IOException

Retrieves the range of pixels specified by the coordinates as float array. Reads the data from disk if ot is not in memory yet. If the data is loaded, just copies the data.

Specified by:

writePixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be read

h - height of the pixel array to be read.

pixels - float array to be filled with data

pm - a monitor to inform the user about progress

Throws:

IOException - if an I/O error occurs

writePixels

public void writePixels(int x,
                        int y,
                        int w,
                        int h,
                        double[] pixels,
                        ProgressMonitor pm)
                 throws IOException

Retrieves the range of pixels specified by the coordinates as double array. Reads the data from disk if ot is not in memory yet. If the data is loaded, just copies the data.

Specified by:

writePixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be read

h - height of the pixel array to be read.

pixels - double array to be filled with data

pm - a monitor to inform the user about progress

Throws:

IOException - if an I/O error occurs

getRawStorageSize

public abstract long getRawStorageSize(ProductSubsetDef subsetDef)

Gets an estimated raw storage size in bytes of this product node.

Overrides:

getRawStorageSize in class DataNode

Parameters:

subsetDef - if not null the subset may limit the size returned

Returns:

the size in bytes.

ensureMinLengthArray

protected static int[] ensureMinLengthArray(int[] array,
                                            int length)

ensureMinLengthArray

protected static float[] ensureMinLengthArray(float[] array,
                                              int length)

ensureMinLengthArray

protected static double[] ensureMinLengthArray(double[] array,
                                               int length)

getPixelInt

public int getPixelInt(int x,
                       int y)

Gets the sample for the pixel located at (x,y) as an integer value.

Specified by:

getPixelInt in class RasterDataNode

Parameters:

x - The X co-ordinate of the pixel location

y - The Y co-ordinate of the pixel location

Returns:

the pixel value at (x,y)

Throws:

NullPointerException - if this band has no raster data

ArrayIndexOutOfBoundsException - if the co-ordinates are not in bounds

getPixelFloat

public float getPixelFloat(int x,
                           int y)

Gets the sample for the pixel located at (x,y) as a float value.

Specified by:

getPixelFloat in class RasterDataNode

Parameters:

x - The X co-ordinate of the pixel location

y - The Y co-ordinate of the pixel location

Returns:

the pixel value at (x,y)

Throws:

NullPointerException - if this band has no raster data

ArrayIndexOutOfBoundsException - if the co-ordinates are not in bounds

getPixelDouble

public double getPixelDouble(int x,
                             int y)

Gets the sample for the pixel located at (x,y) as a double value.

Specified by:

getPixelDouble in class RasterDataNode

Parameters:

x - The X co-ordinate of the pixel location

y - The Y co-ordinate of the pixel location

Returns:

the pixel value at (x,y)

Throws:

NullPointerException - if this band has no raster data

ArrayIndexOutOfBoundsException - if the co-ordinates are not in bounds

setPixelInt

public void setPixelInt(int x,
                        int y,
                        int pixelValue)

Sets the pixel at the given pixel co-ordinate to the given pixel value.

Specified by:

setPixelInt in class RasterDataNode

Parameters:

x - The X co-ordinate of the pixel location

y - The Y co-ordinate of the pixel location

pixelValue - the new pixel value

Throws:

NullPointerException - if this band has no raster data

setPixelFloat

public void setPixelFloat(int x,
                          int y,
                          float pixelValue)

Sets the pixel at the given pixel coordinate to the given pixel value.

Specified by:

setPixelFloat in class RasterDataNode

Parameters:

x - The X co-ordinate of the pixel location

y - The Y co-ordinate of the pixel location

pixelValue - the new pixel value

Throws:

NullPointerException - if this band has no raster data

setPixelDouble

public void setPixelDouble(int x,
                           int y,
                           double pixelValue)

Sets the pixel value at the given pixel coordinate to the given pixel value.

Specified by:

setPixelDouble in class RasterDataNode

Parameters:

x - The X co-ordinate of the pixel location

y - The Y co-ordinate of the pixel location

pixelValue - the new pixel value

Throws:

NullPointerException - if this band has no raster data

readPixels

public int[] readPixels(int x,
                        int y,
                        int w,
                        int h,
                        int[] pixels,
                        ProgressMonitor pm)
                 throws IOException

Retrieves the band data at the given offset (x, y), width and height as integer data. If the data is already in memory, it merely copies the data to the buffer provided. If not, it calls the attached product reader to retrieve the data from the disk file. If the given buffer is null a new one was created and returned.

Specified by:

readPixels in class RasterDataNode

Parameters:

x - x offest of upper left corner

y - y offset of upper left corner

w - width of the desired data array

h - height of the desired data array

pixels - array of integer pixels to be filled with data

pm - a monitor to inform the user about progress

Returns:

the pixels read

Throws:

IllegalArgumentException - if the length of the given array is less than w*h.

IOException - if an /IO error occurs

readPixels

public float[] readPixels(int x,
                          int y,
                          int w,
                          int h,
                          float[] pixels,
                          ProgressMonitor pm)
                   throws IOException

Retrieves the band data at the given offset (x, y), width and height as float data. If the data is already in memory, it merely copies the data to the buffer provided. If not, it calls the attached product reader to retrieve the data from the disk file. If the given buffer is null a new one was created and returned.

Specified by:

readPixels in class RasterDataNode

Parameters:

x - x offest of upper left corner

y - y offset of upper left corner

w - width of the desired data array

h - height of the desired data array

pixels - array of float pixels to be filled with data.

pm - a monitor to inform the user about progress

Returns:

the pixels read

Throws:

IllegalArgumentException - if the length of the given array is less than w*h.

IOException

readPixels

public double[] readPixels(int x,
                           int y,
                           int w,
                           int h,
                           double[] pixels,
                           ProgressMonitor pm)
                    throws IOException

Retrieves the band data at the given offset (x, y), width and height as double data. If the data is already in memory, it merely copies the data to the buffer provided. If not, it calls the attached product reader to retrieve the data from the disk file. If the given buffer is null a new one was created and returned.

Specified by:

readPixels in class RasterDataNode

Parameters:

x - x offest of upper left corner

y - y offset of upper left corner

w - width of the desired data array

h - height of the desired data array

pixels - array of double pixels to be filled with data

pm - a monitor to inform the user about progress

Returns:

the pixels read

Throws:

IllegalArgumentException - if the length of the given array is less than w*h.

IOException

getPixels

public int[] getPixels(int x,
                       int y,
                       int w,
                       int h,
                       int[] pixels,
                       ProgressMonitor pm)

Retrieves the range of pixels specified by the coordinates as integer array. Throws exception when the data is not read from disk yet. If the given array is null a new one was created and returned.

Specified by:

getPixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be read

h - height of the pixel array to be read.

pixels - integer array to be filled with data

pm - a monitor to inform the user about progress

Throws:

NullPointerException - if this band has no raster data

IllegalArgumentException - if the length of the given array is less than w*h.

getPixels

public float[] getPixels(int x,
                         int y,
                         int w,
                         int h,
                         float[] pixels,
                         ProgressMonitor pm)

Retrieves the range of pixels specified by the coordinates as float array. Throws exception when the data is not read from disk yet. If the given array is null a new one was created and returned.

Specified by:

getPixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be read

h - height of the pixel array to be read.

pixels - float array to be filled with data

pm - a monitor to inform the user about progress

Throws:

NullPointerException - if this band has no raster data

IllegalArgumentException - if the length of the given array is less than w*h.

getPixels

public double[] getPixels(int x,
                          int y,
                          int w,
                          int h,
                          double[] pixels,
                          ProgressMonitor pm)

Retrieves the range of pixels specified by the coordinates as double array. Throws exception when the data is not read from disk yet. If the given array is null a new one was created and returned.

Specified by:

getPixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be read

h - height of the pixel array to be read.

pixels - double array to be filled with data

pm - a monitor to inform the user about progress

Throws:

NullPointerException - if this band has no raster data

IllegalArgumentException - if the length of the given array is less than w*h.

setPixels

public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      int[] pixels)

Sets a range of pixels specified by the coordinates as integer array. Copies the data to the memory buffer of data at the specified location. Throws exception when the target buffer is not in memory.

Specified by:

setPixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be written

h - height of the pixel array to be written.

pixels - integer array to be written

Throws:

NullPointerException - if this band has no raster data

setPixels

public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      float[] pixels)

Sets a range of pixels specified by the coordinates as float array. Copies the data to the memory buffer of data at the specified location. Throws exception when the target buffer is not in memory.

Specified by:

setPixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be written

h - height of the pixel array to be written.

pixels - float array to be written

setPixels

public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      double[] pixels)

Sets a range of pixels specified by the coordinates as double array. Copies the data to the memory buffer of data at the specified location. Throws exception when the target buffer is not in memory.

Specified by:

setPixels in class RasterDataNode

Parameters:

x - x offset into the band

y - y offset into the band

w - width of the pixel array to be written

h - height of the pixel array to be written.

pixels - double array to be written

ensureRasterData

public void ensureRasterData()

Ensures that raster data exists

loadRasterData

public void loadRasterData(ProgressMonitor pm)
                    throws IOException

Loads the complete underlying raster data.

After this method has been called successfully, hasRasterData() should always return true and getRasterData() should always return a valid ProductData instance with at least getRasterWidth()*getRasterHeight() elements (samples).

In opposite to the readRasterDataFully method, loadRasterData will only read data if this has not already been done.

Overrides:

loadRasterData in class RasterDataNode

Parameters:

pm - a monitor to inform the user about progress

Throws:

IOException - if an I/O error occurs

See Also:

RasterDataNode.readRasterDataFully(ProgressMonitor)

unloadRasterData

public void unloadRasterData()

Un-loads the raster data for this band.

After this method has been called successfully, the hasRasterData() method returns false and getRasterData() returns null.

Overrides:

unloadRasterData in class RasterDataNode

See Also:

RasterDataNode.loadRasterData()