Class SubtractConst

All Implemented Interfaces:
Serializable, Operation

public class SubtractConst extends OperationJAI
Subtracts constants (one for each band) from every sample values of the source coverage. 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.

Name: "SubtractConst"
JAI operator: "SubtractConst"
Parameters:

Name Class Default value Minimum value Maximum value
"Source" GridCoverage2D N/A N/A N/A
"constants" double[] N/A N/A N/A
Since:
2.2
Author:
Martin Desruisseaux (IRD)
See Also:
  • Constructor Details

    • SubtractConst

      public SubtractConst()
      Constructs a default "SubtractConst" operation.
  • Method Details

    • getName

      public String 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 interface Operation
      Overrides:
      getName in class AbstractOperation
      Returns:
      The name of the processing operation.
    • deriveRange

      protected NumberRange<? extends Number> deriveRange(NumberRange<? extends Number>[] ranges, OperationJAI.Parameters parameters)
      Returns the expected range of values for the resulting image.
      Overrides:
      deriveRange in class OperationJAI
      Parameters:
      ranges - The range of values from every sources. For unary operations this array has a length of 1. For binary operations like "add" and "multiply", this array has a length of 2.
      parameters - Parameters, rendering hints and coordinate reference system to use.
      Returns:
      The range of values to use in the destination image, or null if unknow.
    • handleJAIEXTParams

      protected void handleJAIEXTParams(ParameterBlockJAI parameters, ParameterValueGroup parameters2)
      Description copied from class: OperationJAI
      Extension point for adding to the JAI ParameterBlockJAI object the parameters defined in the ParameterValueGroup, 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 class OperationJAI
      Parameters:
      parameters - ParameterBlockJAI instance used by the current JAI-EXT/JAI operation
      parameters2 - ParameterValueGroup instance containing input operation parameters
    • getProperties

      protected Map<String,?> getProperties(RenderedImage data, CoordinateReferenceSystem crs, InternationalString name, MathTransform gridToCRS, GridCoverage2D[] sources, OperationJAI.Parameters parameters)
      Description copied from class: OperationJAI
      Prepares the properties to be given to the coverage created by the deriveGridCoverage method. The default implementation returns null.
      Overrides:
      getProperties in class OperationJAI
      Parameters:
      data - The RenderedImage created by this operation.
      crs - The coordinate reference system assigned to the coverage this OperationJAI will produce.
      name - The name assigned to the coverage this OperationJAI will produce.
      gridToCRS - The transform from grid to crs to be assigned to the coverage this OperationJAI will produce.
      sources - The sources to be assigned to the coverage this OperationJAI will produce.
      parameters - The parameters that were used by this OperationJAI.
      Returns:
      a Map with the properties generated by this OperationJAI or null if we haven't any.