org.geotools.coverage.processing.operation
Class SelectSampleDimension

java.lang.Object
  org.geotools.coverage.processing.AbstractOperation
      org.geotools.coverage.processing.Operation2D
          org.geotools.coverage.processing.operation.SelectSampleDimension

All Implemented Interfaces:

org.opengis.coverage.processing.Operation, java.io.Serializable

public class SelectSampleDimension

extends Operation2D

Chooses N sample dimensions from a grid coverage and copies their sample data to the destination grid coverage in the order specified. The parameter specifies the source GridSampleDimension indices, and its size () determines the number of sample dimensions of the destination grid coverage. The destination coverage may have any number of sample dimensions, and a particular sample dimension of the source coverage may be repeated in the destination coverage by specifying it multiple times in the parameter.

Geotools extension:
This operation can also be used for selecting a different "visible sample dimension". Some images may contain useful data in more than one sample dimension, but renderer the content using only 1 sample dimension at time. The parameter can be used for selecting this sample dimension. If ommited, then the new grid coverage will inherit its source's visible sample dimension.

Name: "SelectSampleDimension"
JAI operator: "BandSelect"
Parameters:

Name	Class	Default value	Minimum value	Maximum value
	GridCoverage2D	N/A	N/A	N/A
		Same as source	N/A	N/A
	Integer	Same as source	0	N/A

Since:

2.2

Version:

$Id: SelectSampleDimension.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Operations.selectSampleDimension(org.opengis.coverage.Coverage, int[]), BandSelectDescriptor, Serialized Form

Field Summary

static org.opengis.parameter.ParameterDescriptor	SAMPLE_DIMENSIONS The parameter descriptor for the sample dimension indices.
static org.opengis.parameter.ParameterDescriptor	VISIBLE_SAMPLE_DIMENSION The parameter descriptor for the visible dimension indice.

Fields inherited from class org.geotools.coverage.processing.Operation2D

SOURCE_0

Fields inherited from class org.geotools.coverage.processing.AbstractOperation

descriptor

Constructor Summary

SelectSampleDimension()
Constructs a default operation.

Method Summary

protected org.opengis.coverage.Coverage

doOperation(org.opengis.parameter.ParameterValueGroup parameters, Hints hints) Applies the band select operation to a grid coverage.

Methods inherited from class org.geotools.coverage.processing.Operation2D

getFactory, getGridCoverageProcessor

Methods inherited from class org.geotools.coverage.processing.AbstractOperation

ensureNonNull, equals, getDescription, getDocURL, getName, getNumSources, getParameters, getProcessor, getVendor, getVersion, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

SAMPLE_DIMENSIONS

public static final org.opengis.parameter.ParameterDescriptor SAMPLE_DIMENSIONS

The parameter descriptor for the sample dimension indices.

VISIBLE_SAMPLE_DIMENSION

public static final org.opengis.parameter.ParameterDescriptor VISIBLE_SAMPLE_DIMENSION

The parameter descriptor for the visible dimension indice. This is a Geotools-specific parameter.

Constructor Detail

SelectSampleDimension

public SelectSampleDimension()

Constructs a default operation.

Method Detail

doOperation

protected org.opengis.coverage.Coverage doOperation(org.opengis.parameter.ParameterValueGroup parameters,
                                                    Hints hints)

Applies the band select operation to a grid coverage. This method is invoked by DefaultProcessor for the operation.

Specified by:

doOperation in class AbstractOperation

Parameters:

parameters - List of name value pairs for the parameters.

hints - A set of rendering hints, or if none.

Returns:

The result as a grid coverage.