BandStatistics Class

Statistical information about a data band.

Constructor

BandStatistics(*args: Any, **kwargs: Any)

Variables

Name	Description
minimum	float Minimum value in the band. Required.
maximum	float Maximum value in the band. Required.
mean	float Mean value of the band. Required.
count	float Count of pixels in the band. Required.
sum	float Sum of all pixel values in the band. Required.
std	float Standard deviation of pixel values in the band. Required.
median	float Median value of the band. Required.
majority	float Most common value in the band. Required.
minority	float Least common value in the band. Required.
unique	float Count of unique values in the band. Required.
histogram	list[list[float]] Histogram of pixel values in the band. Required.
valid_percent	float Percentage of valid (non-masked) pixels. Required.
masked_pixels	float Count of masked pixels in the band. Required.
valid_pixels	float Count of valid (non-masked) pixels in the band. Required.
percentile2	float Percentile 2 The 2nd percentile value. Required.
percentile98	float Percentile 98 The 98th percentile value. Required.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

count

Count of pixels in the band. Required.

count: float

histogram

Histogram of pixel values in the band. Required.

histogram: list[list[float]]

majority

Most common value in the band. Required.

majority: float

masked_pixels

Count of masked pixels in the band. Required.

masked_pixels: float

maximum

Maximum value in the band. Required.

maximum: float

mean

Mean value of the band. Required.

mean: float

median

Median value of the band. Required.

median: float

minimum

Minimum value in the band. Required.

minimum: float

minority

Least common value in the band. Required.

minority: float

percentile2

Percentile 2 The 2nd percentile value. Required.

percentile2: float

percentile98

Percentile 98 The 98th percentile value. Required.

percentile98: float

std

Standard deviation of pixel values in the band. Required.

std: float

sum

Sum of all pixel values in the band. Required.

sum: float

unique

Count of unique values in the band. Required.

unique: float

valid_percent

Percentage of valid (non-masked) pixels. Required.

valid_percent: float

valid_pixels

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

valid_pixels: float

Feedback

Was this page helpful?