cfdm.DomainAncillary¶
-
class
cfdm.
DomainAncillary
(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.mixin.netcdf.NetCDFVariable
,cfdm.mixin.propertiesdatabounds.PropertiesDataBounds
,cfdm.core.domainancillary.DomainAncillary
A domain ancillary construct of the CF data model.
A domain ancillary construct provides information which is needed for computing the location of cells in an alternative coordinate system. It is referenced by a term of a coordinate conversion formula of a coordinate reference construct. It contains a data array which depends on zero or more of the domain axes.
It also contains an optional array of cell bounds, stored in a
Bounds
object, recording the extents of each cell (only applicable if the array contains coordinate data), and properties to describe the data.An array of cell bounds spans the same domain axes as the data array, with the addition of an extra dimension whose size is that of the number of vertices of each cell.
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.- bounds:
Bounds
, optional Set the bounds array. Ignored if the source parameter is set.
The bounds array may also be set after initialisation with the
set_bounds
method.- source: optional
Initialize the properties, data and bounds 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 domain 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. |
Bounds¶
Methods
del_bounds |
Remove the bounds. |
get_bounds |
Return the bounds. |
has_bounds |
Whether or not there are bounds. |
set_bounds |
Set the bounds. |
Attributes
bounds |
Return the bounds. |
Miscellaneous¶
Methods
copy |
Return a deep copy. |
equals |
Whether two domain 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 of the construct defined by indices |
__repr__ |
Called by the repr built-in function. |
__str__ |
Called by the str built-in function. |