/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2003-2012, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2012, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotoolkit.coverage.processing.operation;
import javax.media.jai.operator.BandSelectDescriptor;
import org.apache.sis.parameter.ParameterBuilder;
import org.opengis.coverage.Coverage;
import org.opengis.parameter.ParameterValueGroup;
import org.opengis.parameter.ParameterDescriptor;
import org.geotoolkit.factory.Hints;
import org.geotoolkit.coverage.grid.ViewType;
import org.geotoolkit.coverage.grid.GridCoverage2D;
import org.geotoolkit.coverage.processing.Operation2D;
import org.geotoolkit.metadata.Citations;
/**
* Chooses <var>N</var> {@linkplain org.geotoolkit.coverage.GridSampleDimension sample dimensions}
* from a grid coverage and copies their sample data to the destination grid coverage in the order
* specified. The {@code "SampleDimensions"} parameter specifies the source
* {@link org.geotoolkit.coverage.GridSampleDimension} indices, and its size
* ({@code SampleDimensions.length}) 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 {@code "SampleDimensions"} parameter.
*
* <P><b>Name:</b> {@code "SelectSampleDimension"}<BR>
* <b>JAI operator:</b> <CODE>"{@linkplain BandSelectDescriptor BandSelect}"</CODE><BR>
* <b>Parameters:</b></P>
* <table border='3' cellpadding='6' bgcolor='F4F8FF'>
* <tr bgcolor='#B9DCFF'>
* <th>Name</th>
* <th>Class</th>
* <th>Default value</th>
* <th>Minimum value</th>
* <th>Maximum value</th>
* </tr>
* <tr>
* <td>{@code "Source"}</td>
* <td>{@link org.geotoolkit.coverage.grid.GridCoverage2D}</td>
* <td align="center">N/A</td>
* <td align="center">N/A</td>
* <td align="center">N/A</td>
* </tr>
* <tr>
* <td>{@code "SampleDimensions"}</td>
* <td>{@code int[]}</td>
* <td align="center">Same as source</td>
* <td align="center">N/A</td>
* <td align="center">N/A</td>
* </tr>
* <tr>
* <td>{@code "VisibleSampleDimension"}</td>
* <td>{@link java.lang.Integer}</td>
* <td align="center">Same as source</td>
* <td align="center">0</td>
* <td align="center">N/A</td>
* </tr>
* </table>
*
* {@section Geotoolkit.org 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 {@code "VisibleSampleDimension"} parameter can be
* used for selecting this sample dimension. If omitted, then the new grid coverage will inherit
* its source's visible sample dimension.
*
* @author Martin Desruisseaux (IRD)
* @version 3.00
*
* @see org.geotoolkit.coverage.processing.Operations#selectSampleDimension
* @see BandSelectDescriptor
*
* @since 2.0
* @module
*/
public class SelectSampleDimension extends Operation2D {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 6889502343896409135L;
/**
* The parameter descriptor for the sample dimension indices.
*/
public static final ParameterDescriptor<int[]> SAMPLE_DIMENSIONS;
/**
* The parameter descriptor for the visible dimension indice.
* This is a Geotk-specific parameter.
*/
public static final ParameterDescriptor<Integer> VISIBLE_SAMPLE_DIMENSION;
static {
final ParameterBuilder builder = new ParameterBuilder().setCodeSpace(Citations.OGC, null);
SAMPLE_DIMENSIONS = builder.addName("SampleDimensions").create(int[].class, null);
VISIBLE_SAMPLE_DIMENSION = builder.setCodeSpace(Citations.GEOTOOLKIT, null).addName("VisibleSampleDimension")
.createBounded(Integer.class, 0, null, null);
}
/**
* Constructs a default {@code "SelectSampleDimension"} operation.
*/
public SelectSampleDimension() {
super(new ParameterBuilder().addName("SelectSampleDimension").createGroup(
SOURCE_0, SAMPLE_DIMENSIONS, VISIBLE_SAMPLE_DIMENSION));
}
/**
* Returns {@link ViewType#SAME} as the preferred view for computation purpose.
*/
@Override
protected ViewType getComputationView(final ParameterValueGroup parameters) {
return ViewType.SAME;
}
/**
* Applies the band select operation to a grid coverage. This method is
* invoked by {@link org.geotoolkit.coverage.processing.DefaultCoverageProcessor}
* for the {@code "SelectSampleDimension"} operation.
*
* @param parameters List of name value pairs for the parameters.
* @param hints A set of rendering hints, or {@code null} if none.
* @return The result as a grid coverage.
*/
@Override
protected Coverage doOperation(final ParameterValueGroup parameters, final Hints hints) {
final GridCoverage2D[] sources = new GridCoverage2D[1];
final ViewType targetView = extractSources(parameters, sources);
final GridCoverage2D source = sources[0];
return BandSelector2D.create(source, parameters, hints).view(targetView);
}
}