@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/layers/support/rasterFunctionConstants.d.ts

@@ -11,6 +11,7 @@
 /** Slope type constants used for the [slope raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_641F092319AE46D1A9441F8D1FDF186C). */
 export const slopeType: SlopeType;
 
+/** Slope type constants used for the [slope raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_641F092319AE46D1A9441F8D1FDF186C). */
 export interface SlopeType {
   /**
    * 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
@@ -33,6 +34,7 @@ export interface SlopeType {
  */
 export const curvatureType: CurvatureType;
 
+/** Curvature type constants used for the [curvature raster function](https://developers.arcgis.com/rest/services-reference/enterprise/raster-function-objects/#curvature). */
 export interface CurvatureType {
   /** Is perpendicular to the direction of the maximum slope. It affects the convergence and divergence of flow across a surface. */
   planform: number;
@@ -49,6 +51,7 @@ export interface CurvatureType {
  */
 export const hillshadeType: HillshadeType;
 
+/** Hillshade type constants used for the [hillshade raster function](https://developers.arcgis.com/rest/services-reference/enterprise/raster-function-objects/#hillshade). */
 export interface HillshadeType {
   /** Combines light from multiple sources to represent an enhanced visualization of the terrain. */
   multidirectional: number;
@@ -59,6 +62,7 @@ export interface HillshadeType {
 /** Method name constants used by the [band index raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_4D75298B90D94E6B87B0C9F28D5AE269). */
 export const bandIndexType: BandIndexType;
 
+/** Method name constants used by the [band index raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_4D75298B90D94E6B87B0C9F28D5AE269). */
 export interface BandIndexType {
   /**
    * 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.
@@ -213,6 +217,7 @@ export interface BandIndexType {
 /** Predefined raster color map name constants used for the [Colormap raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#GUID-5DDFC961-A857-445F-A983-13AF67D45833). */
 export const colormapName: ColormapName;
 
+/** Predefined raster color map name constants used for the [Colormap raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#GUID-5DDFC961-A857-445F-A983-13AF67D45833). */
 export interface ColormapName {
   /** A color map that gradually changes from cyan to purple to black. */
   elevation: string;
@@ -233,6 +238,7 @@ export interface ColormapName {
 /** Predefined raster color ramp name constants used for the [Colormap raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#GUID-5DDFC961-A857-445F-A983-13AF67D45833). */
 export const colorRampName: ColorRampName;
 
+/** Predefined raster color ramp name constants used for the [Colormap raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#GUID-5DDFC961-A857-445F-A983-13AF67D45833). */
 export interface ColorRampName {
   /** Aspect. */
   aspect: string;
@@ -353,6 +359,7 @@ export interface ColorRampName {
 /** The missing band action constants available for the [Extract band raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_2FC6FEAA2801446B9578A7C90B1DD6AB). */
 export const missingBandAction: MissingBandAction;
 
+/** The missing band action constants available for the [Extract band raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_2FC6FEAA2801446B9578A7C90B1DD6AB). */
 export interface MissingBandAction {
   /** Finds the best available band to use in place of the missing band based on wavelength. so that the function will not fail. */
   bestMatch: number;
@@ -366,6 +373,10 @@ export interface MissingBandAction {
  */
 export const noDataInterpretation: NoDataInterpretation;
 
+/**
+ * The NoData interpretation constants used for the [Mask raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_5515B13D320B408B9F70B9B8344028FF).
+ * This refers to how NoData Values will impact the output image.
+ */
 export interface NoDataInterpretation {
   /** The NoData values you specify for each band must occur in the same pixel for the output image to contain the NoData pixel. */
   matchAll: number;
@@ -381,6 +392,12 @@ export interface NoDataInterpretation {
  */
 export const convolutionKernel: ConvolutionKernel;
 
+/**
+ * Kernel type constants used for the [Convolution raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_B69A71FDFD7C46A6860A7302A9AD3B17).
+ * 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.
+ */
 export interface ConvolutionKernel {
   /** East gradient detection. Gradient filters can be used for edge detection in 45 degree increments. */
   gradientEast: number;
@@ -435,6 +452,7 @@ export interface ConvolutionKernel {
 /** Stretch type constants used for the [stretch raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_7545363F0B8A4B7B931A54B3C4189D9D). */
 export const stretchType: StretchType;
 
+/** Stretch type constants used for the [stretch raster function](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_7545363F0B8A4B7B931A54B3C4189D9D). */
 export interface StretchType {
   /** The histogram equalization stretch type. */
   histogramEqualization: number;
@@ -456,6 +474,10 @@ export interface StretchType {
  */
 export const localArithmeticOperation: LocalArithmeticOperation;
 
+/**
+ * The local arithmetic operations types. Refer to the [Local raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_FC0CE22F62094A7FB5B3C562D175FDCE)
+ * for more info.
+ */
 export interface LocalArithmeticOperation {
   /** Calculates the absolute value of the cells in a raster. */
   abs: number;
@@ -505,6 +527,10 @@ export interface LocalArithmeticOperation {
  */
 export const localLogicalOperation: LocalLogicalOperation;
 
+/**
+ * The local logical operations type constants. Refer to the [Local raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_FC0CE22F62094A7FB5B3C562D175FDCE)
+ * for more info.
+ */
 export interface LocalLogicalOperation {
   /** Performs a Bitwise And operation on the binary values of two input rasters. */
   bitwiseAnd: number;
@@ -548,6 +574,10 @@ export interface LocalLogicalOperation {
  */
 export const localTrigonometricOperation: LocalTrigonometricOperation;
 
+/**
+ * The local trigonometric operations type constants. Refer to the [Local raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_FC0CE22F62094A7FB5B3C562D175FDCE)
+ * for more info.
+ */
 export interface LocalTrigonometricOperation {
   /** Calculates the inverse cosine of cells in a raster. */
   acos: number;
@@ -584,6 +614,11 @@ export interface LocalTrigonometricOperation {
  */
 export const cellStatisticalOperation: 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](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_FC0CE22F62094A7FB5B3C562D175FDCE)
+ * for more info.
+ */
 export interface CellStatisticalOperation {
   /** Determines the majority (value that occurs most often) of the inputs. */
   majority: number;
@@ -633,6 +668,10 @@ export interface CellStatisticalOperation {
  */
 export const localConditionalOperation: LocalConditionalOperation;
 
+/**
+ * The local conditional operations type constants. Refer to the [Local raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm#ESRI_SECTION1_FC0CE22F62094A7FB5B3C562D175FDCE)
+ * for more info.
+ */
 export interface LocalConditionalOperation {
   /** 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. */
   conditional: number;