org.esa.beam.framework.gpf.pointop
Interface SampleConfigurer

public interface SampleConfigurer

A SampleConfigurer is used to define the samples processed by a PointOperator. These can be both, source or target samples. The definition of a sample is given by its index within the pixel (a pixel comprises one or more samples) and the name of a RasterDataNode.

This interface is not intended to be implemented by clients.

Since:

BEAM 4.9

Author:

Norman Fomferra

Method Summary

void	defineSample(int index, String name) Defines a sample for a RasterDataNode.
void	defineSample(int index, String name, Product product) Defines a sample for a RasterDataNode in the given product.

Method Detail

defineSample

void defineSample(int index,
                  String name)

Defines a sample for a RasterDataNode.

Parameters:

index - The index of the sample within the sample arrays passed to computeSample() or computePixel() methods.

name - The name of a RasterDataNode to which the sample belongs.

defineSample

void defineSample(int index,
                  String name,
                  Product product)

Defines a sample for a RasterDataNode in the given product.

Parameters:

index - The index of the sample within the sample arrays passed to computeSample() or computePixel() methods.

name - The name of a RasterDataNode to which the sample belongs.

product - The product in which to find the raster data node's name.