traveler.skims.omx.OMX.to_dataset#

OMX.to_dataset(*, zone_id=None, dim_names=('otaz', 'dtaz'))[source]#

Convert matrices and compatible lookups to an xarray dataset.

Parameters:
  • zone_id (str, optional) – Lookup name to use for both matrix coordinates. Zero-based integer coordinates are used when omitted.

  • dim_names (tuple[str, str], optional) – Names for the origin and destination dimensions.

Returns:

Dataset containing OMX matrices and compatible one-dimensional lookups.

Return type:

xarray.Dataset

Raises:

OMXIncompatibleShape – If a lookup length matches neither matrix dimension.