Classes of the cf module

Field class

cf.Field A field construct according to the CF data model.

Field component classes

cf.AncillaryVariables A sequence of ancillary variable fields stored in a list-like object.
cf.CellMeasure A CF cell measure construct containing information that is needed
cf.CellMethods A CF cell methods object to describe the characteristic of a field
cf.Coordinate A CF dimension or auxiliary coordinate construct.
cf.CoordinateBounds A CF coordinate’s bounds object containing cell boundaries or
cf.Data An N-dimensional data array with units and masked values.
cf.Domain Completely describe a field’s coordinate system (domain).
cf.Flags Self-describing CF flag values.
cf.Transform A CF transform construct.
cf.Units Store, combine and compare physical units and convert numeric values to different units.

Miscellaneous classes

cf.Comparison A cmparison operation.
cf.CoordinateList An ordered sequence of coordinates stored in a list-like object.
cf.FieldList An ordered sequence of fields stored in a list-like object.

Data component classes

cf.Partition A partition of a partition matrix.
cf.PartitionMatrix A partition matrix.

Base classes

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

Inheritance diagram

The classes defined by the cf package inherit as follows:

_images/inheritance.png

This inheritance diagram shows, for example:

  • A cf.Field object and a cf.Coordinate both have all of the features of a cf.Variable object, e.g. they may have a data array and CF attributes.
  • A cf.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.
  • A cf.Domain 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.relpath

Next topic

cf.Field

This Page