Accessors API

DataArray

Attributes

DataArray.xoa.xdim

X dimension

DataArray.xoa.ydim

Y dimension name

DataArray.xoa.zdim

Z dimension name

DataArray.xoa.tdim

T (time) dimension name

DataArray.xoa.name

Get the generic name that matches this array

DataArray.xoa.attrs

Get the generic attributes that matches this array

DataArray.xoa.coords

Sub-accessor for coords only

DataArray.xoa.data_vars

Sub-accessor for data_vars only

DataArray.xoa.cf

The CFDataArrayAccessor subaccessor

Methods

DataArray.xoa.set_cf_specs(cfspecs)

Set the internal CFSpecs used by this accessor

DataArray.xoa.get_cf_specs()

Get the internal CFSpecs instance used by this accessor

DataArray.xoa.decode(**kwargs)

Rename variables and coordinates to generic names

DataArray.xoa.encode(**kwargs)

Rename variables and coordinates to specialized names

DataArray.xoa.auto_format(**kwargs)

Rename variables and coordinates and fill their attributes

DataArray.xoa.fill_attrs(**kwargs)

Fill missing attributes

DataArray.xoa.infer_coords(**kwargs)

Infer coordinates and set them as coordinates

DataArray.xoa.get(cf_name[, loc, single, errors])

Search for a data array or coordinate knowing its generic CF name

DataArray.xoa.get_coord(cf_name[, loc, ...])

Search for a coordinate knowing its generic CF name

DataArray.xoa.get_depth([errors])

Get the depth as computed or recognized by the CFSpecs()

Dataset

Attributes

Dataset.xoa.coords

Sub-accessor for coords only

Dataset.xoa.data_vars

Sub-accessor for data_vars only

Dataset.xoa.cf

The CFDatasetAccessor subaccessor

Dataset.xoa.decode_sigma

The SigmaAccessor subaccessor for sigma coordinates

Methods

Dataset.xoa.set_cf_specs(cfspecs)

Set the internal CFSpecs used by this accessor

Dataset.xoa.get_cf_specs()

Get the internal CFSpecs instance used by this accessor

Dataset.xoa.decode(**kwargs)

Rename variables and coordinates to generic names

Dataset.xoa.encode(**kwargs)

Rename variables and coordinates to specialized names

Dataset.xoa.auto_format(**kwargs)

Rename variables and coordinates and fill their attributes

Dataset.xoa.fill_attrs(**kwargs)

Fill missing attributes

Dataset.xoa.infer_coords(**kwargs)

Infer coordinates and set them as coordinates

Dataset.xoa.get(cf_name[, loc, single, errors])

Search for a data array or coordinate knowing its generic CF name

Dataset.xoa.get_coord(cf_name[, loc, ...])

Search for a coordinate knowing its generic CF name

Dataset.xoa.get_depth([errors])

Get the depth as computed or recognized by the CFSpecs()

Dataset.decode_sigma.decode([rename, errors])

Compute depth from sigma coordinates

Dataset.decode_sigma.get_sigma_terms([loc, ...])

Call get_sigma_terms() on the dataset

Callables

Dataset.decode_sigma()

Shortcut to decode()