Skip to content

Fitter app

Fitter

Source code in itfit/fitter_app.py 
 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
122
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class Fitter:
    data : data.DataSelection
    figure : Figure
    ax : Axes
    fits : dict[int, utils.FitResultContainer]
    selections : dict
    blit_manager : utils.BlitManager
    _last_fit : int

    def __init__(self, xdata, ydata, yerr=None, xerr=None, *args, **kargs):
        self.data = DataSelection(xdata, ydata, yerr=yerr, xerr=xerr)
        self.figure = plt.figure()
        self.ax = self.figure.gca()
        self.fits: dict[int, FitResultContainer] = {}
        self.selections = {}
        self.blit_manager = BlitManager(self)
        self._last_fit: int|None = None
        self._data_was_plotted = False

    def __call__(self):
        if not self._data_was_plotted:
            self.data_line = self.ax.plot(self.data.xdata, self.data.ydata, '.-')
            self._data_was_plotted = True

        self.figure.canvas.manager.toolmanager.add_tool('Lasso', LassoTool, app=self,data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Lasso', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Line', fit_functions.linear.LineTool, app=self, data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Line', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Quadratic', fit_functions.quadratic.QuadraticTool, app=self, data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Quadratic', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Exponential', fit_functions.exponential.ExponentialTool, app=self, data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Exponential', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Gaussian', fit_functions.gaussian.GaussianTool, app=self,data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Gaussian', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Sine',  fit_functions.sine.SineTool, app=self,data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Sine', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Cosine',  fit_functions.cosine.CosineTool, app=self,data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Cosine', 'fitter')

        self.figure.canvas.manager.toolmanager.add_tool('Lorentzian', fit_functions.lorentzian.LorentzianTool, app=self,data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Lorentzian', 'fitter')

    def add_custom_fit_function(self, function_builder: FunctionBuilder):
        if not self._data_was_plotted:
            self.data_line = self.ax.plot(self.data.xdata, self.data.ydata)
            self._data_was_plotted = True

        self.figure.canvas.manager.toolmanager.add_tool('Custom tool', function_builder.get_custom_tool(), app=self,data=self.data)
        self.figure.canvas.manager.toolbar.add_tool('Custom tool', 'fitter')

    def _add_fit(self, fit: FitResultContainer):
        """Adds the fit to the application

        Parameters:
            fit (FitResultContainer):
                Fit to add
        """
        self._last_fit = hash(fit)
        self.fits.update({self._last_fit: fit})

    def get_single_fit_selector(self):
        """Stars a fit selector figure where you can select one fit.

        Returns:
            (itfit.utils.FitResultContainer): Fit result container of selected fit.
        """
        selector = FitSelector(self)
        selection = selector.connect_select_one().get_selected()
        return self.fits.get(selection)

    def get_fit_selector(self):
        """Stars a fit selector figure where you can select one or more fits.

        Returns:
            (itfit.utils.FitResultContainer, list[itfit.utils.FitResultContainer]): Fit result container of selected fits, list if multiple.
        """
        selector = FitSelector(self)
        selection = selector.connect_select_multiple().get_selected()
        if isinstance(selection, list):
            return [self.fits.get(k) for k in selection]
        return self.fits.get(selection)

    def get_last_fit(self):
        """Returns the last fit

        Returns:
            (FitResultContainer): Fit result container.
        """
        return self.fits.get(self._last_fit) if (self._last_fit is not None) else None

    def add_filter(self, filter: function):
        """Adds a filter for data selection. The signature must be as:
```py
lambda x,y : bool
```
or
```py
def foo(x,y) -> bool:
    return bool
```
        Parameters:
            filter (function): Filter function.
        """
        selection = filter(*(self.data.get_data().T))
        self.data.selection(selection)
        self.data.create_selected_poly(self.ax)


    def get_plot_builder(self):
        """Returns a itfit.plot.PlotBuilder instance. Used to ease plot creation.
        """

        return PlotBuilder(self)

    def default_plot_last_fit(self, xlabel: str="", ylabel: str="", title: str=""):
        """Plots last fit with default configuration:
```py
.plot_data(label="Data")\\
.with_errors()\\
.with_fit(label=fit.fit_manager.name.capitalize())\\
.xlabel(xlabel).ylabel(ylabel).title(title)\\       
.spines()\\
    .start_top_spine().invisible().end_top_spine()\\
    .start_right_spine().invisible().end_right_spine()\\
.end_spines()\\     
.grid().legend().tight_layout()
```

Parameters:
    xlabel (str): x label. Defaults to "".
    ylabel (str): y label. Defaults to "".
    title (str): title. Defaults to "".

Returns:
    (itfit.plot.PlotBuilder): PlotBuilder to continue plot customization.
        """
        fit = self.get_last_fit()
        if fit is None:
            raise Exception("At least one fit must me made before trying to plot a fit.")
        return PlotBuilder(self, fit)\
            .plot_data(label="Data")\
            .with_errors()\
            .with_fit(label=fit.fit_manager.name.capitalize())\
            .xlabel(xlabel).ylabel(ylabel).title(title)\
            .spines()\
                .start_top_spine().invisible().end_top_spine()\
                .start_right_spine().invisible().end_right_spine()\
            .end_spines()\
            .grid().legend().tight_layout()

add_filter(filter)

Adds a filter for data selection. The signature must be as: 

lambda x,y : bool
or 
def foo(x,y) -> bool:
    return bool
Parameters: filter (function): Filter function.

Source code in itfit/fitter_app.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
    def add_filter(self, filter: function):
        """Adds a filter for data selection. The signature must be as:
```py
lambda x,y : bool
```
or
```py
def foo(x,y) -> bool:
    return bool
```
        Parameters:
            filter (function): Filter function.
        """
        selection = filter(*(self.data.get_data().T))
        self.data.selection(selection)
        self.data.create_selected_poly(self.ax)

default_plot_last_fit(xlabel='', ylabel='', title='')

Plots last fit with default configuration: 

.plot_data(label="Data")\
.with_errors()\
.with_fit(label=fit.fit_manager.name.capitalize())\
.xlabel(xlabel).ylabel(ylabel).title(title)\       
.spines()\
    .start_top_spine().invisible().end_top_spine()\
    .start_right_spine().invisible().end_right_spine()\
.end_spines()\     
.grid().legend().tight_layout()

Parameters:

Name Type Description Default
xlabel str

x label. Defaults to "".

 ''
ylabel str

y label. Defaults to "".

 ''
title str

title. Defaults to "".

 ''

Returns:

Type Description
itfit.plot.PlotBuilder

PlotBuilder to continue plot customization.
Source code in itfit/fitter_app.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
    def default_plot_last_fit(self, xlabel: str="", ylabel: str="", title: str=""):
        """Plots last fit with default configuration:
```py
.plot_data(label="Data")\\
.with_errors()\\
.with_fit(label=fit.fit_manager.name.capitalize())\\
.xlabel(xlabel).ylabel(ylabel).title(title)\\       
.spines()\\
    .start_top_spine().invisible().end_top_spine()\\
    .start_right_spine().invisible().end_right_spine()\\
.end_spines()\\     
.grid().legend().tight_layout()
```

Parameters:
    xlabel (str): x label. Defaults to "".
    ylabel (str): y label. Defaults to "".
    title (str): title. Defaults to "".

Returns:
    (itfit.plot.PlotBuilder): PlotBuilder to continue plot customization.
        """
        fit = self.get_last_fit()
        if fit is None:
            raise Exception("At least one fit must me made before trying to plot a fit.")
        return PlotBuilder(self, fit)\
            .plot_data(label="Data")\
            .with_errors()\
            .with_fit(label=fit.fit_manager.name.capitalize())\
            .xlabel(xlabel).ylabel(ylabel).title(title)\
            .spines()\
                .start_top_spine().invisible().end_top_spine()\
                .start_right_spine().invisible().end_right_spine()\
            .end_spines()\
            .grid().legend().tight_layout()

get_fit_selector()

Stars a fit selector figure where you can select one or more fits.

Returns:

Type Description
itfit.utils.FitResultContainer, list[itfit.utils.FitResultContainer]

Fit result container of selected fits, list if multiple.
Source code in itfit/fitter_app.py 
111
112
113
114
115
116
117
118
119
120
121
def get_fit_selector(self):
    """Stars a fit selector figure where you can select one or more fits.

    Returns:
        (itfit.utils.FitResultContainer, list[itfit.utils.FitResultContainer]): Fit result container of selected fits, list if multiple.
    """
    selector = FitSelector(self)
    selection = selector.connect_select_multiple().get_selected()
    if isinstance(selection, list):
        return [self.fits.get(k) for k in selection]
    return self.fits.get(selection)

get_last_fit()

Returns the last fit

Returns:

Type Description
FitResultContainer

Fit result container.
Source code in itfit/fitter_app.py 
123
124
125
126
127
128
129
def get_last_fit(self):
    """Returns the last fit

    Returns:
        (FitResultContainer): Fit result container.
    """
    return self.fits.get(self._last_fit) if (self._last_fit is not None) else None

get_plot_builder()

Returns a itfit.plot.PlotBuilder instance. Used to ease plot creation.

Source code in itfit/fitter_app.py 
149
150
151
152
153
def get_plot_builder(self):
    """Returns a itfit.plot.PlotBuilder instance. Used to ease plot creation.
    """

    return PlotBuilder(self)

get_single_fit_selector()

Stars a fit selector figure where you can select one fit.

Returns:

Type Description
itfit.utils.FitResultContainer

Fit result container of selected fit.
Source code in itfit/fitter_app.py 
101
102
103
104
105
106
107
108
109
def get_single_fit_selector(self):
    """Stars a fit selector figure where you can select one fit.

    Returns:
        (itfit.utils.FitResultContainer): Fit result container of selected fit.
    """
    selector = FitSelector(self)
    selection = selector.connect_select_one().get_selected()
    return self.fits.get(selection)