# cf.CellMethod¶

class cf.CellMethod(axes=None, method=None, qualifiers=None, source=None, copy=True)[source]

Bases: cfdm.cellmethod.CellMethod

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).

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. Ignored if the source parameter is set. 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 qualifer names, with corresponding values. Ignored if the source parameter is set. Qualifiers may also be set after initialisation with the qualifiers and set_qualifier methods. Parameter example: qualifiers={'comment': 'sampled instantaneously'} Parameter example: qualifiers={'where': 'sea', ''over': 'ice'} 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.

## Inspection¶

Methods

 dump A full description of the cell method construct. identity Return the canonical identity for the cell method construct. identities Return all possible identities.

Attributes

 construct_type Return a description of the construct type.

## Qualifiers¶

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.

Attributes

 axes TODO comment The cell method’s comment qualifier. cf.CellMethod.interval intervals The cell method’s interval qualifier(s). method The cell method’s method qualifier. over The cell method’s over qualifier. where The cell method’s where qualifier. within The cell method’s within qualifier.

## Miscellaneous¶

Methods

 copy Return a deep copy. change_axes TODO create Parse a CF-like cell_methods string. equals Whether two cell method constructs are the same. equivalent True if two cell methods are equivalent, False otherwise. expand_intervals TODO inspect Inspect the attributes. sorted Return a new cell method construct with sorted axes. write Return a string of the cell method.

## Special¶

Methods

 __deepcopy__ Called by the copy.deepcopy function. __repr__ Called by the repr built-in function. __str__ Called by the str built-in function.