cf.FieldAncillary

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

Bases: cf.variable.Variable

A CF field ancillary construct.

Initialization

Parameters:
properties: dict, optional

Initialize CF properties from the dictionary’s key/value pairs.

attributes: dict, optional

Provide attributes from the dictionary’s key/value pairs.

data: cf.Data, optional

Provide a data array.

source: cf.{+Variable}, optional

Take the attributes, CF properties and data array from the source {+variable}. Any attributes, CF properties or data array specified with other parameters are set after initialisation from the source {+variable}.

copy: bool, optional

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

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.

Attributes

Data The cf.Data object containing the data array.
T Always False.
Units The cf.Units object containing the units of the data array.
X Always False.
Y Always False.
Z Always False.
add_offset The add_offset CF property.
array A numpy array deep copy of the data array.
binary_mask A binary (0 and 1) missing data mask of the data array.
calendar The calendar CF property.
comment The comment CF property.
data The cf.Data object containing the data array.
day The day of each date-time 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 The numpy data type of the data array.
hardmask Whether the mask is hard (True) or soft (False).
hasbounds True if there are cell bounds.
hasdata True if there is a data array.
history The history CF property.
hour The hour of each date-time data array element.
isauxiliary True if the variable is an auxiliary coordinate object.
isdimension True if the variable is a dimension coordinate object.
isdomainancillary True if the variable is a domain ancillary object.
isfieldancillary True, denoting that the variable is a field ancillary object.
ismeasure True if the variable is a cell measure object.
isscalar True if the data array is scalar.
leap_month The leap_month CF property.
leap_year The leap_year CF property.
long_name The long_name CF property.
mask The mask of the data array.
minute The minute of each date-time data array element.
missing_value The missing_value CF property.
month The month of each date-time data array element.
month_lengths The month_lengths CF property.
ndim The number of dimensions in the data array.
reference_datetime
scale_factor The scale_factor CF property.
second The second of each date-time data array element.
shape A tuple of the data array’s dimension sizes.
size The number of elements in the data array.
standard_name The standard_name CF property.
subspace Return a new variable whose data is subspaced.
units The units CF property.
unsafe_array
valid_max The valid_max CF property.
valid_min The valid_min CF property.
valid_range The valid_range CF property.
varray A numpy array view of the data array.
year The year of each date-time data array element.

Methods

HDF_chunks Specify HDF5 chunks for the data array.
all Test whether all data array elements evaluate to True.
allclose Returns True if two broadcastable field ancillarys have equal array values to within numerical tolerance.
any Return True if any data array elements evaluate to True.
asdatetime Convert the internal representation of data array elements to date-time objects.
asreftime Convert the internal representation of data array elements to numeric reference times.
attributes Inspect or change attributes which are not CF properties.
ceil The ceiling of the data array.
chunk Partition the data array.
clip Clip (limit) the values in the data array in place.
close Close all files referenced by the variable.
concatenate Join a sequence of variables together.
convert_reference_time Convert reference time data values to have new units.
copy Return a deep copy.
cos Take the trigonometric cosine of the data array.
count Emulate
cyclic Set the cyclicity of axes of the data array.
datum Return an element of the data array as a standard Python scalar.
delprop Delete a CF property.
dump Return a string containing a full description of the field ancillary object.
equals True if two field ancillarys are equal, False otherwise.
equivalent True if two field ancillarys are equal, False otherwise.
exp The exponential of the data array.
expand_dims Insert a size 1 axis into the data array.
files Return the names of any files containing parts of the data array.
fill_value Return the data array missing data value.
flip Flip dimensions of the data array in place.
floor Floor the data array.
getprop Get a CF property.
hasprop Return True if a CF property exists, otherise False.
identity Return the identity of the field ancillary.
insert_data Insert a new data array into the variable in place.
inspect Inspect the object for debugging.
log The logarithm of the data array.
mask_invalid Mask the array where invalid values occur.
match Determine whether or not a variable satisfies conditions.
max The maximum of the data array.
mean The unweighted mean the data array.
mid_range The unweighted average of the maximum and minimum of the data array.
min The minimum of the data array.
name Return a name for the field ancillary.
override_calendar Override the calendar of date-time units.
override_units Override the units.
properties Inspect or change the CF properties.
range The absolute difference between the maximum and minimum of the data array.
remove_data Remove and return the data array.
rint Round data array.
roll Roll the field ancillary along an axis.
round Round the data array.
sample_size The number of non-missing data elements in the data array.
sd The unweighted sample standard deviation of the data array.
select cf.FieldAncillary.select has been deprecated.
setprop Set a CF property.
sin The trigonometric sine of the data array.
squeeze Remove size 1 dimensions from the data array in place.
sum The sum of the data array.
tan The trigonometric tangent of the data array.
transpose Permute the dimensions of the data array.
trunc Truncate the data array.
unique The unique elements of the data array.
var The unweighted sample variance of the data array.
where Set data array elements depending on a condition.