ArcGIS Runtime SDK for iOS: AGSRGBRenderer Class Reference
ArcGIS Runtime SDK for iOS  100.13
AGSRGBRenderer Class Reference

Description

An RGB composite raster renderer.

Instances of this class represent an RGB composite stretch renderer that can help visualize raster data using AGSRasterLayer.

An RGB composite stretch renderer similar to AGSStretchRenderer but allows you to combine bands as red, green, blue composites. 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 multiband raster datasets, such as satellite or aerial imagery.

Since
100
Inheritance diagram for AGSRGBRenderer:
AGSBaseStretchRenderer AGSRasterRenderer AGSObject

Instance Methods

(instancetype) - init
 
(instancetype) - initWithStretchParameters:bandIndexes:gammas:estimateStatistics:
 
(instancetype) - initWithStretchParameters:bandIndexes:gammas:estimateStatistics:pansharpenType:panchromaticRaster:weights:
 

Class Methods

(instancetype) + baseStretchRenderer
 
(instancetype) + rasterRenderer
 
(instancetype) + RGBRendererWithStretchParameters:bandIndexes:gammas:estimateStatistics:
 
(instancetype) + RGBRendererWithStretchParameters:bandIndexes:gammas:estimateStatistics:pansharpenType:panchromaticRaster:weights:
 

Properties

NSArray< NSNumber * > * bandIndexes
 
BOOL estimateStatistics
 
NSArray< NSNumber * > * gammas
 
AGSRasterpanchromaticRaster
 
AGSPansharpenType pansharpenType
 
AGSStretchParametersstretchParameters
 
NSArray< NSNumber * > * weights
 

Method Documentation

◆ baseStretchRenderer

+ (instancetype) baseStretchRenderer
Deprecated:
100.9. Do not use this method, it creates an invalid and incomplete object.

◆ init

- (instancetype) init

◆ initWithStretchParameters:bandIndexes:gammas:estimateStatistics:

- (instancetype) initWithStretchParameters: (AGSStretchParameters *)  stretchParameters
bandIndexes: (NSArray< NSNumber * > *)  bandIndexes
gammas: (NSArray< NSNumber * > *)  gammas
estimateStatistics: (BOOL)  estimateStatistics 

Initializes an RGB composite stretch renderer.

Parameters
stretchParametersThe stretch parameters to use.
bandIndexesSpecifying which bands to use as red, green, and blue.
gammasAn array of values in the range 0 - 2 to apply gamma correction for each band in the raster dataset. Gamma refers to the degree of contrast between the midlevel gray values of a raster dataset. Gamma does not affect the black or white values in a raster dataset, only the middle values. By applying a gamma correction, you can control the overall brightness of a raster dataset. Additionally, gamma changes not only the brightness but also the ratios of red to green to blue. Values lower than 1 decrease the contrast in the darker areas and increase the contrast in the lighter areas. This darkens the image without saturating the dark or light areas of the image. This helps bring out details in lighter features, such as building tops. Conversely, gamma values greater than 1 increase the contrast in darker areas, such as shadows from buildings. Gamma values greater than one can also help bring out details in lower elevation areas when working with elevation data.
estimateStatisticsindicating whether statistics should be estimated for raster datasets that don't contain statistical information about their pixel values.
Since
100

◆ initWithStretchParameters:bandIndexes:gammas:estimateStatistics:pansharpenType:panchromaticRaster:weights:

