Package org.esa.snap.core.dataio.rgb

Class ImageProductReader

java.lang.Object

org.esa.snap.core.dataio.AbstractProductReader

org.esa.snap.core.dataio.rgb.ImageProductReader

All Implemented Interfaces:

ProductReader

public class ImageProductReader
extends AbstractProductReader

Field Summary

Fields

Modifier and Type	Field	Description
static String	GRAY_BAND_NAME
static float[]	RGB_WAVELENGTHS
static String[]	RGBA_BAND_NAMES

Constructor Summary

Constructors

Constructor	Description
ImageProductReader(ImageProductReaderPlugIn readerPlugIn)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the access to all currently opened resources such as file input streams and all resources of this children directly owned by this reader.
protected void	readBandRasterDataImpl(int sourceOffsetX, int sourceOffsetY, int sourceWidth, int sourceHeight, int sourceStepX, int sourceStepY, Band destBand, int destOffsetX, int destOffsetY, int destWidth, int destHeight, ProductData destBuffer, ProgressMonitor pm)	The template method which is called by the method after an optional spatial subset has been applied to the input parameters.
protected Product	readProductNodesImpl()	Provides an implementation of the readProductNodes interface method.

Methods inherited from class org.esa.snap.core.dataio.AbstractProductReader

buildTiePointGrid, buildTiePointGrid, configurePreferredTileSize, convertInputToPath, createTiePointGrid, getGridDiscontinutity, getInput, getProductComponents, getReaderPlugIn, getSubsetDef, isInstanceOfValidInputType, isMetadataIgnored, isNodeAccepted, isSubsetReadingFullySupported, readBandRasterData, readProductNodes, setInput, setSubsetDef, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.esa.snap.core.dataio.ProductReader

readTiePointGridRasterData

Field Detail

RGB_WAVELENGTHS

public static final float[] RGB_WAVELENGTHS

RGBA_BAND_NAMES

public static final String[] RGBA_BAND_NAMES

GRAY_BAND_NAME

public static final String GRAY_BAND_NAME

See Also:

Constant Field Values

Constructor Detail

ImageProductReader

public ImageProductReader(ImageProductReaderPlugIn readerPlugIn)

Method Detail

readProductNodesImpl

protected Product readProductNodesImpl()
                                throws IOException

Description copied from class: AbstractProductReader

Provides an implementation of the readProductNodes interface method. Clients implementing this method can be sure that the input object and eventually the subset information has already been set.

This method is called as a last step in the readProductNodes(input, subsetInfo) method.

Specified by:

readProductNodesImpl in class AbstractProductReader

Returns:

a new product instance

Throws:

IOException - if an I/O error occurs

readBandRasterDataImpl

protected void readBandRasterDataImpl(int sourceOffsetX,
                                      int sourceOffsetY,
                                      int sourceWidth,
                                      int sourceHeight,
                                      int sourceStepX,
                                      int sourceStepY,
                                      Band destBand,
                                      int destOffsetX,
                                      int destOffsetY,
                                      int destWidth,
                                      int destHeight,
                                      ProductData destBuffer,
                                      ProgressMonitor pm)
                               throws IOException

Description copied from class: AbstractProductReader

The template method which is called by the method after an optional spatial subset has been applied to the input parameters.

The destination band, buffer and region parameters are exactly the ones passed to the original call. Since the destOffsetX and destOffsetY parameters are already taken into account in the sourceOffsetX and sourceOffsetY parameters, an implementor of this method is free to ignore them.

Specified by:

readBandRasterDataImpl in class AbstractProductReader

Parameters:

sourceOffsetX - the absolute X-offset in source raster co-ordinates

sourceOffsetY - the absolute Y-offset in source raster co-ordinates

sourceWidth - the width of region providing samples to be read given in source raster co-ordinates

sourceHeight - the height of region providing samples to be read given in source raster co-ordinates

sourceStepX - the sub-sampling in X direction within the region providing samples to be read

sourceStepY - the sub-sampling in Y direction within the region providing samples to be read

destBand - the destination band which identifies the data source from which to read the sample values

destOffsetX - the X-offset in the band's raster co-ordinates

destOffsetY - the Y-offset in the band's raster co-ordinates

destWidth - the width of region to be read given in the band's raster co-ordinates

destHeight - the height of region to be read given in the band's raster co-ordinates

destBuffer - the destination buffer which receives the sample values to be read

pm - a monitor to inform the user about progress

Throws:

IOException - if an I/O error occurs

See Also:

AbstractProductReader.readBandRasterData(org.esa.snap.core.datamodel.Band, int, int, int, int, org.esa.snap.core.datamodel.ProductData, com.bc.ceres.core.ProgressMonitor), AbstractProductReader.getSubsetDef()

close

public void close()
           throws IOException

Description copied from class: AbstractProductReader

Closes the access to all currently opened resources such as file input streams and all resources of this children directly owned by this reader. Its primary use is to allow the garbage collector to perform a vanilla job.

This method should be called only if it is for sure that this object instance will never be used again. The results of referencing an instance of this class after a call to close() are undefined.

Overrides of this method should always call super.close(); after disposing this instance.

Specified by:

close in interface ProductReader

Overrides:

close in class AbstractProductReader

Throws:

IOException - if an I/O error occurs