/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2005-2008, Open Source Geospatial Foundation (OSGeo)
*
* 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.geotools.coverage.processing.operation;
// JAI dependencies (for javadoc)
import javax.media.jai.operator.MultiplyConstDescriptor;
import org.geotools.coverage.processing.OperationJAI;
import org.geotools.util.NumberRange;
/**
* Multiplies every sample values of the source coverage by constants (one for each band).
* If the number of constants supplied is less than the number of bands of the destination,
* then the constant from entry 0 is applied to all the bands. Otherwise, a constant from a
* different entry is applied to each band.
*
* <P><STRONG>Name:</STRONG> <CODE>"MultiplyConst"</CODE><BR>
* <STRONG>JAI operator:</STRONG> <CODE>"{@linkplain MultiplyConstDescriptor MultiplyConst}"</CODE><BR>
* <STRONG>Parameters:</STRONG></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.geotools.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 "constants"}</td>
* <td>{@code double[]}</td>
* <td align="center">1.0</td>
* <td align="center">N/A</td>
* <td align="center">N/A</td>
* </tr>
* </table>
*
* @since 2.2
*
*
* @source $URL$
* @version $Id$
* @author Martin Desruisseaux (IRD)
*
* @see org.geotools.coverage.processing.Operations#multiply(org.opengis.coverage.Coverage, double[])
* @see MultiplyConstDescriptor
*
* @todo Should operates on {@code sampleToGeophysics} transform when possible.
* See <A HREF="http://jira.codehaus.org/browse/GEOT-610">GEOT-610</A>.
*/
public class MultiplyConst extends OperationJAI {
/**
* Serial number for interoperability with different versions.
*/
private static final long serialVersionUID = -1077713495023498436L;
/**
* Constructs a default {@code "MultiplyConst"} operation.
*/
public MultiplyConst() {
super("MultiplyConst");
}
/**
* Returns the expected range of values for the resulting image.
*/
protected NumberRange deriveRange(final NumberRange[] ranges, final Parameters parameters) {
final double[] constants = (double[]) parameters.parameters.getObjectParameter("constants");
if (constants.length == 1) {
final double c = constants[0];
final NumberRange range = ranges[0];
final double min = range.getMinimum() * c;
final double max = range.getMaximum() * c;
return (max<min) ? NumberRange.create(max, min) : NumberRange.create(min, max);
}
return super.deriveRange(ranges, parameters);
}
}