API#
Top-level API#
|
Convert bounds variable to vertices. There are 2 covered cases: |
|
Convert vertices to CF-compliant bounds. There are 2 covered cases: |
|
Convert a DataArray with shapely geometry objects into a CF-compliant dataset. |
|
Convert geometries stored in a CF-compliant way to shapely objects stored in a single variable. |
|
Set options for cf-xarray in a controlled context. |
|
Encode a MultiIndexed dimension using the "compression by gathering" CF convention. |
|
Decode a compressed variable to a pandas MultiIndex. |
DataArray#
Attributes#
Property that returns a dictionary mapping valid Axis standard names for |
|
Property that returns a dictionary mapping valid cell measure standard names for |
|
Returns a dictionary mapping cf_role names to variable names. |
|
Property that returns a dictionary mapping valid Coordinate standard names for |
|
Property that returns a dictionary mapping the parametric coordinate's name to a dictionary that maps "standard term names" to actual variable names. |
|
Get CF grid mapping name associated with this variable. |
|
Returns True if the DataArray satisfies CF conventions for flag variables. |
|
Returns a dictionary mapping standard names to variable names. |
|
Methods#
Index into a DataArray making use of CF attributes. |
|
Return repr(self). |
|
Add canonical CF attributes to variables with standard names. |
|
|
Differentiate an xarray object. |
|
Automagically guesses X, Y, Z, T, latitude, longitude, and adds appropriate attributes. |
Utility function that returns valid keys for .cf[]. |
|
|
Renames variables in object to match names of like-variables in |
Flag Variables#
cf_xarray supports rich comparisons for CF flag variables. Flag masks are not yet supported.
|
Compare flag values against other. |
|
Compare flag values against other. |
|
Compare flag values against other. |
|
Compare flag values against other. |
|
Compare flag values against other. |
|
Compare flag values against other. |
|
Test each value in the array for whether it is in test_elements. |
Dataset#
Attributes#
Property that returns a dictionary mapping valid Axis standard names for |
|
Property that returns a dictionary mapping keys to the variable names of their bounds. |
|
Property that returns a dictionary mapping valid cell measure standard names for |
|
Returns a dictionary mapping cf_role names to variable names. |
|
Property that returns a dictionary mapping valid Coordinate standard names for |
|
Property that returns a dictionary mapping the parametric coordinate's name to a dictionary that maps "standard term names" to actual variable names. |
|
Property that returns a dictionary mapping the CF grid mapping name to the variable name containing the grid mapping attributes. |
|
Returns a dictionary mapping standard names to variable names. |
Methods#
Index into a Dataset making use of CF attributes. |
|
Return repr(self). |
|
|
Returns a new object with bounds variables. |
Add canonical CF attributes to variables with standard names. |
|
|
Convert bounds variable to vertices. |
|
Decode parameterized vertical coordinates in place. |
|
Differentiate an xarray object. |
Get bounds variable corresponding to key. |
|
Get bounds dim name for variable corresponding to key. |
|
|
Automagically guesses X, Y, Z, T, latitude, longitude, and adds appropriate attributes. |
Utility function that returns valid keys for .cf[]. |
|
|
Renames variables in object to match names of like-variables in |