cfdm.core.CellMethod¶
-
class
cfdm.core.
CellMethod
(axes=None, method=None, qualifiers=None, source=None, copy=True)[source]¶ Bases:
cfdm.core.abstract.container.Container
A cell method construct of the CF data model.
One or more cell method constructs describe how the cell values of the field construct represent the variation of the physical quantity within its cells, i.e. the structure of the data at a higher resolution.
A single cell method construct consists of a set of axes, a “method” property which describes how a value of the field construct’s data array describes the variation of the quantity within a cell over those axes (e.g. a value might represent the cell area average), and descriptive qualifiers serving to indicate more precisely how the method was applied (e.g. recording the spacing of the original data, or the fact that the method was applied only over El Nino years).
New in version 1.7.0.
Initialisation
Parameters: - axes: (sequence of)
str
, optional Set the axes of the cell method construct, specified either by the construct identifiers of domain axis constructs, standard names, or the special string
'area'
.- Parameter example:
axes='domainaxis0'
- Parameter example:
axes=['domainaxis0']
- Parameter example:
axes=('domainaxis0', 'domainaxis1')
- Parameter example:
axes='area'
- Parameter example:
axes=['domainaxis2', 'time']
The axes may also be set after initialisation with the
set_axes
method.- method:
str
, optional Set the axes of the cell method construct. Either one or more domain axis construct identifiers or standard names. Ignored if the source parameter is set.
- Parameter example:
``method=’mean’
The method may also be set after initialisation with the
set_method
method.- qualifiers:
dict
, optional Set descriptive qualifiers. The dictionary keys are qualifer names, with corresponding values. Ignored if the source parameter is set.
- Parameter example:
qualifiers={'comment': 'sampled instantaneously'}
- Parameter example:
qualifiers={'where': 'sea', ''over': 'ice'}
Qualifiers may also be set after initialisation with the
qualifiers
andset_qualifier
methods.- source: optional
Initialize the axes, method and qualifiers from those of source.
- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization By default parameters are deep copied.
- axes: (sequence of)
Properties¶
Methods
del_axes |
Remove the axes of the cell method. |
get_axes |
Return the axes of the cell method. |
has_axes |
Whether the axes of the cell method have been set. |
set_axes |
Set the axes of the cell method. |
del_method |
Remove the method of the cell method. |
get_method |
Return the method of the cell method. |
has_method |
Whether the method of the cell method has been set. |
set_method |
Set the method of the cell method. |
del_qualifier |
Remove a qualifier of the cell method. |
get_qualifier |
Return a qualifier of the cell method. |
has_qualifier |
Whether a qualifier of the cell method has been set. |
set_qualifier |
Set a qualifier of the cell method. |
qualifiers |
Return all qualifiers of the cell method. |