pandora2d.statistics

Functions to compute statistics on results.

Classes

`Quantiles`	Quantiles.
`Statistics`	Group various statistics.

Functions

compute_statistics(→ Statistics)

Compute statistics of a dataArray.

Module Contents

class pandora2d.statistics.Quantiles[source]

Quantiles.

p10: float | numpy.floating[source]

p25: float | numpy.floating[source]

p50: float | numpy.floating[source]

p75: float | numpy.floating[source]

p90: float | numpy.floating[source]

class pandora2d.statistics.Statistics[source]

Group various statistics.

mean: float | numpy.floating[source]

std: float | numpy.floating[source]

quantiles: Quantiles[source]

minimal_valid_pixel_ratio: float | numpy.floating = 1.0[source]

__str__() → str[source]

to_dict() → dict[source]: Convert statistics into a dictionary.

pandora2d.statistics.compute_statistics(data: numpy.ndarray, invalid_values: numpy.floating | numpy.integer = None) → Statistics[source]

Compute statistics of a dataArray.

Parameters:

data – data to compute statistics from.
invalid_values – value to exclude from computation

Returns:

computed statistics