cf.AuxiliaryCoordinate.contiguous¶
-
AuxiliaryCoordinate.
contiguous
(overlap=True)[source]¶ Return True if a coordinate is contiguous.
A coordinate is contiguous if its cell boundaries match up, or overlap, with the boundaries of adjacent cells.
In general, it is only possible for 1 or 0 dimensional coordinates with bounds to be contiguous, but size 1 coordinates with any number of dimensions are always contiguous.
An exception occurs if the coordinate is multdimensional and has more than one element.
Parameters: - overlap:
bool
, optional If False then overlapping cell boundaries are not considered contiguous. By default cell boundaries are considered contiguous.
Returns: - out:
bool
Whether or not the coordinate is contiguous.
Raises: - ValueError :
If the coordinate has more than one dimension.
Examples: >>> c.hasbounds False >>> c.contiguous() False
>>> print c.bounds[:, 0] [ 0.5 1.5 2.5 3.5 ] >>> print c.bounds[:, 1] [ 1.5 2.5 3.5 4.5 ] >>> c.contiuous() True
>>> print c.bounds[:, 0] [ 0.5 1.5 2.5 3.5 ] >>> print c.bounds[:, 1] [ 2.5 3.5 4.5 5.5 ] >>> c.contiuous() True >>> c.contiuous(overlap=False) False
- overlap: