Package org.geotools.coverage.processing

Class BaseStatisticsOperationJAI

Object

AbstractOperation

Operation2D

OperationJAI

BaseStatisticsOperationJAI

All Implemented Interfaces:

Serializable, Operation

Direct Known Subclasses:

Extrema, Histogram, ZonalStatistics, ZonalStats

public abstract class BaseStatisticsOperationJAI
extends OperationJAI

This class is the root class for the Statistics operations based on JAI's StatisticsOpImage like Extrema and Histogram. It provides basic capabilities for management of geospatial parameters like ROIs and subsampling factors.

Since:

2.4.x

Author:

Simone Giannecchini

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class OperationJAI

OperationJAI.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
static Logger	LOGGER	Logger for this class.
static ParameterDescriptor<Polygon>	ROI	The parameter descriptor for the Region Of Interest.
static ParameterDescriptor<Double>	SPATIAL_SUBSAMPLING_X	The parameter descriptor for the SPATIAL_SUBSAMPLING_X
static ParameterDescriptor<Double>	SPATIAL_SUBSAMPLING_Y	The parameter descriptor for the SPATIAL_SUBSAMPLING_Y

Fields inherited from class OperationJAI

operation, RENDERED_MODE

Fields inherited from class Operation2D

PRIMARY_SOURCE_INDEX, SOURCE_0

Fields inherited from class AbstractOperation

descriptor

Constructor Summary

Constructors

Constructor	Description
BaseStatisticsOperationJAI(String name)	Constructor for BaseStatisticsOperationJAI.
BaseStatisticsOperationJAI(String name, OperationDescriptor operationDescriptor)	Constructor for BaseStatisticsOperationJAI.
BaseStatisticsOperationJAI(OperationDescriptor operationDescriptor)	Constructor for BaseStatisticsOperationJAI.
BaseStatisticsOperationJAI(OperationDescriptor operationDescriptor, ImagingParameterDescriptors replacements)	Constructor for BaseStatisticsOperationJAI.

Method Summary

Modifier and Type	Method	Description
protected static Polygon	convertPolygon(Polygon roiInput, MathTransform worldToGridTransform)	Converte a JTS Polygon, which represents a ROI, into an AWT Polygon by means of the provided MathTransform.
protected ParameterBlockJAI	prepareParameters(ParameterValueGroup parameters)	Copies parameter values from the specified ParameterValueGroup to the ParameterBlockJAI

Methods inherited from class OperationJAI

createRenderedImage, deriveCategory, deriveGridCoverage, deriveName, deriveRange, deriveSampleDimension, deriveUnit, doOperation, equals, extractSources, getJAI, getOperationDescriptor, getProperties, getQuantitative, handleJAIEXTParams, handleROINoDataInternal, handleROINoDataProperties, hashCode, resampleToCommonGeometry

Methods inherited from class Operation2D

extractSources, getFactory

Methods inherited from class AbstractOperation

getDescription, getDocURL, getName, getNumSources, getParameters, getVendor, getVersion, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOGGER

public static final Logger LOGGER

Logger for this class.

SPATIAL_SUBSAMPLING_X

public static final ParameterDescriptor<Double> SPATIAL_SUBSAMPLING_X

The parameter descriptor for the SPATIAL_SUBSAMPLING_X

SPATIAL_SUBSAMPLING_Y

public static final ParameterDescriptor<Double> SPATIAL_SUBSAMPLING_Y

The parameter descriptor for the SPATIAL_SUBSAMPLING_Y

ROI

public static final ParameterDescriptor<Polygon> ROI

The parameter descriptor for the Region Of Interest.

Constructor Detail

BaseStatisticsOperationJAI

public BaseStatisticsOperationJAI(OperationDescriptor operationDescriptor)

Constructor for BaseStatisticsOperationJAI.

Parameters:

operationDescriptor - OperationDescriptor for the underlying JAI operation.

BaseStatisticsOperationJAI

public BaseStatisticsOperationJAI(OperationDescriptor operationDescriptor,
                                  ImagingParameterDescriptors replacements)

Constructor for BaseStatisticsOperationJAI.

Parameters:

operationDescriptor - OperationDescriptor for the underlying JAI operation.

replacements - ImagingParameterDescriptors that should replace the correspondent ImagingParameters in order to change the default behavior they have inside JAI.

BaseStatisticsOperationJAI

public BaseStatisticsOperationJAI(String name,
                                  OperationDescriptor operationDescriptor)

Constructor for BaseStatisticsOperationJAI.

Parameters:

name - of the underlying JAI operation.

BaseStatisticsOperationJAI

public BaseStatisticsOperationJAI(String name)

Constructor for BaseStatisticsOperationJAI.

Parameters:

name - of the underlying JAI operation.

Method Detail

prepareParameters

protected ParameterBlockJAI prepareParameters(ParameterValueGroup parameters)

Copies parameter values from the specified ParameterValueGroup to the ParameterBlockJAI

Overrides:

prepareParameters in class OperationJAI

Parameters:

parameters - The ParameterValueGroup to be copied.

Returns:

A copy of the provided ParameterValueGroup as a JAI block.

See Also:

OperationJAI.prepareParameters(org.geotools.api.parameter.ParameterValueGroup)

convertPolygon

protected static Polygon convertPolygon(Polygon roiInput,
                                        MathTransform worldToGridTransform)
                                 throws TransformException

Converte a JTS Polygon, which represents a ROI, into an AWT Polygon by means of the provided MathTransform.

Parameters:

roiInput - the input ROI as a JTS Polygon.

worldToGridTransform - the MathTransform to apply to the input ROI.

Returns:

an AWT Polygon.

Throws:

TransformException - in case the provided MathTransform chokes.