Class Histogram
- All Implemented Interfaces:
Serializable
,Operation
HistogramDescriptor
inside a GeoTools
operation in order to make it spatial-aware.
For the moment this is a very simple wrap. Plans on the 2.4 and successive versions of this operation are to add
the ability to use spatial ROIs and to specific Spatial subsampling. As of now, ROI has to be a Java2D Shape
subclass and the parameters to control x and y subsamplings got to be Integer, which means pixel-aware.
For more information on how the underlying JAI
operators works you can have a look here: HistogramDescriptor
<a href="http://download.java.net/media/jai/javadoc/1.1.3/jai-apidocs/javax/media/jai/Histogram.html>Histogram
How to use this operation Here is a very simple example on how to use this operation in order to
get the Histogram
of the source coverage.
final OperationJAI op=new OperationJAI("Histogram");
ParameterValueGroup params = op.getParameters();
params.parameter("Source").setValue(coverage);
coverage=(GridCoverage2D) op.doOperation(params,null);
System.out.println(((double[])coverage.getProperty("histogram")));
- Since:
- 2.4
- Author:
- Simone Giannecchini
- See Also:
-
Histogram
- Serialized Form
-
Nested Class Summary
Nested classes/interfaces inherited from class OperationJAI
OperationJAI.Parameters
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
String
key for getting theHistogram
object.Fields inherited from class BaseStatisticsOperationJAI
LOGGER, ROI, SPATIAL_SUBSAMPLING_X, 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 -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns the name of the processing operation.getProperties
(RenderedImage data, CoordinateReferenceSystem crs, InternationalString name, MathTransform toCRS, GridCoverage2D[] sources, OperationJAI.Parameters parameters) Prepare theHistogram
property for this histogram operation.protected void
handleJAIEXTParams
(ParameterBlockJAI parameters, ParameterValueGroup parameters2) Extension point for adding to the JAIParameterBlockJAI
object the parameters defined in theParameterValueGroup
, which can be read by the JAI-EXT operations.protected ParameterBlockJAI
prepareParameters
(ParameterValueGroup parameters) Copies parameter values from the specifiedParameterValueGroup
to theParameterBlockJAI
Methods inherited from class BaseStatisticsOperationJAI
convertPolygon
Methods inherited from class OperationJAI
createRenderedImage, deriveCategory, deriveGridCoverage, deriveName, deriveRange, deriveSampleDimension, deriveUnit, doOperation, equals, extractSources, getJAI, getOperationDescriptor, getQuantitative, handleROINoDataInternal, handleROINoDataProperties, hashCode, resampleToCommonGeometry
Methods inherited from class Operation2D
extractSources, getFactory
Methods inherited from class AbstractOperation
getDescription, getDocURL, getNumSources, getParameters, getVendor, getVersion, toString
-
Field Details
-
GT_SYNTHETIC_PROPERTY_HISTOGRAM
String
key for getting theHistogram
object.- See Also:
-
-
Constructor Details
-
Histogram
Default constructor for theHistogram
operation.- Throws:
OperationNotFoundException
-
-
Method Details
-
getName
Description copied from class:AbstractOperation
Returns the name of the processing operation. The default implementation returns the AbstractOperation.descriptor code name.- Specified by:
getName
in interfaceOperation
- Overrides:
getName
in classAbstractOperation
- Returns:
- The name of the processing operation.
-
getProperties
protected Map<String,?> getProperties(RenderedImage data, CoordinateReferenceSystem crs, InternationalString name, MathTransform toCRS, GridCoverage2D[] sources, OperationJAI.Parameters parameters) Prepare theHistogram
property for this histogram operation.See HistogramDescriptor for more info.
- Overrides:
getProperties
in classOperationJAI
- Parameters:
data
- TheRenderedImage
created by this operation.crs
- The coordinate reference system assigned to the coverage thisOperationJAI
will produce.name
- The name assigned to the coverage thisOperationJAI
will produce.toCRS
- The transform from grid tocrs
to be assigned to the coverage thisOperationJAI
will produce.sources
- The sources to be assigned to the coverage thisOperationJAI
will produce.parameters
- The parameters that were used by thisOperationJAI
.- Returns:
- a
Map
with the properties generated by thisOperationJAI
or null if we haven't any.
-
prepareParameters
Description copied from class:BaseStatisticsOperationJAI
Copies parameter values from the specifiedParameterValueGroup
to theParameterBlockJAI
- Overrides:
prepareParameters
in classBaseStatisticsOperationJAI
- Parameters:
parameters
- TheParameterValueGroup
to be copied.- Returns:
- A copy of the provided
ParameterValueGroup
as a JAI block. - See Also:
-
handleJAIEXTParams
Description copied from class:OperationJAI
Extension point for adding to the JAIParameterBlockJAI
object the parameters defined in theParameterValueGroup
, which can be read by the JAI-EXT operations.Notice that if you are using JAI, the new parameters will not be accepted by the
ParameterBlockJAI
instance.- Overrides:
handleJAIEXTParams
in classOperationJAI
- Parameters:
parameters
-ParameterBlockJAI
instance used by the current JAI-EXT/JAI operationparameters2
-ParameterValueGroup
instance containing input operation parameters
-