public interface SourceSampleConfigurer
SourceSampleConfigurer
is used to define the source samples processed by a PointOperator
.
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
in one of the source products.
Sample can also be computed on the fly, either by band maths expressions or by filters. See the various
#defineComputedSample(...)
methods.
This interface is not intended to be implemented by clients.
Modifier and Type | Method and Description |
---|---|
void |
defineComputedSample(int index,
int sourceIndex,
GeneralFilterBand.OpType opType,
Kernel structuringElement)
Defines an intermediate source sample computed from a non-linear image filter.
|
void |
defineComputedSample(int index,
int sourceIndex,
Kernel kernel)
Defines an intermediate source sample computed from a linear image convolution.
|
void |
defineComputedSample(int index,
int dataType,
String expression,
Product... sourceProducts)
Defines an intermediate source sample computed from a band math expression.
|
void |
defineComputedSample(int index,
RasterDataNode raster)
Defines an intermediate source sample computed from the given raster.
|
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. |
void |
setValidPixelMask(String maskExpression)
Defines a mask that identifies valid pixels (region of interest) using a Boolean expression.
|
void setValidPixelMask(String maskExpression)
computePixel
or
computeSample
are called.maskExpression
- The Boolean valid-pixel mask expression.RasterDataNode.setNoDataValueUsed(boolean)
,
RasterDataNode.setGeophysicalNoDataValue(double)
void defineSample(int index, String name)
RasterDataNode
.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.void defineSample(int index, String name, Product product)
RasterDataNode
in the given product.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.void defineComputedSample(int index, int dataType, String expression, Product... sourceProducts)
The method effectively creates a VirtualBand
from which it computes the source samples.
If multiple source products are used a reference number Product.setRefNo(int)
has to be assigned.
index
- The index of the sample within the sample arrays passed to
computeSample()
or
computePixel()
methods.dataType
- The data type of the computed sample. See TYPE_X
constants in ProductData
.expression
- The band maths expression.sourceProducts
- Source products that are referenced in the expression.void defineComputedSample(int index, int sourceIndex, Kernel kernel)
The method effectively creates a ConvolutionFilterBand
from which it computes the source samples.
index
- The index of the sample within the sample arrays passed to
computeSample()
or
computePixel()
methods.sourceIndex
- The index of the source sample that will be filtered.kernel
- The image convolution kernel.void defineComputedSample(int index, int sourceIndex, GeneralFilterBand.OpType opType, Kernel structuringElement)
The method effectively creates a GeneralFilterBand
from which it computes the source samples.
index
- The index of the sample within the sample arrays passed to
computeSample()
or
computePixel()
methods.sourceIndex
- The index of the source sample that will be filtered.opType
- The filter operation to be applied to pixels identified by the structuring element.structuringElement
- The structuring element is a Boolean kernel identifying the pixel positions to be filtered.void defineComputedSample(int index, RasterDataNode raster)
The raster is usually either a component of the source products or not attached to any product at all. However, it must not be a component of the target product.
index
- The index of the sample within the sample arrays passed to
computeSample()
or
computePixel()
methods.raster
- The index of the source sample that will be filtered.Copyright © 2014–2017 European Space Agency (ESA). All rights reserved.