Warning

You are reading the documentation related to the development version. Go here if you are looking for the documentation of the stable release.

spectrochempy.cs

cs(dataset, pts=0.0, neg=False, **kwargs)[source]

Circular shift.

For multidimensional NDDataset, the shift is by default performed on the last dimension.

Parameters

  • dataset (nddataset) – NDDataset to be shifted.

  • pts (int) – Number of points toshift.

  • neg (bool) – True to negate the shifted points.

Returns

dataset – Dataset shifted.

Other Parameters

  • dim (str or int, keyword parameter, optional, default=’x’) – Specify on which dimension to apply the shift method. If dim is specified as an integer it is equivalent to the usual axis numpy parameter.

  • inplace (bool, keyword parameter, optional, default=False) – True if we make the transform inplace. If False, the function return a new dataset.

See also

roll

shift without zero filling.