cfdm.DimensionCoordinate.get_interior_ring

DimensionCoordinate.get_interior_ring(default=ValueError())[source]

Return the interior ring variable for polygon geometries.

f.get_interior_ring() is equivalent to f.interior_ring

New in version (cfdm): 1.8.0

See also

data, del_interior_ring, has_interior_ring, interior_ring, set_interior_ring

Parameters
default: optional

Return the value of the default parameter if interior ring data have not been set.

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

Returns
InteriorRing

The interior ring variable.

Examples

>>> c = cfdm.DimensionCoordinate()
>>> i = cfdm.InteriorRing(data=cfdm.Data(numpy.arange(10).reshape(5, 2)))
>>> c.set_interior_ring(i)
>>> c.has_interior_ring()
True
>>> i = c.get_interior_ring()
>>> i
<InteriorRing: (5, 2) >
>>> i.data
<Data(5, 2): [[0, ..., 9]]>
>>> i.data.shape
(5, 2)
>>> c.del_interior_ring()
<InteriorRing: (5, 2) >
>>> c.has_interior_ring()
False
>>> print(c.del_interior_ring(None))
None