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 (cfdm): 1.7.0
Initialisation
- Parameters
- measure:
str
, optional Set the measure that indicates the 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={'units': 'metres 2'}
- data: data_like, optional
Set the data. Ignored if the source parameter is set.
A data_like object is any object that can be converted to a
Data
object, i.e.numpy
array_like objects,Data
objects, and cfdm.core instances that containData
objects.The data also may be set after initialisation with the
set_data
method.- source: optional
Initialise the measure, properties and data from those of source.
Note that if source is a
CellMeasure
instance thencfdm.core.CellMeasure(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
- measure:
Inspection¶
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
Remove the data. |
|
Return the data. |
|
Whether or not the construct has data. |
|
Set the data. |
Attributes
Return the data. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Whether or not there are cell bounds. |
Special¶
Methods
Called by the |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Returns the substitutions that apply to methods of the class. |
|
Returns the class {{package}} substitutions package depth. |
|
Returns method names excluded in the class substitutions. |