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 (cfdm): 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'
.The axes may also be set after initialisation with the
set_axes
method. Parameter example:
axes='domainaxis0'
 Parameter example:
axes=['domainaxis0']
 Parameter example:
axes=('domainaxis0', 'domainaxis1')
 Parameter example:
axes='area'
 Parameter example:
axes=['domainaxis2', 'time']
 method:
str
, optional Set the axes of the cell method construct. Either one or more domain axis construct identifiers or standard names.
The method may also be set after initialisation with the
set_method
method. Parameter example:
method='mean'
 qualifiers:
dict
, optional Set descriptive qualifiers. The dictionary keys are qualifier names, with corresponding values.
Qualifiers may also be set after initialisation with the
qualifiers
andset_qualifier
methods. Parameter example:
qualifiers={'comment': 'sampled instantaneously'}
 Parameter example:
qualifiers={'where': 'sea', ''over': 'ice'}
 source: optional
Convert source, which can be any type of object, to a
CellMethod
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
CellMethod
API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.Note that if
x
is also aCellMethod
instance thencfdm.core.CellMethod(source=x)
is equivalent tox.copy()
. copy:
bool
, optional If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.
 axes: (sequence of)
Inspection¶
Attributes
Return a description of the construct type. 
Properties¶
Methods
Remove the axes of the cell method. 

Return the axes of the cell method. 

Whether the axes of the cell method have been set. 

Set the axes of the cell method. 

Remove the method of the cell method. 

Return the method of the cell method. 

Whether the method of the cell method has been set. 

Set the method of the cell method. 

Remove a qualifier of the cell method. 

Return a qualifier of the cell method. 

Whether a qualifier of the cell method has been set. 

Set a qualifier of the cell method. 

Return all qualifiers of the cell method. 
Miscellaneous¶
Methods
Return a deep copy. 
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. 