org.esa.beam.framework.dataio
Class ProductProjectionBuilder

java.lang.Object
  org.esa.beam.framework.dataio.AbstractProductReader
      org.esa.beam.framework.dataio.AbstractProductBuilder
          org.esa.beam.framework.dataio.ProductProjectionBuilder

All Implemented Interfaces:

ProductReader

Deprecated. since BEAM 4.7, replaced by GPF operator 'Reproject'

@Deprecated
public class ProductProjectionBuilder
extends AbstractProductBuilder

A special purpose product reader used to build map-projected data products.

Field Summary

Fields inherited from class org.esa.beam.framework.dataio.AbstractProductBuilder

bandMap, newProductDesc, newProductName, sceneRasterHeight, sceneRasterWidth, sourceProduct, sourceProductOwner

Constructor Summary

ProductProjectionBuilder(MapInfo mapInfo)
Deprecated.

ProductProjectionBuilder(MapInfo mapInfo, boolean sourceProductOwner)
Deprecated.

Method Summary

void	close() Deprecated. Closes the access to all currently opened resources such as file input streams and all resources of this children directly owned by this reader.
static Product	createProductProjection(Product sourceProduct, boolean sourceProductOwner, boolean includeTiePointGrids, MapInfo mapInfo, String name, String desc) Deprecated.
static Product	createProductProjection(Product sourceProduct, boolean sourceProductOwner, MapInfo mapInfo, String name, String desc) Deprecated.
static Product	createProductProjection(Product sourceProduct, MapInfo mapInfo, String name, String desc) Deprecated.
ElevationModel	getElevationModel() Deprecated.
boolean	getIncludeTiePointGrids() Deprecated.
MapInfo	getMapInfo() Deprecated.
void	getSourceLinePixelCoords(Band destBand, int destOffsetX, int destOffsetY, PixelPos[] sourceLineCoords) Deprecated.
void	readBandRasterData(Band destBand, int destOffsetX, int destOffsetY, int destWidth, int destHeight, ProductData destBuffer, com.bc.ceres.core.ProgressMonitor pm) Deprecated. Reads raster data from the data source specified by the given destination band into the given in-memory buffer and region.
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, com.bc.ceres.core.ProgressMonitor pm) Deprecated. The template method which is called by the method after an optional spatial subset has been applied to the input parameters.
protected Product	readProductNodesImpl() Deprecated. Reads a data product and returns a in-memory representation of it.
void	setElevationModel(ElevationModel elevationModel) Deprecated.
void	setIncludeTiePointGrids(boolean includeTiePointtGrids) Deprecated.
void	setMapInfo(MapInfo mapInfo) Deprecated.
protected void	setSubsetDef(ProductSubsetDef subsetDef) Deprecated. Sets the subset information.

Methods inherited from class org.esa.beam.framework.dataio.AbstractProductBuilder

addAttribString, addFlagCodingsToProduct, addIndexCodingsToProduct, addMetadataToProduct, cloneFlags, cloneIndexes, cloneMetadataAttributes, cloneMetadataElements, cloneMetadataElementsAndAttributes, disposeBandMap, getSceneRasterHeight, getSceneRasterWidth, getSourceProduct, isInstanceOfValidInputType, isSourceProductOwner, readProductNodes, setNewProductDesc, setNewProductName

Methods inherited from class org.esa.beam.framework.dataio.AbstractProductReader

configurePreferredTileSize, createTiePointGrid, getGridDiscontinutity, getInput, getProductComponents, getReaderPlugIn, getSubsetDef, isMetadataIgnored, isNodeAccepted, readProductNodes, setInput, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductProjectionBuilder

public ProductProjectionBuilder(MapInfo mapInfo)

Deprecated.

ProductProjectionBuilder

public ProductProjectionBuilder(MapInfo mapInfo,
                                boolean sourceProductOwner)

Deprecated.

Method Detail

createProductProjection

public static Product createProductProjection(Product sourceProduct,
                                              MapInfo mapInfo,
                                              String name,
                                              String desc)
                                       throws IOException

Deprecated.

Throws:

IOException

createProductProjection

public static Product createProductProjection(Product sourceProduct,
                                              boolean sourceProductOwner,
                                              MapInfo mapInfo,
                                              String name,
                                              String desc)
                                       throws IOException

