Package org.esa.snap.core.gpf.common

Class WriteRGBOp

java.lang.Object

org.esa.snap.core.gpf.Operator

org.esa.snap.core.gpf.common.WriteRGBOp

@OperatorMetadata(alias="WriteRGB",
                  category="Input-Output",
                  description="Creates an RGB image from three source bands.",
                  internal=true)
public class WriteRGBOp
extends Operator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WriteRGBOp.Spi

Constructor Summary

Constructors

Constructor	Description
WriteRGBOp()

Method Summary

Modifier and Type	Method	Description
void	computeTile(Band band, Tile targetTile, ProgressMonitor pm)	Called by the framework in order to compute a tile for the given target band.
void	dispose()	Releases the resources the operator has acquired during its lifetime.
void	doExecute(ProgressMonitor pm)	Executes the operator.
void	initialize()	Initializes this operator and sets the one and only target product.

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

canComputeTile, canComputeTileStack, checkForCancellation, computeTileStack, 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

WriteRGBOp

public WriteRGBOp()

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()

doExecute

public void doExecute(ProgressMonitor pm)
               throws OperatorException

Description copied from class: Operator

Executes the operator.

For operators that compute raster data tiles, the method is usually a no-op. Other operators might perform their main work in this method, e.g. perform some image analysis such as extracting statistics and other features from data products.

Don't call this method directly. The framework may call this method

1. once before the very first tile is computed, or
2. as a result of a call to Operator.execute(ProgressMonitor).

The default implementation only progresses the progress monitor.

Overrides:

doExecute in class Operator

Parameters:

pm - A progress monitor to be notified for long-running tasks.

Throws:

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

computeTile

public void computeTile(Band band,
                        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:

band - 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.

dispose

public void dispose()

Description copied from class: Operator

Releases the resources the operator has acquired during its lifetime. The default implementation does nothing.

Overrides should make sure to call super.dispose() as well.

Overrides:

dispose in class Operator