demcompare.metric.scalar_metrics

Mainly contains different scalar metric classes

Module Contents

Classes

Mean	Mean metric class
Max	Max metric class
Min	Min metric class
Std	Standard deviation metric class
Rmse	Root-mean-square-deviation metric class
Median	Median metric class
Nmad	Normalized-median-absolute-deviation metric class
Sum	Summation metric class
SumSquaredErr	Squared summation metric class
Percentil90	90 percentil metric class

class demcompare.metric.scalar_metrics.Mean(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Mean metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed mean

Return type:

float

class demcompare.metric.scalar_metrics.Max(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Max metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed max

Return type:

float

class demcompare.metric.scalar_metrics.Min(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Min metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed min

Return type:

float

class demcompare.metric.scalar_metrics.Std(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Standard deviation metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed std

Return type:

float

class demcompare.metric.scalar_metrics.Rmse(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Root-mean-square-deviation metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed rmse

Return type:

rmse

class demcompare.metric.scalar_metrics.Median(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Median metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed median

Return type:

float

class demcompare.metric.scalar_metrics.Nmad(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Normalized-median-absolute-deviation metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed nmad

Return type:

float

class demcompare.metric.scalar_metrics.Sum(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Summation metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed sum

Return type:

float

class demcompare.metric.scalar_metrics.SumSquaredErr(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

Squared summation metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed squared_sum

Return type:

float

class demcompare.metric.scalar_metrics.Percentil90(parameters: Dict = None)

Bases: demcompare.metric.metric_template.MetricTemplate

90 percentil metric class

compute_metric(data: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray] | numpy.ndarray | float

Metric computation method

Parameters:

data (np.array) – input data to compute the metric

Returns:

the computed percentil_90

Return type:

float