cfdm.core.DomainAncillary


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

Bases: cfdm.core.abstract.propertiesdatabounds.PropertiesDataBounds

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.

New in version (cfdm): 1.7.0

Initialisation

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 and set_property methods.

Parameter example:

properties={'standard_name': 'longitude'}

data: data_like, optional

Set the data. Ignored if the source parameter is set.

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.core 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. Ignored if the source parameter is set.

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

geometry: str, optional

Set the geometry type. Ignored if the source parameter is set.

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. Ignored if the source parameter is set.

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

source: optional

Initialise the properties, geometry type, data, bounds and interior ring from those of source.

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

copy: bool, optional

If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.

Inspection

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 or not the construct has data.

set_data

Set the data.

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.

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.

Attributes

interior_ring

Return the interior ring variable for polygon geometries.

Miscellaneous

Methods

copy

Return a deep copy.

Special

Methods

__deepcopy__

Called by the copy.deepcopy 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.