cfdm.core.CellMeasure¶
-
class
cfdm.core.
CellMeasure
(measure=None, properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.core.abstract.propertiesdata.PropertiesData
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.
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.
- Parameter example:
measure='area'
The measure may also be set after initialisation with the
set_measure
method.- properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
- Parameter example:
properties={'units': 'metres 2'}
Properties may also be set after initialisation with the
set_properties
andset_property
methods.- data:
Data
, optional Set the data array. Ignored if the source parameter is set.
The data array also may be set after initialisation with the
set_data
method.- source: optional
Initialise the measure, properties and data parameters (if present) from source, which will be a
CellMeasure
object, or a subclass of one of its parent classes.- Parameter example:
>>> d = CellMeasure(source=c)
- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization By default parameters are deep copied.
Examples:
>>> c = CellMeasure(measure='area' ... properties={'units': 'km 2'}, ... data=d)
- measure:
Properties¶
Methods
del_measure |
Remove the measure. |
get_measure |
Return the measure. |
has_measure |
Whether the measure has been set. |
set_measure |
Set the measure. |
del_property |
Remove a property. |
get_property |
Return a property. |
has_property |
Whether a property has been set. |
set_property |
Set a property. |
properties |
Return all properties. |
clear_properties |
Remove all properties. |
set_properties |
Set properties. |