Skip to content

Lorentzian

DragLorentzianManager

Bases: DragPointCollection

Source code in itfit/fit_functions/lorentzian/lorentzian.py 
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
class DragLorentzianManager(DragPointCollection):
    @staticmethod
    def function(x,A,x0,FWHM):
        """Lorentzian function.

        Args:
            x (float): independent variable.
            A (float): scalar.
            x0 (float): maximum center.
            FWHM (float): full width at half maximum.

        Returns:
            (float): `f(x) = A·FWHM / (π ·(x-x0)² + (FWHM/2)²)`
        """

        return A/np.pi*(FWHM/2)/((x-x0)**2+(FWHM/2)**2)

    @staticmethod
    def gradient(x,A,x0,FWHM):
        """# TODO: make docstrings

        Args:
            x (float): _description_
            A (float): _description_
            x0 (float): _description_
            FWHM (float): _description_

        Returns:
            (np.array): _description_
        """
        dfdA = 1/np.pi*(FWHM/2)/((x-x0)**2+(FWHM/2)**2)
        dfdx0 = A/np.pi*(FWHM/2) *2 *(x-x0) / ((x-x0)**2+(FWHM/2)**2)**2
        dfdF = A/np.pi/2 * ((x-x0)**2+(FWHM/2)**2) -  A/np.pi*(FWHM/2) * FWHM / ((x-x0)**2+(FWHM/2)**2)**2

        return A/np.pi*(FWHM/2)/((x-x0)**2+(FWHM/2)**2)

    @staticmethod
    def get_args_length():
        """Gets number of arguments of `function`.

        Returns:
            (int): Number of arguments of `function`.
        """
        return 3

    def __init__(self,dragpoints: list[DragPoint],blit_manager: BlitManager):
        """Lorentzian line between 2 DragPoints. Updates with them.

        Args:
            dragpoints (list[DragPoint]): line vertices.
            blit_manager (BlitManager): used for automatic ploting.
        """

        super().__init__(dragpoints,blit_manager)
        # name points based on use
        self.peak = self.dragpoints[0]
        self.side = self.dragpoints[1]
        self.update()



    def update(self,*args,**kargs):
        """Updates line data with DragObjects positions"""

        peak_x, side_x = self.get_xdata()
        A,x0,FWHM = self.get_args()

        #create x and y data of Lorentzian line of a Lorentzian that moves across two points
        dx = abs(peak_x-side_x) * 1.5
        x = np.linspace(min(peak_x,side_x)-dx,max(peak_x,side_x)+dx,250)
        y = self.function(x,A,x0,FWHM)

        #from data coordinates to display coordinates
        xy = np.array((x,y)).T.reshape(-1,2)
        x_data, y_data = self.set_xy(xy).T

        #set new data
        self.poly.set_xdata(x_data)
        self.poly.set_ydata(y_data)

    def get_args(self):
        """Gives Lorentzian function parameters.

        Returns:
            (tuple[float,float,float]): `A`, `x0`, and `FWHM` of `f(x) = A/pi*(FWHM/2)/((x-x0)^2+(FWHM/2)^2)`.
        """
        peak_x, peak_y = self.get_xy(*self.peak.patch.get_center())
        side_x, side_y = self.get_xy(*self.side.patch.get_center())

        if (peak_y < side_y and peak_y > 0) or \
           (peak_y >= side_y and peak_y < 0):
                peak_x, peak_y = self.get_xy(*self.side.patch.get_center())
                side_x, side_y = self.get_xy(*self.peak.patch.get_center())

        x0 = peak_x
        FWHM = 2*abs(peak_x-side_x)
        A = peak_y*FWHM/2*np.pi


        return A,x0,FWHM

__init__(dragpoints, blit_manager)

Lorentzian line between 2 DragPoints. Updates with them.

Parameters:

Name Type Description Default
dragpoints list[DragPoint]

line vertices.

 required
blit_manager BlitManager

used for automatic ploting.

 required
Source code in itfit/fit_functions/lorentzian/lorentzian.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
def __init__(self,dragpoints: list[DragPoint],blit_manager: BlitManager):
    """Lorentzian line between 2 DragPoints. Updates with them.

    Args:
        dragpoints (list[DragPoint]): line vertices.
        blit_manager (BlitManager): used for automatic ploting.
    """

    super().__init__(dragpoints,blit_manager)
    # name points based on use
    self.peak = self.dragpoints[0]
    self.side = self.dragpoints[1]
    self.update()

function(x, A, x0, FWHM) staticmethod

Lorentzian function.

Parameters:

Name Type Description Default
x float

independent variable.

 required
A float

scalar.

 required
x0 float

maximum center.

 required
FWHM float

full width at half maximum.

 required

