HDF5_BLS_treat.Models

class HDF5_BLS_treat.Models

Bases: object

This class repertoriates all the models that can be used for the fit.

__init__()

Methods

DHO(nu, b, a, nu0, gamma[, IR])	Model of a simple lorentzian lineshape
DHO_elastic(nu, ae, be, a, nu0, gamma[, IR])	Model of a simple lorentzian lineshape
__init__()
gaussian(nu, b, a, nu0, gamma[, IR])	Model of a simple gaussian lineshape :param nu: The frequency array :type nu: array :param b: The constant offset of the data :type b: float :param a: The amplitude of the peak :type a: float :param nu0: The center position of the function :type nu0: float :param gamma: The linewidth of the function :type gamma: float :param IR: The impulse response of the instrument, by default None :type IR: array, optional
lorentzian(nu, b, a, nu0, gamma[, IR])	Model of a simple lorentzian lineshape
lorentzian_elastic(nu, ae, be, a, nu0, gamma)	Model of a simple lorentzian lineshape

Attributes

models

DHO(nu, b, a, nu0, gamma, IR=None)

Model of a simple lorentzian lineshape

Parameters:

• nu (array) – The frequency array

• b (float) – The constant offset of the data

• a (float) – The amplitude of the peak

• nu0 (float) – The center position of the function

• gamma (float) – The linewidth of the function

• IR (array, optional) – The impulse response of the instrument, by default None

Returns:

The function associated to the given parameters

Return type:

function

DHO_elastic(nu, ae, be, a, nu0, gamma, IR=None)

Model of a simple lorentzian lineshape

Parameters:

• nu (array) – The frequency array

• ae (float) – The slope of the first order Taylor expansion of the elastic peak at the position of the peak fitted

• be (float) – The constant offset of the data

• a (float) – The amplitude of the peak

• nu0 (float) – The center position of the function

• gamma (float) – The linewidth of the function

• IR (array, optional) – The impulse response of the instrument, by default None

Returns:

The function associated to the given parameters

Return type:

function

gaussian(nu, b, a, nu0, gamma, IR=None)

Model of a simple gaussian lineshape :param nu: The frequency array :type nu: array :param b: The constant offset of the data :type b: float :param a: The amplitude of the peak :type a: float :param nu0: The center position of the function :type nu0: float :param gamma: The linewidth of the function :type gamma: float :param IR: The impulse response of the instrument, by default None :type IR: array, optional

Returns:

The function associated to the given parameters

Return type:

function

lorentzian(nu, b, a, nu0, gamma, IR=None)

Model of a simple lorentzian lineshape

Parameters:

• nu (array) – The frequency array

• b (float) – The constant offset of the data

• a (float) – The amplitude of the peak

• nu0 (float) – The center position of the function

• gamma (float) – The linewidth of the function

• IR (array, optional) – The impulse response of the instrument, by default None

Returns:

The function associated to the given parameters

Return type:

function

lorentzian_elastic(nu, ae, be, a, nu0, gamma, IR=None)

Model of a simple lorentzian lineshape

Parameters:

• nu (array) – The frequency array

• ae (float) – The slope of the first order Taylor expansion of the elastic peak at the position of the peak fitted

• be (float) – The constant offset of the data

• a (float) – The amplitude of the peak

• nu0 (float) – The center position of the function

• gamma (float) – The linewidth of the function

• IR (array, optional) – The impulse response of the instrument, by default None

Returns:

The function associated to the given parameters

Return type:

function

models = {}