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.pk¶

pk(dataset, phc0=0.0, phc1=0.0, exptc=0.0, pivot=0.0, **kwargs)[source]¶

Linear phase correction.

For multidimensional NDDataset, the phase is by default applied on the last dimension.

Parameters

dataset (nddataset) – Input dataset.
phc0 (float or Quantity , optional, default=0 degree) – Zero order phase in degrees.
phc1 (float or Quantity , optional, default=0 degree) – First order phase in degrees.
exptc (float or Quantity , optional, default=0 us) – Exponential decay constant. If not 0, phc1 is ignored.
pivot (float or Quantity , optional, default=0 in units of the x coordinate) – Units if any must be compatible with last dimension units.

Returns

phased – Dataset.

Other Parameters

dim (str or int, keyword parameter, optional, default=’x’.) – Specify on which dimension to apply the phase. If dim is specified as an integer it is equivalent to the usual axis numpy parameter.
inv (bool, keyword parameter, optional, default=False.) – True for inverse phasing.
inplace (bool, keyword parameter, optional, default=False.) – True if we make the transform inplace. If False, the function return a new dataset.

Examples using `spectrochempy.pk`¶