dctools.metrics.oceanbench_metrics.OceanbenchMetrics

class dctools.metrics.oceanbench_metrics.OceanbenchMetrics(eval_variables=None, oceanbench_eval_variables=None, is_class4=None, class4_kwargs=None, **kwargs)

Central class for calling Oceanbench functions.

Parameters:

• eval_variables (List[str] | None)

• oceanbench_eval_variables (List[str] | None)

• is_class4 (bool | None)

• class4_kwargs (dict | None)

• kwargs (Dict[str, Any] | None)

__init__(eval_variables=None, oceanbench_eval_variables=None, is_class4=None, class4_kwargs=None, **kwargs)

Init func.

Args:

Parameters:

• eval_variables (List[str] | None)

• oceanbench_eval_variables (List[str] | None)

• is_class4 (bool | None)

• class4_kwargs (dict | None)

• kwargs (Dict[str, Any] | None)

Return type:

None

Methods

__init__([eval_variables, ...])	Init func.
compute(pred_data, ref_data)
compute_metric(eval_dataset[, ref_dataset, ...])	Compute a given metric.
get_metric_name()

compute_metric(eval_dataset, ref_dataset=None, eval_variables=[oceanbench.core.rmsd.Variable.SEA_SURFACE_HEIGHT_ABOVE_GEOID, oceanbench.core.rmsd.Variable.SEA_WATER_POTENTIAL_TEMPERATURE, oceanbench.core.rmsd.Variable.SEA_WATER_SALINITY, oceanbench.core.rmsd.Variable.NORTHWARD_SEA_WATER_VELOCITY, oceanbench.core.rmsd.Variable.EASTWARD_SEA_WATER_VELOCITY], zone=oceanbench.core.lagrangian_trajectory.ZoneCoordinates, pred_coords=None, ref_coords=None, **extra_kwargs)

Compute a given metric.

Parameters:

• eval_dataset (xr.Dataset) – dataset to evaluate

• ref_dataset (xr.Dataset) – reference dataset

• eval_variables (List[oceanbench.core.rmsd.Variable] | None)

• zone (oceanbench.core.lagrangian_trajectory.ZoneCoordinates | None)

• pred_coords (CoordinateSystem | None)

• ref_coords (CoordinateSystem | None)

Returns:

computed metric (if any)

Return type:

ndarray, optional