cf.AuxiliaryCoordinate

class cf.AuxiliaryCoordinate(properties={}, attributes={}, data=None, bounds=None, copy=True)[source]

Bases: cf.coordinate.Coordinate

A CF auxiliary coordinate construct.

Attributes

Attribute Type Description
climatology bool Whether or not the bounds are intervals of climatological time. Presumed to be False if unset.

Initialization

Parameters :
properties : dict, optional

Initialize a new instance with CF properties from a dictionary’s key/value pairs.

attributes : dict, optional

Provide the new instance with attributes from a dictionary’s key/value pairs.

data : cf.Data, optional

Provide the new instance with an N-dimensional data array.

bounds : cf.Data or cf.CoordinateBounds, optional

Provide the new instance with cell bounds.

copy : bool, optional

If False then do not copy arguments prior to initialization. By default arguments are deep copied.

AuxiliaryCoordinate CF properties

add_offset The add_offset CF property.
axis The axis 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.
positive The positive 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.

AuxiliaryCoordinate attributes

array A numpy array deep copy of the data array.
attributes A dictionary of the attributes which are not CF properties.
bounds The cf.CoordinateBounds object containing the cell bounds.
ctype The CF coordinate type.
data The cf.Data object containing the data array.
day The day of each data array element.
dtarray An independent numpy array of date-time objects.
dtvarray A numpy array view the data array converted to date-time objects.
dtype Numpy data-type of the data array.
hour The hour of each data array element.
hardmask Whether the mask is hard (True) or soft (False).
hasbounds True if and only if there are cell bounds.
isauxiliary True for auxiliary coordinate constructs, False otherwise.
isdimension True for dimension coordinate constructs, False otherwise.
isscalar True if and only if the data array is a scalar array.
lower_bounds The lower coordinate bounds in a cf.Data object.
mask A variable containing the mask of the data array.
minute The minute of each data array element.
month The month of each data array element.
ndim Number of dimensions in the data array.
properties A dictionary of the CF properties.
second The second of each data array element.
shape Tuple of the data array’s dimension sizes.
size Number of elements in the data array.
subspace Return a new coordinate whose data and bounds are subspaced in a consistent manner.
T True if and only if the coordinate is a CF T axis coordinate.
unique The unique elements of the array.
Units The Units object containing the units of the data array.
upper_bounds The upper dimension coordinate bounds in a cf.Data object.
varray A numpy array view of the data array.
X True if and only if the coordinate is a CF X axis coordinate.
Y True if and only if the coordinate is a CF Y axis coordinate.
year The year of each data array element.
Z True if and only if the coordinate is a CF Z axis coordinate.

AuxiliaryCoordinate methods

asauxiliary Return the auxiliary coordinate.
asdatetime Change the internal representation of data array elements from numeric reference times to datatime-like objects.
asdimension Return the coordinate recast as a dimension coordinate.
asreftime Change the internal representation of data array elements from datatime-like objects to numeric reference times.
binary_mask Return a binary (0 and 1) missing data mask of the data array.
chunk Partition the data array.
clip Clip (limit) the values in the data array and its bounds in place.
close Close all files referenced by the coordinate.
contiguous Return True if a coordinate is contiguous.
copy Return a deep copy.
cos Take the trigonometric cosine of the data array and bounds in place.
datum Return an element of the data array as a standard Python scalar.
delattr Delete a named attribute.
delprop Delete a CF property.
dump Return a string containing a full description of the coordinate.
equals True if two variables are logically equal, False otherwise.
expand_dims Insert a size 1 axis into the data array and bounds in place.
fill_value Return the data array missing data value.
flip Flip dimensions of the data array and bounds in place.
getattr Get a named attribute.
getprop Get a CF property.
hasattr Return whether an attribute exists.
hasprop Return True if a CF property exists, otherise False.
identity Return the variable’s identity.
insert_bounds Insert cell bounds into the coordinate in-place.
insert_data Insert a new data array into the coordinate in place.
mask_invalid Mask the array where invalid values occur (NaNs or infs).
match Determine whether or not a variable satisfies conditions.
name Return a name for the variable.
override_units
select Return the instance if it matches the given conditions.
setattr Set a named attribute.
setdata Set data array elements depending on a condition.
setprop Set a CF property.
sin Take the trigonometric sine of the data array and bounds in place.
squeeze Remove size 1 dimensions from the data array and bounds in place.
transpose Permute the dimensions of the data array and bounds in place.

Table Of Contents

Previous topic

cf.AncillaryVariables.unsqueeze

Next topic

cf.AuxiliaryCoordinate.add_offset

This Page