cfdm.Bounds¶
-
class
cfdm.
Bounds
(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.mixin.netcdf.NetCDFVariable
,cfdm.mixin.netcdf.NetCDFDimension
,cfdm.mixin.propertiesdata.PropertiesData
,cfdm.core.bounds.Bounds
A cell bounds component of a coordinate or domain ancillary construct of the CF data model.
An array of cell bounds spans the same domain axes as its coordinate array, with the addition of an extra dimension whose size is that of the number of vertices of each cell. This extra dimension does not correspond to a domain axis construct since it does not relate to an independent axis of the domain. Note that, for climatological time axes, the bounds are interpreted in a special way indicated by the cell method constructs.
In the CF data model, a bounds component does not have its own properties because they can not logically be different to those of the coordinate construct itself. However, it is sometimes desired to store attributes on a CF-netCDF bounds variable, so it is also allowed to provide properties to a bounds component.
NetCDF interface
The netCDF variable name of the bounds may be accessed with the
nc_set_variable
,nc_get_variable
,nc_del_variable
andnc_has_variable
methods.The name of the trailing netCDF dimension spanned by bounds (which does not correspond to a domain axis construct) may be accessed with the
nc_set_dimension
,nc_get_dimension
,nc_del_dimension
andnc_has_dimension
methods.The netCDF variable group structure may be accessed with the
nc_set_variable
,nc_get_variable
,nc_variable_groups
,nc_clear_variable_groups
andnc_set_variable_groups
methods.New in version 1.7.0.
Initialization
- Parameters
- properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
Properties may also be set after initialisation with the
set_properties
andset_property
methods.- Parameter example:
properties={'standard_name': 'grid_latitude'}
- data:
Data
, optional Set the data. Ignored if the source parameter is set.
The data also may be set after initialisation with the
set_data
method.- source: optional
Initialize the properties and data from those of source.
- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.
- properties:
Inspection¶
Methods
A full description of the bounds component. |
|
Return the canonical identity. |
|
Return all possible identities. |
Properties¶
Methods
Remove a property. |
|
Return a property. |
|
Whether a property has been set. |
|
Set a property. |
|
Return all properties. |
|
Remove all properties. |
|
Set properties. |
|
Return the properties inherited from a coordinate construct. |
Data¶
Methods
Apply masking as defined by the CF conventions. |
|
Remove the data. |
|
Return the data. |
|
Whether a data has been set. |
|
Set the data. |
|
Expand the shape of the data array. |
|
Remove size one axes from the data array. |
|
Permute the axes of the data array. |
Attributes
Return the data. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Whether two instances are the same. |
|
Uncompress the construct. |
|
Return the name of the file or files containing the data. |
NetCDF¶
Methods
Remove the netCDF variable name. |
|
Return the netCDF variable name. |
|
Whether the netCDF variable name has been set. |
|
Set the netCDF variable name. |
|
Remove the netCDF dimension name. |
|
Return the netCDF dimension name. |
|
Whether the netCDF dimension name has been set. |
|
Set the netCDF dimension name. |
Groups¶
Methods
Return the netCDF variable group hierarchy. |
|
Remove the netCDF variable group hierarchy. |
|
Set the netCDF variable group hierarchy. |
|
Return the netCDF dimension group hierarchy. |
|
Remove the netCDF dimension group hierarchy. |
|
Set the netCDF dimension group hierarchy. |
Special¶
Methods
Called by the |
|
Return a subspace defined by indices |
|
Called by the |
|
Called by the |