cf.Data.cyclic¶

Data.
cyclic
(axes=None, iscyclic=True)[source]¶ Get or set the cyclic axes.
Some methods treat the first and last elements of a cyclic axis as adjacent and physically connected, such as
convolution_filter
,__getitem__
and__setitem__
. Some methods may make a cyclic axis noncyclic, such ashalo
. Parameters
 Returns
set
The cyclic axes prior to the change, or the current cyclic axes if no axes are specified.
Examples
>>> d = cf.Data(np.arange(12).reshape(3, 4)) >>> d.cyclic() set() >>> d.cyclic(0) set() >>> d.cyclic() {0} >>> d.cyclic(0, iscyclic=False) {0} >>> d.cyclic() set() >>> d.cyclic([0, 1]) set() >>> d.cyclic() {0, 1} >>> d.cyclic([0, 1], iscyclic=False) {0, 1} >>> d.cyclic() set()
>>> print(d.array) [[ 0 1 2 3] [ 4 5 6 7] [ 8 9 10 11]] >>> d[0, 1:2] Traceback (most recent call last): ... IndexError: Can't take a cyclic slice of a noncyclic axis >>> d.cyclic(1) set() >>> d[0, 1:2] <CF Data(1, 2): [[3, 0, 1]]>