cfdm.FieldAncillary¶
-
class
cfdm.
FieldAncillary
(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.mixin.netcdf.NetCDFVariable
,cfdm.mixin.propertiesdata.PropertiesData
,cfdm.core.fieldancillary.FieldAncillary
A field ancillary construct of the CF data model.
The field ancillary construct provides metadata which are distributed over the same sampling domain as the field itself. For example, if a data variable holds a variable retrieved from a satellite instrument, a related ancillary data variable might provide the uncertainty estimates for those retrievals (varying over the same spatiotemporal domain).
The field ancillary construct consists of an array of the ancillary data, which is zero-dimensional or which depends on one or more of the domain axes, and properties to describe the data. It is assumed that the data do not depend on axes of the domain which are not spanned by the array, along which the values are implicitly propagated. CF-netCDF ancillary data variables correspond to field ancillary constructs. Note that a field ancillary construct is constrained by the domain definition of the parent field construct but does not contribute to the domain’s definition, unlike, for instance, an auxiliary coordinate construct or domain ancillary construct.
NetCDF interface
The netCDF variable name of the construct may be accessed with the
nc_set_variable
,nc_get_variable
,nc_del_variable
andnc_has_variable
methods.New in version 1.7.0.
Initialization
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': 'altitude'}
- data:
Data
, optional Set the data array. Ignored if the source parameter is set.
The data array may also be set after initialisation with the
set_data
method.- source: optional
Initialize the properties and data from those of source.
- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.
- properties:
Inspection¶
Methods
dump |
A full description of the field ancillary construct. |
identity |
Return the canonical identity. |
identities |
Return all possible identities. |
Attributes
construct_type |
Return a description of the construct type. |
Properties¶
Methods
del_property |
Remove a property. |
get_property |
Return a property. |
has_property |
Whether a property has been set. |
set_property |
Set a property. |
properties |
Return all properties. |
clear_properties |
Remove all properties. |
set_properties |
Set properties. |
Data¶
Methods
del_data |
Remove the data. |
get_data |
Return the data. |
has_data |
Whether a data has been set. |
set_data |
Set the data. |
insert_dimension |
Expand the shape of the data array. |
squeeze |
Remove size one axes from the data array. |
transpose |
Permute the axes of the data array. |
Attributes
data |
Return the data. |
Miscellaneous¶
Methods
copy |
Return a deep copy. |
equals |
Whether two field ancillary constructs are the same. |
uncompress |
Uncompress the construct. |
NetCDF¶
Methods
nc_del_variable |
Remove the netCDF variable name. |
nc_get_variable |
Return the netCDF variable name. |
nc_has_variable |
Whether the netCDF variable name has been set. |
nc_set_variable |
Set the netCDF variable name. |
Special¶
Methods
__deepcopy__ |
Called by the copy.deepcopy function. |
__getitem__ |
Return a subspace defined by indices |
__repr__ |
Called by the repr built-in function. |
__str__ |
Called by the str built-in function. |