ice_shelf_state_and_fate.timeseries_module.timeseries_enums

Module for the manipulation of timeseries.

Classes

AggregationPeriod(*values)	The available aggregation periods.
AggregationStrategy(*values)	The available aggregation types.
JointPlotAnalysisType(*values)	The available analysis types used to evaluate correlation or causality between variables.
ModelEvaluationMetric(*values)	The available model evaluation metrics.
NormalisationType(*values)	The available normalisation types.
TimeseriesType(*values)	Define the type of timeseries.
UncertaintyType(*values)	The available uncertainty types.

class AggregationPeriod(*values)

Bases: StrEnum

The available aggregation periods.

DAY = 'day'

MONTH = 'month'

QUARTER = 'quarter'

YEAR = 'year'

static format_with_units(value: int64 | int | float, period: AggregationPeriod, max_decimal_places: int = 2) → str

Format a value with its corresponding time unit as a human-readable string.

static pd_date_range_freq(period: AggregationPeriod) → str

Appropriate value for pd.date_range() freq parameter.

static pd_period_freq(period: AggregationPeriod) → str

Appropriate value for pd.PeriodIndex() freq parameter.

class AggregationStrategy(*values)

Bases: StrEnum

The available aggregation types.

IQR = 'IQR'

MAX = 'max'

MEAN = 'mean'

MEDIAN = 'median'

MIN = 'min'

NONE = 'None'

STD = 'std'

class JointPlotAnalysisType(*values)

Bases: StrEnum

The available analysis types used to evaluate correlation or causality between variables.

CAUSAL = 'causal'

CORR = 'corr'

CROSS_CORR = 'cross_corr'

class ModelEvaluationMetric(*values)

Bases: StrEnum

The available model evaluation metrics.

AIC = 'aic'

BIC = 'bic'

class NormalisationType(*values)

Bases: StrEnum

The available normalisation types.

FIRST = 'first'

LINEAR_REGRESSION = 'linear_regression'

class TimeseriesType(*values)

Bases: StrEnum

Define the type of timeseries. This can be cumulative or derivative.

CUMULATIVE = 'cumulative'

DERIVATIVE = 'derivative'

class UncertaintyType(*values)

Bases: StrEnum

The available uncertainty types.

IQR = 'IQR'

MAX = 'max'

MIN = 'min'

PVALUE = 'p_value'

STD = 'std'