org.esa.snap.core.gpf.common

Class JaiOp

java.lang.Object

org.esa.snap.core.gpf.Operator

org.esa.snap.core.gpf.common.JaiOp

@OperatorMetadata(alias="JAI",
                  description="Performs a JAI (Java Advanced Imaging) operation on bands of a data product.",
                  internal=true)
public class JaiOp
extends Operator

Constructor Summary

Constructors

Constructor and Description
JaiOp()
JaiOp(Product sourceProduct, String operationName, HashMap<String,Object> operationParameters, RenderingHints renderingHints)

Method Summary

Modifier and Type	Method and Description
void	computeTile(Band targetBand, Tile targetTile, ProgressMonitor pm) Called by the framework in order to compute a tile for the given target band.
String	getOperationName()
HashMap<String,Object>	getOperationParameters()
void	initialize() Initializes this operator and sets the one and only target product.
void	setOperationName(String operationName)
void	setOperationParameters(HashMap<String,Object> operationParameters)

Methods inherited from class org.esa.snap.core.gpf.Operator

canComputeTile, canComputeTileStack, checkForCancellation, computeTileStack, deactivateComputeTileMethod, dispose, doExecute, ensureSceneGeoCoding, ensureSingleRasterSize, ensureSingleRasterSize, execute, finalize, getId, getLogger, getParameter, getParameter, getProductManager, getSourceProduct, getSourceProduct, getSourceProductId, getSourceProducts, getSourceTile, getSourceTile, getSpi, getTargetProduct, getTargetProperty, setLogger, setParameter, setParameterDefaultValues, setRequiresAllBands, setSourceProduct, setSourceProduct, setSourceProducts, setSpi, setTargetProduct, stopTileComputationObservation, update

Methods inherited from class java.lang.Object

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

Constructor Detail

JaiOp

public JaiOp()

JaiOp

public JaiOp(Product sourceProduct,
             String operationName,
             HashMap<String,Object> operationParameters,
             RenderingHints renderingHints)

Method Detail

initialize

public void initialize()
                throws OperatorException

Description copied from class: Operator

Initializes this operator and sets the one and only target product.

The target product can be either defined by a field of type Product annotated with the TargetProduct annotation or by calling Operator.setTargetProduct(org.esa.snap.core.datamodel.Product) method.

This method shall never be called directly. The framework calls this method after it has created an instance of this Operator. This will occur only once durting the lifetime of an Operator instance. If not already done, calling the Operator.getTargetProduct() will always trigger a call to the initialize() method. Any client code that must be performed before computation of tile data should be placed here.

Specified by:

initialize in class Operator

Throws:

OperatorException - If an error occurs during operator initialisation.

See Also:

Operator.getTargetProduct()

getOperationName

public String getOperationName()

setOperationName

public void setOperationName(String operationName)

getOperationParameters

public HashMap<String,Object> getOperationParameters()

setOperationParameters

public void setOperationParameters(HashMap<String,Object> operationParameters)

computeTile

public void computeTile(Band targetBand,
                        Tile targetTile,
                        ProgressMonitor pm)
                 throws OperatorException

Description copied from class: Operator

Called by the framework in order to compute a tile for the given target band.

The default implementation throws a runtime exception with the message "not implemented".

This method shall never be called directly.

Overrides:

computeTile in class Operator

Parameters:

targetBand - The target band.

targetTile - The current tile associated with the target band to be computed.

pm - A progress monitor which should be used to determine computation cancellation requests.

Throws:

OperatorException - If an error occurs during computation of the target raster.