cf.Domain.direction

Domain.direction(axis)

Return True if an axis is increasing, otherwise return False.

An axis is considered to be increasing if its dimension coordinate values are increasing in index space or if it has no dimension coordinate.

Parameters :

axis : str

A domain axis identifier, such as 'dim0'.

Returns :

out : bool

Whether or not the axis is increasing.

See also

directions

Examples

>>> d.dimension_sizes
{'dim0': 3, 'dim1': 1, 'dim2': 2, 'dim3': 2, 'dim4': 99}
>>> d.dimensions
{'dim0': ['dim0'],
 'dim1': ['dim1'],
 'aux0': ['dim0'],
 'aux1': ['dim2'],
 'aux2': ['dim3'],
}
>>> d['dim0'].array
array([  0  30  60])
>>> d.direction('dim0')
True
>>> d['dim1'].array
array([15])
>>> d['dim1'].bounds.array
array([  30  0])
>>> d.direction('dim1')
False
>>> d['aux1'].array
array([0, -1])
>>> d.direction('dim2')
True
>>> d['aux2'].array
array(['z' 'a'])
>>> d.direction('dim3')
True
>>> d.direction('dim4')
True