cf.Bounds.contiguous¶

Bounds.
contiguous
(overlap=True, direction=None, period=None, verbose=1)[source]¶ Return True if the bounds are contiguous.
Bounds are contiguous if the cell boundaries match up, or overlap, with the boundaries of adjacent cells.
In general, it is only possible for 1 or 0 variable dimensional variables with bounds to be contiguous, but size 1 variables with any number of dimensions are always contiguous.
An exception is raised if the variable is multidimensional and has more than one element.
New in version 2.0.
 Parameters
 overlap:
bool
, optional If False then 1d cells with two bounds vertices are not considered contiguous if any adjacent cells overlap each other. By default such cells are considered contiguous.
 direction:
Specify the direction of 1d coordinates with two bounds vertices. Either True for increasing coordinates, or False for decreasing coordinates. By default the direction is inferred from whether the first bound of the first cell is less than its second bound (direction is True), or not (direction is False).
 period: optional
Define the period of cyclic values so that the test for contiguousness can be carried out with modulo arithmetic. By default the data are assumed to be noncyclic, unless the bounds have units of longitude (or have units of
'degrees'
), in which case a period of 360 degrees is assumed. verbose:
int
orstr
orNone
, optional If an integer from
1
to3
, or an equivalent string equal ignoring case to one of:'DISABLE'
(0
)'WARNING'
(1
)'INFO'
(2
)'DETAIL'
(3
)'DEBUG'
(1
)
set for the duration of the method call only as the minimum cutoff for the verboseness level of displayed output (log) messages, regardless of the globallyconfigured
cf.log_level
. Note that increasing numerical value corresponds to increasing verbosity, with the exception of1
as a special case of maximal and extreme verbosity.Otherwise, if
None
(the default value), output messages will be shown according to the value of thecf.log_level
setting.Overall, the higher a nonnegative integer or equivalent string that is set (up to a maximum of
3
/'DETAIL'
) for increasing verbosity, the more description that is printed to convey information about the test for contiguity.
 Returns
bool
Whether or not the cells are contiguous.
Examples:
TODO
 overlap: