cfdm.core.DomainAncillary.get_bounds

DomainAncillary.get_bounds(default=ValueError())[source]

Return the bounds.

New in version (cfdm): 1.7.0

See also

bounds, get_data, del_bounds, has_bounds, set_bounds

Parameters
default: optional

Return the value of the default parameter if bounds have not been set.

If set to an Exception instance then it will be raised instead.

Returns
Bounds

The bounds.

Examples

>>> c = cfdm.core.DomainAncillary()
>>> b = cfdm.core.Bounds(data=cfdm.core.Data(numpy.arange(10).reshape(5, 2)))
>>> c.set_bounds(b)
>>> c.has_bounds()
True
>>> c.get_bounds()
<Bounds: (5, 2) >
>>> b = c.del_bounds()
>>> b
<Bounds: (5, 2) >
>>> c.has_bounds()
False
>>> print(c.get_bounds(None))
None
>>> print(c.del_bounds(None))
None