Class RGBRenderer


public final class RGBRenderer extends BaseStretchRenderer
An RGB stretch renderer can combine bands as red, green, blue composites to help visualize the raster data in a RasterLayer.

This renderer can be used for viewing color aerial photography, which is a three-band raster dataset, or to display different combinations of bands when working with multi-band raster datasets, such as satellite or aerial imagery.

Since:
100.0.0
See Also:
  • Constructor Details

    • RGBRenderer

      public RGBRenderer(StretchParameters stretchParameters, List<Integer> bandIndexes, List<Double> gammas, boolean estimateStatistics)
      Creates a RGBRenderer.
      Parameters:
      stretchParameters - stretch parameters
      bandIndexes - the band indexes in which the raster is displayed
      gammas - gamma adjustments
      estimateStatistics - true to enable estimating statistics
      Throws:
      IllegalArgumentException - if stretchParameters is null
      Since:
      100.0.0
    • RGBRenderer

      public RGBRenderer(StretchParameters stretchParameters, List<Integer> bandIndexes, List<Double> gammas, boolean estimateStatistics, RGBRenderer.PansharpenType pansharpenType, Raster panchromaticRaster, List<Double> weights)
      Creates a RGBRenderer with options to specify panchromatic raster.
      Parameters:
      stretchParameters - stretch parameters
      bandIndexes - the band indexes in which the raster is displayed
      gammas - gamma adjustments
      estimateStatistics - true to enable estimating statistics
      pansharpenType - type of panchromatic sharpening
      panchromaticRaster - raster for panchromatic sharpening, can be null if pansharpenType is RGBRenderer.PansharpenType.NONE
      weights - band weights for pansharpening
      Throws:
      IllegalArgumentException - if stretchParameters is null
      IllegalArgumentException - if pansharpenType is null
      IllegalArgumentException - if panchromaticRaster is null and pansharpenType is not RGBRenderer.PansharpenType.NONE
      Since:
      100.0.0
  • Method Details

    • getBandIndexes

      public List<Integer> getBandIndexes()
      Gets the band indexes used to create this renderer.
      Returns:
      an unmodifiable list of the band indexes used to create this renderer
      Since:
      100.0.0
    • getPansharpenType

      public RGBRenderer.PansharpenType getPansharpenType()
      Gets the pansharpen type used to create this renderer.
      Returns:
      the pansharpen type used to create this renderer
      Since:
      100.0.0
    • getPanchromaticRaster

      public Raster getPanchromaticRaster()
      Gets the panchromatic raster used to create this renderer.
      Returns:
      the panchromatic raster used to create this renderer
      Since:
      100.0.0
    • getWeights

      public List<Double> getWeights()
      Gets the weights used to create this renderer.
      Returns:
      an unmodifiable list of the weights used to create this renderer
      Since:
      100.0.0