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 (Any)

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

Initialize OceanbenchMetrics.

Parameters:

  • eval_variables (Optional[List[str]]) – List of variables to evaluate.

  • oceanbench_eval_variables (Optional[List[str]]) – OceanBench standard variables.

  • is_class4 (Optional[bool]) – Enable Class 4 metrics.

  • class4_kwargs (Optional[dict]) – Arguments for Class4Evaluator.

  • **kwargs – Additional arguments.

Return type:

None

Methods

__init__([eval_variables, ...])

Initialize OceanbenchMetrics.

compute(pred_data[, ref_data])

Compute the metric wrapper (includes preprocessing).

compute_metric(pred_data[, ref_data, ...])

Compute a given metric.

get_metric_name()

Return the name of the metric.
compute_metric(pred_data, ref_data=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:

  • pred_data (xr.Dataset) – dataset to evaluate

  • ref_data (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)

  • extra_kwargs (Any)

Returns:

computed metric (if any)

Return type:

ndarray, optional