import { slopeType, curvatureType, hillshadeType, bandIndexType, colormapName } from "@arcgis/core/layers/support/rasterFunctionConstants.js";const { slopeType, curvatureType, hillshadeType, bandIndexType, colormapName } = await $arcgis.import("@arcgis/core/layers/support/rasterFunctionConstants.js");- Since
- ArcGIS Maps SDK for JavaScript 4.26
Various constant values used by different raster functions when setting ImageryTileLayer.rasterFunction or ImageryLayer.rasterFunction properties.
Variables
curvatureType
- Since
- ArcGIS Maps SDK for JavaScript 4.31
Curvature type constants used for the curvature raster function.
- Type
- CurvatureType
hillshadeType
- Since
- ArcGIS Maps SDK for JavaScript 4.31
Hillshade type constants used for the hillshade raster function.
- Type
- HillshadeType
bandIndexType
Method name constants used by the band index raster functions.
- Type
- BandIndexType
colormapName
Predefined raster color map name constants used for the Colormap raster function.
- Type
- ColormapName
colorRampName
Predefined raster color ramp name constants used for the Colormap raster function.
- Type
- ColorRampName
missingBandAction
The missing band action constants available for the Extract band raster function.
- Type
- MissingBandAction
noDataInterpretation
The NoData interpretation constants used for the Mask raster function. This refers to how NoData Values will impact the output image.
- Type
- NoDataInterpretation
convolutionKernel
Kernel type constants used for the Convolution raster function. Gradient filters can be used for edge detection in 45 degree increments. Laplacian filters are often used for edge detection. They are often applied to an image that has first been smoothed to reduce its sensitivity to noise. Line detection filters. like the gradient filters. can be used to perform edge detection. The Sobel filter is used for edge detection.
- Type
- ConvolutionKernel
localArithmeticOperation
The local arithmetic operations types. Refer to the Local raster functions for more info.
localLogicalOperation
The local logical operations type constants. Refer to the Local raster functions for more info.
localTrigonometricOperation
The local trigonometric operations type constants. Refer to the Local raster functions for more info.
cellStatisticalOperation
The local cell statistics operations type constants. This function calculates a statistic on a pixel-by-pixel basis. Refer to the Local raster functions for more info.
localConditionalOperation
The local conditional operations type constants. Refer to the Local raster functions for more info.
Type definitions
SlopeType
Slope type constants used for the slope raster function.
degree
- Type
- number
The inclination of slope is calculated in degrees. The values range from 0 to 90.
percentRise
- Type
- number
The inclination of slope is calculated as percentage values. The values range from 0 to infinity. A flat surface is 0 percent rise. whereas a 45-degree surface is 100 percent rise. As the surface becomes more vertical. the percent rise becomes increasingly larger.
adjusted
- Type
- number
The inclination of slope is calculated the same as DEGREE. but the z-factor is adjusted for scale. It uses the Pixel Size Power (PSP) and Pixel Size Factor (PSF) values. which account for the resolution changes (scale) as the viewer zooms in and out.
CurvatureType
Curvature type constants used for the curvature raster function.
planform
- Type
- number
Is perpendicular to the direction of the maximum slope. It affects the convergence and divergence of flow across a surface.
profile
- Type
- number
Is parallel to the slope and indicates the direction of maximum slope. It affects the acceleration and deceleration of flow across the surface.
HillshadeType
Hillshade type constants used for the hillshade raster function.
traditional
- Type
- number
Calculates hillshade from a single illumination direction. You can set the Azimuth and Altitude options to control the location of the light source.
multidirectional
- Type
- number
Combines light from multiple sources to represent an enhanced visualization of the terrain.
BandIndexType
Method name constants used by the band index raster functions.
userDefined
- Type
- number
User defined method. When using the user defined method to define your band arithmetic algorithm, you can enter a single-line algebraic formula to create a single-band output. The supported operators are -,+,/,*, and unary -. To identify the bands, add B or b to the beginning of the band number.
NDVI
- Type
- number
The Normalized Difference Vegetation Index (NDVI) method is a standardized index allowing you to generate an image displaying greenness (relative biomass). This index takes advantage of the contrast of the characteristics of two bands from a multispectral raster dataset—the chlorophyll pigment absorptions in the red band and the high reflectivity of plant materials in the NIR band.
SAVI
- Type
- number
The Soil-Adjusted Vegetation Index (SAVI) method is a vegetation index that attempts to minimize soil brightness influences using a soil-brightness correction factor. This is often used in arid regions where vegetative cover is low, and it outputs values between -1.0 and 1.0.
TSAVI
- Type
- number
The Transformed Soil Adjusted Vegetation Index (TSAVI) method is a vegetation index that minimizes soil brightness influences by assuming the soil line has an arbitrary slope and intercept.
MSAVI
- Type
- number
The Modified Soil Adjusted Vegetation Index (MSAVI) method minimizes the effect of bare soil on the SAVI.
GEMI
- Type
- number
The Global Environmental Monitoring Index (GEMI) method is a nonlinear vegetation index for global environmental monitoring from satellite imagery. It's similar to NDVI, but it's less sensitive to atmospheric effects. It is affected by bare soil; therefore, it's not recommended for use in areas of sparse or moderately dense vegetation.
PVI
- Type
- number
The Perpendicular Vegetation Index (PVI) method is similar to a difference vegetation index; however, it is sensitive to atmospheric variations. When using this method to compare images, it should only be used on images that have been atmospherically corrected.
GVITM
- Type
- number
The Green Vegetation Index (GVI) method was originally designed from Landsat MSS imagery and has been modified for Landsat TM imagery. It's also known as the Landsat TM Tasseled Cap green vegetation index. It can be used with imagery whose bands share the same spectral characteristics.
Sultan
- Type
- number
The Sultan's process takes a six-band 8-bit image and uses the Sultan's Formula method to produce a three-band 8-bit image. The resulting image highlights rock formations called ophiolites on coastlines. This formula was designed based on the TM or ETM bands of a Landsat 5 or 7 scene.
VARI
- Type
- number
The Visible Atmospherically Resistant Index (VARI) method is a vegetation index for estimating vegetation fraction quantitatively with only the visible range of the spectrum.
GNDVI
- Type
- number
The Green Normalized Difference Vegetation Index (GNDVI) method is a vegetation index for estimating photo synthetic activity and is a commonly used vegetation index to determine water and nitrogen uptake into the plant canopy.
SR
- Type
- number
The Simple Ratio (SR) method is a common vegetation index for estimating the amount of vegetation. It is the ratio of light scattered in the NIR and absorbed in red bands, which reduces the effects of atmosphere and topography.
NDVIRe
- Type
- number
The Red-Edge NDVI (NDVIre) method is a vegetation index for estimating vegetation health using the red-edge band. It is especially useful for estimating crop health in the mid to late stages of growth, when the chlorophyll concentration is relatively higher. Also, NDVIre can be used to map the within-field variability of nitrogen foliage to understand the fertilizer requirements of crops.
SRRe
- Type
- number
The Red-Edge Simple Ratio (SRre) method is a vegetation index for estimating the amount of healthy and stressed vegetation. It is the ratio of light scattered in the NIR and red-edge bands, which reduces the effects of atmosphere and topography.
MTVI2
- Type
- number
The Modified Triangular Vegetation Index (MTVI2) method is a vegetation index for detecting leaf chlorophyll content at the canopy scale while being relatively insensitive to leaf area index. It uses reflectance in the green, red, and NIR bands.
RTVICore
- Type
- number
The Red-Edge Triangulated Vegetation Index (RTVICore) method is a vegetation index for estimating leaf area index and biomass. This index uses reflectance in the NIR, red-edge, and green spectral bands.
CIRe
- Type
- number
The Chlorophyll Index - Red-Edge (CIre) method is a vegetation index for estimating the chlorophyll content in leaves using the ratio of reflectivity in the NIR and red-edge bands.
CIG
- Type
- number
Chlorophyll index - Green (CIG) method is a vegetation index for estimating the chlorophyll content in leaves using the ratio of reflectivity in the NIR and green bands.
NDWI
- Type
- number
The Normalized Difference Water Index (NDWI) method is an index for delineating and monitoring content changes in surface water. It is computed with the NIR and green bands. See NDWI raster function.
EVI
- Type
- number
The Enhanced Vegetation Index (EVI) method is an optimized vegetation index that accounts for atmospheric influences and vegetation background signal. It's similar to NDVI but is less sensitive to background and atmospheric noise, and it does not become as saturated as NDVI when viewing areas with very dense green vegetation. EVI raster function.
ironOxide
- Type
- number
The Iron Oxide (ironOxide) ratio method is a geological index for identifying rock features that have experienced oxidation of iron-bearing sulfides using the red and blue bands. It is useful in identifying iron oxide features below vegetation canopies and is used in mineral composite mapping. ironOxide raster function.
ferrousMinerals
- Type
- number
The Ferrous Minerals (ferrousMinerals) ratio method is a geological index for identifying rock features containing some quantity of iron-bearing minerals using the SWIR and NIR bands. It is used in mineral composite mapping. ferrousMinerals raster function.
clayMinerals
- Type
- number
The Clay Minerals (clayMinerals) ratio method is a geological index for identifying mineral features containing clay and alunite using two shortwave infrared (SWIR) bands. It is used in mineral composite mapping. See clayMinerals raster function.
WNDWI
- Type
- number
The Weighted Normalized Difference Water Index (WNDWI) method is a water index developed to reduce errors typically encountered in other water indices, including water turbidity, small water bodies, or shadow in remote sensing scenes.
BAI
- Type
- number
The Burn Area Index (BAI) uses the reflectance values in the red and NIR portion of the spectrum to identify the areas of the terrain affected by fire. See BAI raster function.
NBR
- Type
- number
The Normalized Burn Ratio Index (NBRI) uses the NIR and SWIR bands to emphasize burned areas, while mitigating illumination and atmospheric effects. Your images should be corrected to reflectance values before using this index. See NRB raster function.
NDBI
- Type
- number
The Normalized Difference Built-up Index (NDBI) uses the NIR and SWIR bands to emphasize manufactured built-up areas. It is ratio based to mitigate the effects of terrain illumination differences as well as atmospheric effects. NDBI raster function.
NDMI
- Type
- number
The Normalized Difference Moisture Index (NDMI) is sensitive to the moisture levels in vegetation. It is used to monitor droughts and fuel levels in fire-prone areas. It uses NIR and SWIR bands to create a ratio designed to mitigate illumination and atmospheric effects. NDMI raster function.
NDSI
- Type
- number
The Normalized Difference Snow Index (NDSI) is designed to use MODIS (band 4 and band 6) and Landsat TM (band 2 and band 5) for identification of snow cover while ignoring cloud cover. Since it is ratio based, it also mitigates atmospheric effects. NDSI raster function.
MNDWI
- Type
- number
The Modified Normalized Difference Water Index (MNDWI) uses green and SWIR bands for the enhancement of open water features. It also diminishes built-up area features that are often correlated with open water in other indices.
ColormapName
Predefined raster color map name constants used for the Colormap raster function.
NDVI
- Type
- string
colormap to visualize vegetation. Values near zero are blue. Low values are brown. Then the colors gradually change from red. to orange. to yellow. to green. and to black as the vegetation index goes from low to high.
NDVI2
- Type
- string
A colormap to visualize vegetation. Low values range from white to green. Then the colors range from gray. to purple. to violet. to dark blue. and to black as the vegetation index goes from low to high.
NDVI3
- Type
- string
A colormap to visualize vegetation. Values near zero are blue. Then the colors gradually change from red. to orange. and to green as the vegetation index goes from low to high.
hillshade
- Type
- string
A colormap to visualize a hillshade product. It has a color scheme that gradually changes from black to white depending on topography.
ColorRampName
Predefined raster color ramp name constants used for the Colormap raster function.
MissingBandAction
The missing band action constants available for the Extract band raster function.
bestMatch
- Type
- number
Finds the best available band to use in place of the missing band based on wavelength. so that the function will not fail.
fail
- Type
- number
If the input dataset is missing any band specified in the Band parameter. the function will fail.
NoDataInterpretation
The NoData interpretation constants used for the Mask raster function. This refers to how NoData Values will impact the output image.
matchAny
- Type
- number
If the NoData value you specify occurs for a cell in a specified band. that cell in the output image will be NoData.
matchAll
- Type
- number
The NoData values you specify for each band must occur in the same pixel for the output image to contain the NoData pixel.
ConvolutionKernel
Kernel type constants used for the Convolution raster function. Gradient filters can be used for edge detection in 45 degree increments. Laplacian filters are often used for edge detection. They are often applied to an image that has first been smoothed to reduce its sensitivity to noise. Line detection filters. like the gradient filters. can be used to perform edge detection. The Sobel filter is used for edge detection.
lineDetectionHorizontal
- Type
- number
Horizontal line detection. Line detection filters. like the gradient filters. can be used to perform edge detection.
lineDetectionVertical
- Type
- number
Vertical line detection. Line detection filters. like the gradient filters. can be used to perform edge detection.
lineDetectionLeftDiagonal
- Type
- number
Left diagonal line detection. Line detection filters. like the gradient filters. can be used to perform edge detection.
lineDetectionRightDiagonal
- Type
- number
Right diagonal line detection. Line detection filters. like the gradient filters. can be used to perform edge detection.
gradientNorth
- Type
- number
North gradient detection. Gradient filters can be used for edge detection in 45 degree increments.
gradientWest
- Type
- number
West gradient detection. Gradient filters can be used for edge detection in 45 degree increments.
gradientEast
- Type
- number
East gradient detection. Gradient filters can be used for edge detection in 45 degree increments.
gradientSouth
- Type
- number
South gradient detection. Gradient filters can be used for edge detection in 45 degree increments.
gradientNorthEast
- Type
- number
-North east gradient detection. Gradient filters can be used for edge detection in 45 degree increments.
gradientNorthWest
- Type
- number
-North west gradient detection. Gradient filters can be used for edge detection in 45 degree increments.
smoothArithmeticMean
- Type
- number
Smooths the data by reducing local variation and removing noise. Calculates the average (mean) value for each neighborhood. The effect is that the high and low values within each neighborhood are averaged out. reducing the extreme values in the data.
smoothing3x3
- Type
- number
Smooths (low-pass) the data by reducing local variation and removing noise. Calculates the average (mean) value for each neighborhood. The effect is that the high and low values within each neighborhood are averaged out. reducing the extreme values in the data.
smoothing5x5
- Type
- number
Smooths (low-pass) the data by reducing local variation and removing noise. Calculates the average (mean) value for each neighborhood. The effect is that the high and low values within each neighborhood are averaged out. reducing the extreme values in the data.
sharpening3x3
- Type
- number
Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. It brings out the boundaries between features (for example. where a water body meets the forest). thus sharpening edges between objects.
sharpening5x5
- Type
- number
Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. It brings out the boundaries between features (for example. where a water body meets the forest). thus sharpening edges between objects.
laplacian3x3
- Type
- number
Laplacian filters are often used for edge detection. They are often applied to an image that has first been smoothed to reduce its sensitivity to noise.
laplacian5x5
- Type
- number
Laplacian filters are often used for edge detection. They are often applied to an image that has first been smoothed to reduce its sensitivity to noise.
sharpen
- Type
- number
Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. It brings out the boundaries between features (for example. where a water body meets the forest). thus sharpening edges between objects.
sharpen2
- Type
- number
Sharpens the date by calculating the focal sum statistic for each cell of the input using a weighted kernel neighborhood. It brings out the boundaries between features (for example. where a water body meets the forest). thus sharpening edges between objects.
pointSpread
- Type
- number
The point spread function portrays the distribution of light from a point source through a lense. This will introduce a slight blurring effect.
StretchType
Stretch type constants used for the stretch raster function.
none
- Type
- number
If the stretch type is None. no stretch method will be applied. even if statistics exist.
standardDeviation
- Type
- number
The standard deviation stretch type applies a linear stretch between the values defined by the standard deviation (n) value.
minMax
- Type
- number
The minMax stretch type applies a linear stretch based on the output minimum and output maximum pixel values. which are used as the endpoints for the histogram.
percentClip
- Type
- number
The percent clip stretch type applies a linear stretch between the defined percent clip minimum and percent clip maximum pixel values.
sigmoid
- Type
- number
The Sigmoid contrast stretch is designed to highlight moderate pixel values in your imagery while maintaining sufficient contrast at the extremes.
LocalArithmeticOperation
The local arithmetic operations types. Refer to the Local raster functions for more info.
minus
- Type
- number
Subtracts the value of the second input raster from the value of the first input raster on a cell-by-cell basis.
power
- Type
- number
Raises the cell values in a raster to the power of the values found in another raster.
float
- Type
- number
Converts each cell value of a raster into a floating-point representation.
mod
- Type
- number
Finds the remainder (modulo) of the first raster when divided by the second raster on a cell-by-cell basis.
negate
- Type
- number
Changes the sign (multiplies by -1) of the cell values of the input raster on a cell-by-cell basis.
roundDown
- Type
- number
Returns the next lower integer value. just represented as a floating point. for each cell in a raster.
roundUp
- Type
- number
Returns the next higher integer value. just represented as a floating point. for each cell in a raster.
LocalLogicalOperation
The local logical operations type constants. Refer to the Local raster functions for more info.
bitwiseAnd
- Type
- number
Performs a Bitwise And operation on the binary values of two input rasters.
bitwiseLeftShift
- Type
- number
Performs a Bitwise Left Shift operation on the binary values of two input rasters.
bitwiseNot
- Type
- number
Performs a Bitwise Not (complement) operation on the binary value of an input raster.
bitwiseOr
- Type
- number
Performs a Bitwise Or operation on the binary values of two input rasters.
bitwiseRightShift
- Type
- number
Performs a Bitwise Right Shift operation on the binary values of two input rasters.
bitwiseXOr
- Type
- number
Performs a Bitwise eXclusive Or operation on the binary values of two input rasters.
booleanAnd
- Type
- number
Performs a Boolean And operation on the cell values of two input rasters.
booleanNot
- Type
- number
Performs a Boolean Not (complement) operation on the cell values of the input raster.
booleanOr
- Type
- number
Performs a Boolean Or operation on the cell values of two input rasters.
booleanXOr
- Type
- number
Performs a Boolean eXclusive Or operation on the cell values of two input rasters.
equalTo
- Type
- number
Performs a Relational equal-to operation on two inputs on a cell-by-cell basis.
greaterThan
- Type
- number
Performs a Relational greater-than operation on two inputs on a cell-by-cell basis.
greaterThanEqual
- Type
- number
Performs a Relational greater-than-or-equal-to operation on two inputs on a cell-by-cell basis.
lessThan
- Type
- number
Performs a Relational less-than operation on two inputs on a cell-by-cell basis.
lessThanEqual
- Type
- number
Performs a Relational less-than-or-equal-to operation on two inputs on a cell-by-cell basis.
isNull
- Type
- number
Determines which values from the input raster are NoData on a cell-by-cell basis.
notEqual
- Type
- number
Performs a Relational not-equal-to operation on two inputs on a cell-by-cell basis.
LocalTrigonometricOperation
The local trigonometric operations type constants. Refer to the Local raster functions for more info.
CellStatisticalOperation
The local cell statistics operations type constants. This function calculates a statistic on a pixel-by-pixel basis. Refer to the Local raster functions for more info.
minority
- Type
- number
Determines the minority (value that occurs least often) of the inputs.
range
- Type
- number
Calculates the range (difference between largest and smallest value) of the inputs.
majorityIgnoreNoData
- Type
- number
Determines the majority (value that occurs most often) of the inputs. Only cells that have data values will be used in determining the statistic value.
maxIgnoreNoData
- Type
- number
Determines the maximum (largest value) of the inputs. Only cells that have data values will be used in determining the statistic value.
meanIgnoreNoData
- Type
- number
Determines the mean (average value) of the inputs. Only cells that have data values will be used in determining the statistic value.
medIgnoreNoData
- Type
- number
Determines the median of the inputs. Only cells that have data values will be used in determining the statistic value.
minIgnoreNoData
- Type
- number
Determines the minimum (smallest value) of the inputs. Only cells that have data values will be used in determining the statistic value.
minorityIgnoreNoData
- Type
- number
Determines the minority (value that occurs least often) of the inputs. Only cells that have data values will be used in determining the statistic value.
rangeIgnoreNoData
- Type
- number
Calculates the range (difference between largest and smallest value) of the inputs. Only cells that have data values will be used in determining the statistic value.
stddevIgnoreNoData
- Type
- number
Calculates the standard deviation of the inputs. Only cells that have data values will be used in determining the statistic value.
sumIgnoreNoData
- Type
- number
Calculates the sum (total of all values) of the inputs. Only cells that have data values will be used in determining the statistic value.
varietyIgnoreNoData
- Type
- number
Calculates the variety (number of unique values) of the inputs. Only cells that have data values will be used in determining the statistic value.
LocalConditionalOperation
The local conditional operations type constants. Refer to the Local raster functions for more info.
setNull
- Type
- number
Set Null sets identified cell locations to NoData based on a specified criteria. It returns NoData if a conditional evaluation is true, and returns the value specified by another raster if it is false.
conditional
- Type
- number
Performs a conditional If, Then, Else operation. When a Con operator is used, there usually needs to be two or more local functions chained together, where one local function states the criteria and the second local function is the Con operator which uses the criteria and dictates what the true and false outputs should be.