Classes

Field class

Field A field construct according to the CF data model.

Field component classes

CellMeasures A CF cell measures construct containing information that is needed
CellMethods A CF cell methods object to describe the characteristic of a field
Coordinate A CF dimension or auxiliary coordinate construct.
CoordinateBounds A CF coordinate’s bounds object containing cell boundaries or
Data An N-dimensional data array with units and masked values.
Flags Self-describing CF flag values.
Space Completely describe a field’s coordinate system (space).
Transform A CF transform construct.
Units Store, combine and compare physical units and convert numeric values to different units.

Miscellaneous classes

Comparison Create an object for storing a comparison expression.
CoordinateList An ordered sequence of coordinates stored in a list-like object.
FieldList An ordered sequence of fields stored in a list-like object.

Data component classes

Partition A partition.
PartitionArray An N-dimensional partition array.
FileArray A numpy array stored on disk in a temporary file.

Base classes

CfDict A dictionary-like object with attributes.
CfList A list-like object with attributes.
Variable Base class for storing a data array with metadata.
VariableList An ordered sequence of variables stored in a list-like object.

Inheritance diagrams

The classes defined by the cf package inherit as follows.


Classes Data, Units, Flags and Variable all inherit directly from the built-in object. Classes Field, Coordinate, CoordinateBounds and CellMeasures are all sub-classes of Variable:

_images/object.png

Classes CfList, VariableList, FieldList, CoordinateList and CellMethods are list-like objects and inherit the built-in MutableSequence abstract base class:

_images/CfList.png

This inheritance diagram shows, for example, that a FieldList object is an iterable [1] which supports efficient element access using integer indices and defines a len() method that returns the length of the sequence.


Classes CfDict, Space and Transform are dictionary-like objects and inherit the built-in MutableMapping abstract base class.

_images/CfDict.png

This inheritance diagram shows, for example, that a Space object supports arbitrary, hashable key lookups and implements dictionary-like methods, such as pop().


Footnotes

[1]An object capable of returning its members one at a time.

Table Of Contents

Previous topic

cf.write

Next topic

cf.Field

This Page