Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageSampleParametersProperties

Hierarchy

  • ImageSampleParametersProperties

Index

Properties

Optional geometry

geometry: (PointProperties & { type: "point" }) | (MultipointProperties & { type: "multipoint" }) | (PolylineProperties & { type: "polyline" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" })

Input geometry that defines the the locations to be sampled.

Read more...

Optional interpolation

interpolation: "nearest" | "bilinear" | "cubic" | "majority"

Defines how to interpolate pixel values.

Read more...

Optional locations

locations: PointProperties[]

When sampling multiple locations, you can use an array of points instead of providing a multipoint for the geometry property.

Read more...

Optional mosaicRule

Specifies the mosaic rule defining the image sort order and selection.

Read more...

Optional outFields

outFields: string[]

The list of fields associated with the rasters to be included in the response.

Read more...

Optional pixelSize

Specifies the pixel size (or the resolution) that will be used for the sampling.

Read more...

Optional returnFirstValueOnly

returnFirstValueOnly: boolean

When true, returns the first valid pixel value that meets specified conditions at each sampling point location.

Read more...

Optional sampleCount

sampleCount: number

Specifies the approximate number of locations to sample from the provided geometry when the input geometry is polyline, polygon or extent.

Read more...

Optional sampleDistance

sampleDistance: number

Specifies the distance interval to sample points from the provided geometry when input geometry is polyline.

Read more...

Optional sliceId

sliceId: number

Specifies the slice id of a multidimensional raster.

Read more...

Optional timeExtent

The time extent for which to perform sampling.

Read more...

Generated using TypeDoc