cf.Field

class cf.Field(properties={})

Bases: cf.variable.Variable

A field construct according to the CF data model.

A field is a container for a data array and metadata comprising properties to describe the physical nature of the data and a coordinate system (called a space) which describes the positions of each element of the data array.

It is structured in exactly the same way as a field construct defined by the CF data model.

The field’s space may contain coordinates and cell measures (which themselves contain data arrays and properties to describe them) and transforms to describe how other auxiliary coordinates may be computed.

As in the CF data model, all components of a field are optional.

Initialization

Parameters :

properties : dict, optional

Initialize a new instance with CF properties from the dictionary’s key/value pairs. Values are deep copied.

CF Properties

add_offset	The add_offset CF property.
calendar	The calendar CF property.
cell_methods	The CellMethods object containing the CF cell methods of the data array.
comment	The comment CF property.
Conventions	The Conventions CF property.
_FillValue	The _FillValue CF property.
flag_masks	The flag_masks CF property.
flag_meanings	The flag_meanings CF property.
flag_values	The flag_values CF property.
history	The history CF property.
institution	The institution CF property.
leap_month	The leap_month CF property.
leap_year	The leap_year CF property.
long_name	The long_name CF property.
missing_value	The missing_value CF property.
month_lengths	The month_lengths CF property.
references	The references CF property.
scale_factor	The scale_factor CF property.
source	The source CF property.
standard_error_multiplier	The standard_error_multiplier CF property.
standard_name	The standard_name CF property.
title	The title CF property.
units	The units CF property.
valid_max	The valid_max CF property.
valid_min	The valid_min CF property.
valid_range	The valid_range CF property.

Data attributes

array	A numpy array deep copy of the data array.
Data	The Data object containing the data array.
dtype	The numpy data type of the data array.
_FillValue	The _FillValue CF property.
first_datum	The first element of the data array.
hardmask	Whether the mask is hard (True) or soft (False).
isscalar	True if and only if the data array is a scalar array.
last_datum	The last element of the data array.
mask	The mask of the data array.
ndim	Number of dimensions in the data array.
shape	Tuple of the data array’s dimension sizes.
size	Number of elements in the data array.
Units	The Units object containing the units of the data array.
varray	A numpy array view of the data array.

Other attributes

ancillary_variables	An AncillaryVariables object containing CF ancillary data.
Flags	A Flags object containing self-describing CF flag values.
hasData	True if and only if there is a data array.
properties	A dictionary of the CF properties.
space	The Space object containing the coordinate system (space).

Methods

binary_mask	Return a binary missing data mask of the data array.
chunk	Partition the field in place for LAMA functionality.
clip	Clip (limit) the values in the data array in place.
coord	Return a coordinate of the field.
copy	Return a deep copy.
cos	Take the trigonometric cosine of the data array in place.
delprop	Delete a CF property.
dump	Return a string containing a full description of the instance.
equals	True if two fields are logically equal, False otherwise.
expand_dims	Expand the shape of the data array in place.
flip	Flip dimensions of the data array and space in place.
getprop	Get a CF property.
finalize	Finalize a newly created field.
hasprop	Return True if the variable has a CF property.
identity	Return the variable’s identity.
indices	Return the indices to the data array which correspond to coordinate values.
match	Determine whether or not a field satisfies conditions.
name	Return a name for the variable.
override_units	Override the data array units in place.
setitem	Set selected elements of the data array in place.
setmask	Set selected elements of the data array’s mask in place.
setprop	Set a CF property.
sin	Take the trigonometric sine of the data in place.
squeeze	Remove size 1 dimensions from the field’s data array in place.
subset	Return the instance if it matches the given conditions.
subspace	Return a new field whose data and space are subspaced.
transpose	Permute the dimensions of the data array in place.
unsqueeze	Insert size 1 dimensions from the field’s space into its data array in place.