xarray.Dataset.cf.decode_vertical_coords¶
- Dataset.cf.decode_vertical_coords(*, outnames=None, prefix=None)¶
Decode parameterized vertical coordinates in place.
- Parameters:
- outnamesdict, optional
Keys of outnames are the input sigma/s coordinate variable name and the values are the name to use for the associated vertical coordinate.
- prefixstr, optional
Prefix for newly created z variables. E.g.
s_rho
becomesz_rho
.
- Returns:
- None
Modifies self inplace.
See also
Notes
Will only decode when the
formula_terms
andstandard_name
attributes are set on the parameter (e.gs_rho
)Currently only supports
ocean_s_coordinate_g1
,ocean_s_coordinate_g2
, andocean_sigma_coordinate
.Warning
Very lightly tested. Please double check the results.