cf.Variable

class cf.Variable(properties={}, data=None, attributes={})

Bases: object

Base class for storing a data array with metadata.

A variable contains a data array and metadata comprising properties to describe the physical nature of the data.

All components of a variable 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.

data : cf.Data, optional

Provide the new instance with an N-dimensional data array. The array is deep copied.

attributes : dict, optional

Provide the new instance with attributes from the dictionary’s key/value pairs. Values are deep copied.

Variable CF Properties

add_offset	The add_offset CF property.
calendar	The calendar CF property.
comment	The comment CF property.
_FillValue	The _FillValue CF property.
history	The history 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.
scale_factor	The scale_factor CF property.
standard_name	The standard_name 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.

Variable 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	A variable containing 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.

Variable attributes

id	A definitive identity for the variable.
properties	A dictionary of the CF properties.
subspace	Return a new variable whose data is subspaced.

Variable methods

binary_mask	Return a binary missing data mask of the data array.
chunk	Partition the data array using Large Amounts of Massive Arrays (LAMA)
clip	Clip (limit) the values in the data array in place.
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 variables are logically equal, False otherwise.
expand_dims	Parameters:
flip	Flip dimensions of the data array in place.
getprop	Get a CF property.
hasprop	Return True if the variable has a CF property.
identity	Return the variable’s identity.
insert_data	Insert a new data array into the variable in place.
match	Determine whether or not a variable satisfies conditions.
name	Return a name for the variable.
override_units	Override the data array units in place.
select	Return the instance if it matches the given conditions.
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 data array in place.
transpose	Permute the dimensions of the data array in place.