BandStatistics interface

Package:

@azure/planetarycomputer

Statistical information about a data band.

Properties

count	Count of pixels in the band.
histogram	Histogram of pixel values in the band.
majority	Most common value in the band.
maskedPixels	Count of masked pixels in the band.
maximum	Maximum value in the band.
mean	Mean value of the band.
median	Median value of the band.
minimum	Minimum value in the band.
minority	Least common value in the band.
percentile2	Percentile 2 The 2nd percentile value.
percentile98	Percentile 98 The 98th percentile value.
std	Standard deviation of pixel values in the band.
sum	Sum of all pixel values in the band.
unique	Count of unique values in the band.
validPercent	Percentage of valid (non-masked) pixels.
validPixels	Count of valid (non-masked) pixels in the band.

Property Details

count

Count of pixels in the band.

count: number

Property Value

number

histogram

Histogram of pixel values in the band.

histogram: number[][]

Property Value

number[][]

majority

Most common value in the band.

majority: number

Property Value

number

maskedPixels

Count of masked pixels in the band.

maskedPixels: number

Property Value

number

maximum

Maximum value in the band.

maximum: number

Property Value

number

mean

Mean value of the band.

mean: number

Property Value

number

median

Median value of the band.

median: number

Property Value

number

minimum

Minimum value in the band.

minimum: number

Property Value

number

minority

Least common value in the band.

minority: number

Property Value

number

percentile2

Percentile 2 The 2nd percentile value.

percentile2: number

Property Value

number

percentile98

Percentile 98 The 98th percentile value.

percentile98: number

Property Value

number

std

Standard deviation of pixel values in the band.

std: number

Property Value

number

sum

Sum of all pixel values in the band.

sum: number

Property Value

number

unique

Count of unique values in the band.

unique: number

Property Value

number

validPercent

Percentage of valid (non-masked) pixels.

validPercent: number

Property Value

number

validPixels

Count of valid (non-masked) pixels in the band.

validPixels: number

Property Value

number