Deprecated.

Throws:

IOException

createProductProjection

public static Product createProductProjection(Product sourceProduct,
                                              boolean sourceProductOwner,
                                              boolean includeTiePointGrids,
                                              MapInfo mapInfo,
                                              String name,
                                              String desc)
                                       throws IOException

Deprecated.

Throws:

IOException

getMapInfo

public MapInfo getMapInfo()

Deprecated.

setMapInfo

public void setMapInfo(MapInfo mapInfo)

Deprecated.

getElevationModel

public ElevationModel getElevationModel()

Deprecated.

setElevationModel

public void setElevationModel(ElevationModel elevationModel)

Deprecated.

getIncludeTiePointGrids

public boolean getIncludeTiePointGrids()

Deprecated.

setIncludeTiePointGrids

public void setIncludeTiePointGrids(boolean includeTiePointtGrids)

Deprecated.

setSubsetDef

protected void setSubsetDef(ProductSubsetDef subsetDef)

Deprecated.

Sets the subset information. This implemetation is protected to overwrite in the inherided class to ensure that the subset information cannot be set from the readProductNodes method.

Overrides:

setSubsetDef in class AbstractProductReader

Parameters:

subsetDef - the subset definition

readProductNodesImpl

protected Product readProductNodesImpl()
                                throws IOException

Deprecated.

Reads a data product and returns a in-memory representation of it. This method was called by readProductNodes(input, subsetInfo) of the abstract superclass.

Specified by:

readProductNodesImpl in class AbstractProductBuilder

Returns:

a new product instance

Throws:

IllegalArgumentException - if input type is not one of the supported input sources.

IOException - if an I/O error occurs

close

public void close()
           throws IOException

Deprecated.

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 AbstractProductBuilder

Throws:

IOException - if an I/O error occurs

readBandRasterData

public void readBandRasterData(Band destBand,
                               int destOffsetX,
                               int destOffsetY,
                               int destWidth,
                               int destHeight,
                               ProductData destBuffer,
                               com.bc.ceres.core.ProgressMonitor pm)
                        throws IOException

Deprecated.

Reads raster data from the data source specified by the given destination band into the given in-memory buffer and region.

For a complete description, please refer to the ProductReader.readBandRasterData(org.esa.beam.framework.datamodel.Band, int, int, int, int, org.esa.beam.framework.datamodel.ProductData, com.bc.ceres.core.ProgressMonitor) interface definition} of this method.

The AbstractProductReader implements this method using the Template Method pattern. The template method in this case is the abstract method to which the call is delegated after an optional spatial subset given by AbstractProductReader.getSubsetDef() has been applied to the input parameters.

Specified by:

readBandRasterData in interface ProductReader

Overrides:

readBandRasterData in class AbstractProductReader

Parameters:

destBand - the destination band which identifies the data source from which to readBandRasterDataImpl 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 readBandRasterDataImpl given in the band's raster co-ordinates

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

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

pm - a monitor to inform the user about progress

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if the number of elements destination buffer not equals destWidth * destHeight or the destination region is out of the band's raster

See Also:

readBandRasterDataImpl(org.esa.beam.framework.datamodel.Band, int, int, int, int, org.esa.beam.framework.datamodel.ProductData, com.bc.ceres.core.ProgressMonitor), AbstractProductReader.getSubsetDef(), ProductReader.readBandRasterData(org.esa.beam.framework.datamodel.Band, int, int, int, int, org.esa.beam.framework.datamodel.ProductData, com.bc.ceres.core.ProgressMonitor), RasterDataNode.getRasterWidth(), RasterDataNode.getRasterHeight()

getSourceLinePixelCoords

public void getSourceLinePixelCoords(Band destBand,
                                     int destOffsetX,
                                     int destOffsetY,
                                     PixelPos[] sourceLineCoords)

Deprecated.

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,
                                      com.bc.ceres.core.ProgressMonitor pm)
                               throws IOException

Deprecated.

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 acount 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.beam.framework.datamodel.Band, int, int, int, int, org.esa.beam.framework.datamodel.ProductData, com.bc.ceres.core.ProgressMonitor), AbstractProductReader.getSubsetDef()