cfdm.DomainAncillary

---

class cfdm.DomainAncillary(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)

Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdatabounds.PropertiesDataBounds, cfdm.mixin.files.Files, 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 may be accessed with the nc_set_variable, nc_get_variable, nc_del_variable, and nc_has_variable methods.

The netCDF variable group structure may be accessed with the nc_set_variable, nc_get_variable, nc_variable_groups, nc_clear_variable_groups, and nc_set_variable_groups methods.

New in version (cfdm): 1.7.0

Initialisation

Parameters

properties: dict, optional

Set descriptive properties. The dictionary keys are property names, with corresponding values.

Properties may also be set after initialisation with the set_properties and set_property methods.

Parameter example:

properties={'standard_name': 'altitude'}

data: data_like, optional

Set the data.

A data_like object is any object that can be converted to a Data object, i.e. numpy array_like objects, Data objects, and cfdm instances that contain Data objects.

The data also may be set after initialisation with the set_data method.

bounds: Bounds, optional

Set the bounds array.

The bounds array may also be set after initialisation with the set_bounds method.

geometry: str, optional

Set the geometry type.

The geometry type may also be set after initialisation with the set_geometry method.

Parameter example:

geometry='polygon'

interior_ring: InteriorRing, optional

Set the interior ring variable.

The interior ring variable may also be set after initialisation with the set_interior_ring method.

source: optional

Convert source, which can be any type of object, to a DomainAncillary instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the DomainAncillary API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a DomainAncillary instance then cfdm.DomainAncillary(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

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.
del_properties	Remove properties.
set_properties	Set properties.

Data

Methods

apply_masking	Apply masking as defined by the CF conventions.
del_data	Remove the data.
get_data	Return the data.
has_data	Whether or not the construct has data.
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

array	A numpy array deep copy of the data.
data	Return the data.
datetime_array	An independent numpy array of date-time objects.
dtype	Data-type of the data elements.
ndim	The number of data dimensions.
shape	A tuple of the data array’s dimension sizes.
size	The number of elements in 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.
get_bounds_data	Return the bounds data.

Attributes

bounds

Return the bounds.

Geometries

Methods

del_geometry	Remove the geometry type.
get_geometry	Return the geometry type.
has_geometry	True if there is a geometry type.
set_geometry	Set the geometry type.
del_interior_ring	Remove the geometry type.
get_interior_ring	Return the interior ring variable for polygon geometries.
has_interior_ring	Whether or not there is an interior ring variable.
set_interior_ring	Set the interior_ring.
del_node_count	Remove the node count variable for geometry bounds.
get_node_count	Return the node count variable for geometry bounds.
has_node_count	Whether geometry bounds have a node count variable.
set_node_count	Set the node count variable for geometry bounds.
del_part_node_count	Remove the part node count variable for geometry bounds.
get_part_node_count	Return the part node count variable for geometry bounds.
has_part_node_count	Whether geometry bounds have a part node count variable.
set_part_node_count	Set the part node count variable for geometry bounds.

Attributes

interior_ring

Return the interior ring variable for polygon geometries.

Miscellaneous

Methods

copy	Return a deep copy.
creation_commands	Return the commands that would create the construct.
equals	Whether two instances are the same.
uncompress	Uncompress the construct.
get_filenames	Return the name of the file or files containing the data.
get_original_filenames	The names of files containing the original data and metadata.
to_memory	Bring data on disk into memory.

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.

Groups

Methods

nc_variable_groups	Return the netCDF variable group hierarchy.
nc_clear_variable_groups	Remove the netCDF variable group hierarchy.
nc_set_variable_groups	Set the netCDF variable group hierarchy.

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.

Docstring substitutions

Methods

_docstring_special_substitutions	Return the special docstring substitutions.
_docstring_substitutions	Returns the substitutions that apply to methods of the class.
_docstring_package_depth	Returns the class {{package}} substitutions package depth.
_docstring_method_exclusions	Returns method names excluded in the class substitutions.