Returns:

Type Description
float

f(x) = A·FWHM / (π ·(x-x0)² + (FWHM/2)²)
Source code in itfit/fit_functions/lorentzian/lorentzian.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@staticmethod
def function(x,A,x0,FWHM):
    """Lorentzian function.

    Args:
        x (float): independent variable.
        A (float): scalar.
        x0 (float): maximum center.
        FWHM (float): full width at half maximum.

    Returns:
        (float): `f(x) = A·FWHM / (π ·(x-x0)² + (FWHM/2)²)`
    """

    return A/np.pi*(FWHM/2)/((x-x0)**2+(FWHM/2)**2)

get_args()

Gives Lorentzian function parameters.

Returns:

Type Description
tuple[float, float, float]

A, x0, and FWHM of f(x) = A/pi*(FWHM/2)/((x-x0)^2+(FWHM/2)^2).
Source code in itfit/fit_functions/lorentzian/lorentzian.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def get_args(self):
    """Gives Lorentzian function parameters.

    Returns:
        (tuple[float,float,float]): `A`, `x0`, and `FWHM` of `f(x) = A/pi*(FWHM/2)/((x-x0)^2+(FWHM/2)^2)`.
    """
    peak_x, peak_y = self.get_xy(*self.peak.patch.get_center())
    side_x, side_y = self.get_xy(*self.side.patch.get_center())

    if (peak_y < side_y and peak_y > 0) or \
       (peak_y >= side_y and peak_y < 0):
            peak_x, peak_y = self.get_xy(*self.side.patch.get_center())
            side_x, side_y = self.get_xy(*self.peak.patch.get_center())

    x0 = peak_x
    FWHM = 2*abs(peak_x-side_x)
    A = peak_y*FWHM/2*np.pi


    return A,x0,FWHM

get_args_length() staticmethod

Gets number of arguments of function.

Returns:

Type Description
int

Number of arguments of function.
Source code in itfit/fit_functions/lorentzian/lorentzian.py 
58
59
60
61
62
63
64
65
@staticmethod
def get_args_length():
    """Gets number of arguments of `function`.

    Returns:
        (int): Number of arguments of `function`.
    """
    return 3

gradient(x, A, x0, FWHM) staticmethod

TODO: make docstrings

Parameters:

Name Type Description Default
x float

description

 required
A float

description

 required
x0 float

description

 required
FWHM float

description

 required

Returns:

Type Description
np.array

description
Source code in itfit/fit_functions/lorentzian/lorentzian.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@staticmethod
def gradient(x,A,x0,FWHM):
    """# TODO: make docstrings

    Args:
        x (float): _description_
        A (float): _description_
        x0 (float): _description_
        FWHM (float): _description_

    Returns:
        (np.array): _description_
    """
    dfdA = 1/np.pi*(FWHM/2)/((x-x0)**2+(FWHM/2)**2)
    dfdx0 = A/np.pi*(FWHM/2) *2 *(x-x0) / ((x-x0)**2+(FWHM/2)**2)**2
    dfdF = A/np.pi/2 * ((x-x0)**2+(FWHM/2)**2) -  A/np.pi*(FWHM/2) * FWHM / ((x-x0)**2+(FWHM/2)**2)**2

    return A/np.pi*(FWHM/2)/((x-x0)**2+(FWHM/2)**2)

update(*args, **kargs)

Updates line data with DragObjects positions

Source code in itfit/fit_functions/lorentzian/lorentzian.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def update(self,*args,**kargs):
    """Updates line data with DragObjects positions"""

    peak_x, side_x = self.get_xdata()
    A,x0,FWHM = self.get_args()

    #create x and y data of Lorentzian line of a Lorentzian that moves across two points
    dx = abs(peak_x-side_x) * 1.5
    x = np.linspace(min(peak_x,side_x)-dx,max(peak_x,side_x)+dx,250)
    y = self.function(x,A,x0,FWHM)

    #from data coordinates to display coordinates
    xy = np.array((x,y)).T.reshape(-1,2)
    x_data, y_data = self.set_xy(xy).T

    #set new data
    self.poly.set_xdata(x_data)
    self.poly.set_ydata(y_data)

LorentzianFitter

Bases: GenericFitter

Lorentzian function fitter.

