cfdm.core.Field¶

class
cfdm.core.
Field
(properties=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.core.mixin.fielddomain.FieldDomain
,cfdm.core.abstract.propertiesdata.PropertiesData
A field construct of the CF data model.
The field construct is central to the CF data model, and includes all the other constructs. A field corresponds to a CFnetCDF data variable with all of its metadata. All CFnetCDF elements are mapped to a field construct or some element of the CF field construct. The field construct contains all the data and metadata which can be extracted from the file using the CF conventions.
The field construct consists of a data array and the definition of its domain (that describes the locations of each cell of the data array), field ancillary constructs containing metadata defined over the same domain, and cell method constructs to describe how the cell values represent the variation of the physical quantity within the cells of the domain. The domain is defined collectively by the following constructs of the CF data model: domain axis, dimension coordinate, auxiliary coordinate, cell measure, coordinate reference and domain ancillary constructs. All of the constructs contained by the field construct are optional.
The field construct also has optional properties to describe aspects of the data that are independent of the domain. These correspond to some netCDF attributes of variables (e.g. units, long_name and standard_name), and some netCDF global file attributes (e.g. history and institution).
New in version (cfdm): 1.7.0
Initialisation
 Parameters
 properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
Properties may also be set after initialisation with the
set_properties
andset_property
methods. Parameter example:
properties={'standard_name': 'air_temperature'}
 source: optional
Initialise the properties, data and metadata constructs from those of source.
Note that if source is a
Field
instance thencfdm.core.Field(source=source)
is equivalent tosource.copy()
. copy:
bool
, optional If True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
 properties:
Inspection¶
Attributes
Return a description of the construct type. 
Properties¶
Methods
Remove a property. 

Return a property. 

Whether a property has been set. 

Set a property. 

Return all properties. 

Remove all properties. 

Set properties. 
Data¶
Methods
Remove the data. 

Return the data. 

Whether or not the construct has data. 

Set the data of the field construct. 

Removes the keys of the axes spanned by the construct data. 

Gets the keys of the axes spanned by the construct data. 

Whether the axes spanned by the construct data have been set. 

Sets the axes spanned by the construct data. 
Attributes
Return the data. 
Metadata constructs¶
Methods
Remove a metadata construct. 

Return a metadata construct. 

Whether a metadata construct exists. 

Set a metadata construct. 

Removes the keys of the axes spanned by the construct data. 

Gets the keys of the axes spanned by the construct data. 

Whether the axes spanned by the construct data have been set. 

Sets the axes spanned by the construct data. 
Attributes
Return the metadata constructs. 
Domain¶
Methods
Return the domain. 
Attributes
Return the domain. 
Miscellaneous¶
Methods
Return a deep copy. 

Whether or not there are cell bounds. 
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. 