cfdm.core.Bounds

---

class cfdm.core.Bounds(properties=None, data=None, source=None, copy=True, _use_data=True)

Bases: cfdm.core.abstract.propertiesdata.PropertiesData

A cell bounds component.

That is, a cell bounds component of a coordinate or domain ancillary construct of the CF data model.

An array of cell bounds spans the same domain axes as its coordinate array, with the addition of an extra dimension whose size is that of the number of vertices of each cell. This extra dimension does not correspond to a domain axis construct since it does not relate to an independent axis of the domain. Note that, for climatological time axes, the bounds are interpreted in a special way indicated by the cell method constructs.

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.

source: optional

Initialise the properties and data from those of source. respectively.

Note that if source is a Bounds instance then cfdm.core.Bounds(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.

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.

Miscellaneous

Methods

copy	Return a deep copy.
has_bounds	Whether or not there are cell bounds.

Special

Methods

__deepcopy__

Called by the copy.deepcopy function.

Docstring substitutions

Methods

cfdm.core.Bounds_special_substitutions
cfdm.core.Bounds_substitutions
cfdm.core.Bounds_package_depth
cfdm.core.Bounds_method_exclusions