- (instancetype) initWithStretchParameters: (AGSStretchParameters *)  stretchParameters
bandIndexes: (NSArray< NSNumber * > *)  bandIndexes
gammas: (NSArray< NSNumber * > *)  gammas
estimateStatistics: (BOOL)  estimateStatistics
pansharpenType: (AGSPansharpenType pansharpenType
panchromaticRaster: (nullable AGSRaster *)  panchromaticRaster
weights: (nullable NSArray< NSNumber * > *)  weights 

Initializes an RGB composite stretch renderer.

Parameters
stretchParametersThe stretch parameters to use.
bandIndexesspecifying which bands to use as red, green, and blue.
gammasAn array of values in the range 0 - 2 to apply gamma correction for each band in the raster dataset. Gamma refers to the degree of contrast between the midlevel gray values of a raster dataset. Gamma does not affect the black or white values in a raster dataset, only the middle values. By applying a gamma correction, you can control the overall brightness of a raster dataset. Additionally, gamma changes not only the brightness but also the ratios of red to green to blue. Values lower than 1 decrease the contrast in the darker areas and increase the contrast in the lighter areas. This darkens the image without saturating the dark or light areas of the image. This helps bring out details in lighter features, such as building tops. Conversely, gamma values greater than 1 increase the contrast in darker areas, such as shadows from buildings. Gamma values greater than one can also help bring out details in lower elevation areas when working with elevation data.
estimateStatisticsIndicating whether statistics should be estimated for raster datasets that don't contain statistical information about their pixel values.
pansharpenTypeSpecifying the type of panchromatic sharpening method to apply.
panchromaticRasterThe high resolution raster used as the basis for pan-sharpening
weightsWeights used by the pan-sharpening method.
Since
100

◆ rasterRenderer

+ (instancetype) rasterRenderer

◆ RGBRendererWithStretchParameters:bandIndexes:gammas:estimateStatistics:

+ (instancetype) RGBRendererWithStretchParameters: (AGSStretchParameters *)  stretchParameters
bandIndexes: (NSArray< NSNumber * > *)  bandIndexes
gammas: (NSArray< NSNumber * > *)  gammas
estimateStatistics: (BOOL)  estimateStatistics 

Creates an RGB composite stretch renderer.

Parameters
stretchParametersThe stretch parameters to use.
bandIndexesSpecifying which bands to use as red, green, and blue.
gammasAn array of values in the range 0 - 2 to apply gamma correction for each band in the raster dataset. Gamma refers to the degree of contrast between the midlevel gray values of a raster dataset. Gamma does not affect the black or white values in a raster dataset, only the middle values. By applying a gamma correction, you can control the overall brightness of a raster dataset. Additionally, gamma changes not only the brightness but also the ratios of red to green to blue. Values lower than 1 decrease the contrast in the darker areas and increase the contrast in the lighter areas. This darkens the image without saturating the dark or light areas of the image. This helps bring out details in lighter features, such as building tops. Conversely, gamma values greater than 1 increase the contrast in darker areas, such as shadows from buildings. Gamma values greater than one can also help bring out details in lower elevation areas when working with elevation data.
estimateStatisticsIndicating whether statistics should be estimated for raster datasets that don't contain statistical information about their pixel values.
Returns
A new RGB composite stretch renderer.
Since
100

◆ RGBRendererWithStretchParameters:bandIndexes:gammas:estimateStatistics:pansharpenType:panchromaticRaster:weights:

+ (instancetype) RGBRendererWithStretchParameters: (AGSStretchParameters *)  stretchParameters
bandIndexes: (NSArray< NSNumber * > *)  bandIndexes
gammas: (NSArray< NSNumber * > *)  gammas
estimateStatistics: (BOOL)  estimateStatistics
pansharpenType: (AGSPansharpenType pansharpenType
panchromaticRaster: (nullable AGSRaster *)  panchromaticRaster
weights: (nullable NSArray< NSNumber * > *)  weights 

Creates an RGB composite stretch renderer.

Parameters
stretchParametersThe stretch parameters to use
bandIndexesspecifying which bands to use as red, green, and blue.
gammasAn array of values in the range 0 - 2 to apply gamma correction for each band in the raster dataset. Gamma refers to the degree of contrast between the midlevel gray values of a raster dataset. Gamma does not affect the black or white values in a raster dataset, only the middle values. By applying a gamma correction, you can control the overall brightness of a raster dataset. Additionally, gamma changes not only the brightness but also the ratios of red to green to blue. Values lower than 1 decrease the contrast in the darker areas and increase the contrast in the lighter areas. This darkens the image without saturating the dark or light areas of the image. This helps bring out details in lighter features, such as building tops. Conversely, gamma values greater than 1 increase the contrast in darker areas, such as shadows from buildings. Gamma values greater than one can also help bring out details in lower elevation areas when working with elevation data.
estimateStatisticsIndicating whether statistics should be estimated for raster datasets that don't contain statistical information about their pixel values.
pansharpenTypeSpecifying the type of panchromatic sharpening method to apply.
panchromaticRasterThe high resolution raster used as the basis for pan-sharpening.
weightsWeights used by the pan-sharpening method.
Returns
A new RGB composite stretch renderer.
Since
100

Property Documentation

◆ bandIndexes

- (NSArray<NSNumber*>*) bandIndexes
readnonatomiccopy

Indexes of bands of a multi-band raster dataset that the renderer is based on. The band specified by the 0th index is used as the red band, 1st index as the green band, and 2nd index as the blue band.

Since
100

◆ estimateStatistics

- (BOOL) estimateStatistics
readnonatomicassigninherited

Indicates whether statistics should be estimated for the raster dataset. This is typically needed for datasets that do not have statistics.

Since
100

◆ gammas

- (NSArray<NSNumber*>*) gammas
readnonatomiccopyinherited

An array of values in the range 0-2 to apply gamma correction for each band in the raster dataset. Gamma refers to the degree of contrast between the midlevel gray values of a raster dataset. Gamma does not affect the black or white values in a raster dataset, only the middle values. By applying a gamma correction, you can control the overall brightness of a raster dataset. Additionally, gamma changes not only the brightness but also the ratios of red to green to blue. Values lower than 1 decrease the contrast in the darker areas and increase the contrast in the lighter areas. This darkens the image without saturating the dark or light areas of the image. This helps bring out details in lighter features, such as building tops. Conversely, gamma values greater than 1 increase the contrast in darker areas, such as shadows from buildings. Gamma values greater than one can also help bring out details in lower elevation areas when working with elevation data.

Since
100

◆ panchromaticRaster

- (AGSRaster*) panchromaticRaster
readnonatomicstrong

The high-resolution panchromatic raster to use as a basis for panchoromatic sharpening.

Pan-sharpening uses a higher-resolution panchromatic image (or raster band) to fuse with a lower-resolution multiband raster dataset. The result produces a multiband raster dataset with the resolution of the panchromatic raster where the two rasters fully overlap.

See also
http://desktop.arcgis.com/en/arcmap/latest/manage-data/raster-and-images/fundamentals-of-panchromatic-sharpening.htm
Since
100

◆ pansharpenType

- (AGSPansharpenType) pansharpenType
readnonatomicassign

◆ stretchParameters

- (AGSStretchParameters*) stretchParameters
readnonatomicstronginherited

The stretch parameters used for the renderer.

Since
100

◆ weights

- (NSArray<NSNumber*>*) weights
readnonatomiccopy

The weights to use in the panchormatic sharpening method.

Each of method uses different models to improve the spatial resolution while maintaining the color, and some are adjusted to include a weighting so that a fourth band can be included (such as the near-infrared band available in many multispectral image sources). By adding the weighting and enabling the infrared component, the visual quality in the output colors is improved.

See also
http://desktop.arcgis.com/en/arcmap/latest/manage-data/raster-and-images/fundamentals-of-panchromatic-sharpening.htm
Since
100