cfdm.CellMeasure¶
-
class
cfdm.
CellMeasure
(measure=None, properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.mixin.netcdf.NetCDFVariable
,cfdm.mixin.netcdf.NetCDFExternal
,cfdm.mixin.propertiesdata.PropertiesData
,cfdm.core.cellmeasure.CellMeasure
A cell measure construct of the CF data model.
A cell measure construct provides information that is needed about the size or shape of the cells and that depends on a subset of the domain axis constructs. Cell measure constructs have to be used when the size or shape of the cells cannot be deduced from the dimension or auxiliary coordinate constructs without special knowledge that a generic application cannot be expected to have.
The cell measure construct consists of a numeric array of the metric data which spans a subset of the domain axis constructs, and properties to describe the data. The cell measure construct specifies a “measure” to indicate which metric of the space it supplies, e.g. cell horizontal areas, and must have a units property consistent with the measure, e.g. square metres. It is assumed that the metric does not depend on axes of the domain which are not spanned by the array, along which the values are implicitly propagated. CF-netCDF cell measure variables correspond to cell measure constructs.
NetCDF interface
The netCDF variable name of the construct may be accessed with the
nc_set_variable
,nc_get_variable
,nc_del_variable
andnc_has_variable
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.
Initialisation
- Parameters
- measure:
str
, optional Set the measure that indicates which metric given by the data array. Ignored if the source parameter is set.
The measure may also be set after initialisation with the
set_measure
method.- Parameter example:
measure='area'
- 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': 'cell_area'}
- data:
Data
, optional Set the data array. Ignored if the source parameter is set.
The data array may also be set after initialisation with the
set_data
method.- source: optional
Initialize the measure, 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.
- measure:
Inspection¶
Methods
A full description of the cell measure construct. |
|
Return the canonical identity. |
|
Return all possible identities. |
Attributes
Return a description of the construct type. |
Properties¶
Methods
Remove the measure. |
|
Return the measure. |
|
Whether the measure has been set. |
|
Set the measure. |
|
Remove a property. |
|
Return a property. |
|
Whether a property has been set. |
|
Set a property. |
|
Return all properties. |
|
Remove all properties. |
|
Set properties. |
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. |
|
Data-type of the data elements. |
|
The number of dimensions in the data array. |
|
A tuple of the data array’s dimension sizes. |
|
The number of elements in the data array. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Whether two cell measure constructs 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. |
|
Whether the construct corresponds to an external netCDF variable. |
|
Set external status of a netCDF variable. |
Groups¶
Methods
Return the netCDF variable group hierarchy. |
|
Remove the netCDF variable group hierarchy. |
|
Set the netCDF variable group hierarchy. |
Special¶
Methods
Called by the |
|
Return a subspace defined by indices |
|
Called by the |
|
Called by the |