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.triang

triang()def triang(dataset, **kwargs)

Calculate triangular apodization with non-null extremities and maximum value normalized to 1.

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

The data in the last dimension MUST be time-domain or dimensionless, otherwise an error is raised.

Parameters

• dataset (array) – Input dataset.

• **kwargs – Optional keyword parameters (see Other Parameters).

Returns

• apodized – Dataset.

• apod_arr – The apodization array only if ‘retapod’ is True.

Other Parameters

• dim (str or int, keyword parameter, optional, default=’x’.) – Specify on which dimension to apply the apodization method. 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 apodization.

• rev (bool, keyword parameter, optional, default=False.) – True to reverse the apodization before applying it to the data.

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

• retapod (bool, keyword parameter, optional, default=False) – True to return the apodization array along with the apodized object

See also

gm, sp, sine, sinm, qsin, hamming, bartlett, blackmanharris