Source code in itfit/fit_functions/lorentzian/lorentzian.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
class LorentzianFitter(GenericFitter):
    """Lorentzian function fitter."""
    name = 'lorentzian'

    def __init__(self,app,data: DataSelection):
        """ Lorentzian fitter following function `f(x) = A/pi*(FWHM/2)/((x-x0)^2+(FWHM/2)^2)`

        Parameters:
            app (Fitter):
                Main application.
            data (DataSelection):
                Data to fit.
        """

        super().__init__(app,data)

        ## Create DragPoints and DragLines needed

        self.drag_points = [DragPoint(*self.ax.transAxes.transform((0.5,0.7)), None),
                            DragPoint(*self.ax.transAxes.transform((0.7,0.3)), None)]
        self.drag_points_managers = [DragPointManager(p,self.app.blit_manager) for p in self.drag_points]
        self.fitter_drag_collection = DragLorentzianManager(self.drag_points, self.app.blit_manager)
        self.function = self.fitter_drag_collection.function
        self.gradient = self.fitter_drag_collection.gradient

        ##Connect Lorentzian to Points change events
        self.drag_points_cids = [] #Connections ids for change events
        for dp in self.drag_points_managers:
            self.drag_points_cids.append(
                dp.connect(self.fitter_drag_collection.update)
            )
        self.drag_points_managers[1].add_restriction(self.res_fwhm)

        ## Add created DragPoints and DragLines to BlitManager's artists
        self.app.blit_manager.artists.append(self.fitter_drag_collection)
        for dpm in self.drag_points_managers:
            self.app.blit_manager.artists.append(dpm)

        self.fig.canvas.draw_idle()

    def res_fwhm(self, x, y):
        return x, self.drag_points_managers[0].set_xy(0,
            self.drag_points_managers[0].get_xy(  *self.drag_points[0].patch.get_center() )[1]/2
            )[1]

__init__(app, data)

Lorentzian fitter following function f(x) = A/pi*(FWHM/2)/((x-x0)^2+(FWHM/2)^2)

Parameters:

Name Type Description Default
app Fitter

Main application.

 required
data DataSelection

Data to fit.

 required
Source code in itfit/fit_functions/lorentzian/lorentzian.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def __init__(self,app,data: DataSelection):
    """ Lorentzian fitter following function `f(x) = A/pi*(FWHM/2)/((x-x0)^2+(FWHM/2)^2)`

    Parameters:
        app (Fitter):
            Main application.
        data (DataSelection):
            Data to fit.
    """

    super().__init__(app,data)

    ## Create DragPoints and DragLines needed

    self.drag_points = [DragPoint(*self.ax.transAxes.transform((0.5,0.7)), None),
                        DragPoint(*self.ax.transAxes.transform((0.7,0.3)), None)]
    self.drag_points_managers = [DragPointManager(p,self.app.blit_manager) for p in self.drag_points]
    self.fitter_drag_collection = DragLorentzianManager(self.drag_points, self.app.blit_manager)
    self.function = self.fitter_drag_collection.function
    self.gradient = self.fitter_drag_collection.gradient

    ##Connect Lorentzian to Points change events
    self.drag_points_cids = [] #Connections ids for change events
    for dp in self.drag_points_managers:
        self.drag_points_cids.append(
            dp.connect(self.fitter_drag_collection.update)
        )
    self.drag_points_managers[1].add_restriction(self.res_fwhm)

    ## Add created DragPoints and DragLines to BlitManager's artists
    self.app.blit_manager.artists.append(self.fitter_drag_collection)
    for dpm in self.drag_points_managers:
        self.app.blit_manager.artists.append(dpm)

    self.fig.canvas.draw_idle()

LorentzianTool

Bases: GenericFitterTool

Toggles Lorentzian Tool.

Source code in itfit/fit_functions/lorentzian/lorentzian.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
class LorentzianTool(GenericFitterTool):
    """Toggles Lorentzian Tool."""

    # default_keymap = ''
    description = 'Lorentz me please'

    def enable(self,*args):
        """Triggered when LorentzianTool is enabled,
        Uses BlitManager for faster rendering of DragObjects.
        """
        super().enable()
        self.fitter = LorentzianFitter(self.app,self.data)

    def disable(self,*args):
        """Triggered when LorentzianTool is disabled.
        Removes DragObjects and disables BlitManager.
        """
        super().disable()

disable(*args)

Triggered when LorentzianTool is disabled. Removes DragObjects and disables BlitManager.

Source code in itfit/fit_functions/lorentzian/lorentzian.py 
184
185
186
187
188
def disable(self,*args):
    """Triggered when LorentzianTool is disabled.
    Removes DragObjects and disables BlitManager.
    """
    super().disable()

enable(*args)

Triggered when LorentzianTool is enabled, Uses BlitManager for faster rendering of DragObjects.

Source code in itfit/fit_functions/lorentzian/lorentzian.py 
177
178
179
180
181
182
def enable(self,*args):
    """Triggered when LorentzianTool is enabled,
    Uses BlitManager for faster rendering of DragObjects.
    """
    super().enable()
    self.fitter = LorentzianFitter(self.app,self.data)