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, List<Integer> bandIndexes, List<Double> gammas, boolean estimateStatistics)	Creates a RGBRenderer.
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.

Method Summary

Modifier and Type	Method	Description
List<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.
List<Double>	getWeights()	Gets the weights used to create this renderer.

Methods inherited from class com.esri.arcgisruntime.raster.BaseStretchRenderer

getGammas, getStretchParameters, isEstimateStatistics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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 Detail

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