org.esa.beam.framework.gpf.jpy

Class PyOperator

java.lang.Object

org.esa.beam.framework.gpf.Operator

org.esa.beam.framework.gpf.jpy.PyOperator

@OperatorMetadata(alias="PyOp",
                  description="Uses Python code to process data products",
                  version="0.5",
                  authors="N. Fomferra",
                  internal=true)
public class PyOperator
extends Operator

An operator which uses Python code to process data products.

Since:

BEAM 5

Author:

Norman Fomferra

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PyOperator.PythonProcessor The interface that the given Python class must implement.

Constructor Summary

Constructors

Constructor and Description
PyOperator()

Method Summary

Methods

Modifier and Type	Method and Description
void	computeTileStack(Map<Band,Tile> targetTiles, Rectangle targetRectangle, com.bc.ceres.core.ProgressMonitor pm) Called by the framework in order to compute the stack of tiles for the given target bands.
void	dispose() Releases the resources the operator has acquired during its lifetime.
String	getPythonClassName()
String	getPythonModuleName()
String	getPythonModulePath()
void	initialize() Initializes this operator and sets the one and only target product.
void	setPythonClassName(String pythonClassName)
void	setPythonModuleName(String pythonModuleName)
void	setPythonModulePath(String pythonModulePath)

Methods inherited from class org.esa.beam.framework.gpf.Operator

checkForCancellation, computeTile, deactivateComputeTileMethod, finalize, getId, getLogger, getParameter, getParameter, 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

PyOperator

public PyOperator()

Method Detail

getPythonModulePath

public String getPythonModulePath()

setPythonModulePath

public void setPythonModulePath(String pythonModulePath)

getPythonModuleName

public String getPythonModuleName()

setPythonModuleName

public void setPythonModuleName(String pythonModuleName)

getPythonClassName

public String getPythonClassName()

setPythonClassName

public void setPythonClassName(String pythonClassName)

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.beam.framework.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()

computeTileStack

public void computeTileStack(Map<Band,Tile> targetTiles,
                    Rectangle targetRectangle,
                    com.bc.ceres.core.ProgressMonitor pm)
                      throws OperatorException

Description copied from class: Operator

Called by the framework in order to compute the stack of tiles for the given target bands.

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

This method shall never be called directly.

Overrides:

computeTileStack in class Operator

Parameters:

targetTiles - The current tiles to be computed for each target band.

targetRectangle - The area in pixel coordinates to be computed (same for all rasters in targetRasters).

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

Throws:

OperatorException - if an error occurs during computation of the target rasters.

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