aim2dat.fct.smearing

Module to implement different smearing methods.

Module Contents

Functions

apply_smearing(→ numpy.array)

Apply smearing to a dataset. Different smearing methods can be specified.

Attributes

AVAILABLE_SMEARING_METHODS

aim2dat.fct.smearing.apply_smearing(y: numpy.array, sampling_width: float = 1.0, sigma: float = 0.5, radius: int = None, method: str = 'gaussian') → numpy.array[source]

Apply smearing to a dataset. Different smearing methods can be specified.

Parameters:

  • y (np.array) – y-values of dataset.

  • sampling_width (float) – Sampling width of the x-axis, i.e. distance between adjacent x-values. Defaults to 1.0.

  • sigma (float) – Scale parameter. Defaults to 0.5.

  • radius (int) – Radius of the kernel.

  • method (str) – String to specify smearing method, see AVAILABLE_SMEARING_METHODS. Defaults to ‘gaussian’.

Returns:

np.array – Smeared y-values.

aim2dat.fct.smearing.AVAILABLE_SMEARING_METHODS