Package com.esri.arcgisruntime.raster
Class RGBRenderer
- java.lang.Object
-
- com.esri.arcgisruntime.raster.RasterRenderer
-
- com.esri.arcgisruntime.raster.BaseStretchRenderer
-
- com.esri.arcgisruntime.raster.RGBRenderer
-
public final class RGBRenderer extends BaseStretchRenderer
Defines a renderer that allows you to combine bands as red, green, and blue. You will also want to use this renderer to display different combinations of bands when working with multiband raster datasets, such as satellite or aerial imagery.- Since:
- 100.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RGBRenderer.PansharpenType
Panchromatic sharpening uses a higher-resolution panchromatic image (or raster band) to fuse with a lower-resolution multiband raster dataset.
-
Constructor Summary
Constructors Constructor Description RGBRenderer(StretchParameters stretchParameters, java.util.List<java.lang.Integer> bandIndexes, java.util.List<java.lang.Double> gammas, boolean estimateStatistics)
Creates a RGBRenderer.RGBRenderer(StretchParameters stretchParameters, java.util.List<java.lang.Integer> bandIndexes, java.util.List<java.lang.Double> gammas, boolean estimateStatistics, RGBRenderer.PansharpenType pansharpenType, Raster panchromaticRaster, java.util.List<java.lang.Double> weights)
Creates a RGBRenderer with options to specify panchromatic raster.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.Integer>
getBandIndexes()
Gets the band indexes used to create this renderer.Raster
getPanchromaticRaster()
Gets the panchromatic raster used to create this renderer.RGBRenderer.PansharpenType
getPansharpenType()
Gets the pansharpen type used to create this renderer.java.util.List<java.lang.Double>
getWeights()
Gets the weights used to create this renderer.-
Methods inherited from class com.esri.arcgisruntime.raster.BaseStretchRenderer
getGammas, getStretchParameters, isEstimateStatistics
-
-
-
-
Constructor Detail
-
RGBRenderer
public RGBRenderer(StretchParameters stretchParameters, java.util.List<java.lang.Integer> bandIndexes, java.util.List<java.lang.Double> gammas, boolean estimateStatistics)
Creates a RGBRenderer.- Parameters:
stretchParameters
- stretch parametersbandIndexes
- the band indexes in which the raster is displayedgammas
- gamma adjustmentsestimateStatistics
- true to enable estimating statistics- Throws:
java.lang.IllegalArgumentException
- if stretchParameters is null- Since:
- 100.0.0
-
RGBRenderer
public RGBRenderer(StretchParameters stretchParameters, java.util.List<java.lang.Integer> bandIndexes, java.util.List<java.lang.Double> gammas, boolean estimateStatistics, RGBRenderer.PansharpenType pansharpenType, Raster panchromaticRaster, java.util.List<java.lang.Double> weights)
Creates a RGBRenderer with options to specify panchromatic raster.- Parameters:
stretchParameters
- stretch parametersbandIndexes
- the band indexes in which the raster is displayedgammas
- gamma adjustmentsestimateStatistics
- true to enable estimating statisticspansharpenType
- type of panchromatic sharpeningpanchromaticRaster
- raster for panchromatic sharpening, can be null if pansharpenType isRGBRenderer.PansharpenType.NONE
weights
- band weights for pansharpening- Throws:
java.lang.IllegalArgumentException
- if stretchParameters is nulljava.lang.IllegalArgumentException
- if pansharpenType is nulljava.lang.IllegalArgumentException
- if panchromaticRaster is null and pansharpenType is notRGBRenderer.PansharpenType.NONE
- Since:
- 100.0.0
-
-
Method Detail
-
getBandIndexes
public java.util.List<java.lang.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 java.util.List<java.lang.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
-
-