Skip to main content

Fitspy: a generic tool to fit spectra in python

Project description

PyPI Github Doc DOI status

Fitspy is a generic tool dedicated to fit spectra in python with a GUI that aims to be as simple and intuitive to use as possible.

Processed spectra may be independent of each other or may result from 2D-maps acquisitions.


Example of fitspy 2D-map frame interacting with the main GUI.

The predefined peak models considered in Fitspy are Gaussian, Lorentzian, Asymetric Gaussian, Asymetric Lorentzian and Pseudovoigt.

A constant, linear, parabolic or exponential background model can also be added in the fitting.

In both cases, user-defined models can be added.

Fitspy main features:

  • Fitspy uses the lmfit library to fit the spectra
  • The fit processing can be multi-threaded
  • Bounds and constraints can be set on each peaks models parameter
  • From an automatic noise level estimation, according to the local noise, peak models can be automatically deactivated
  • Fitspy also includes automatic outlier detection to be excluded during the fitting process

All actions allowed with the GUI can be executed in script mode (see examples here). These actions (like baseline and peaks definition, parameters constraints, ...) can be saved in a Fitspy model and replayed as-is or applied to other new spectra datasets.

Installation

pip install fitspy

(See the documentation for more details)

Tests and examples execution

pip install pytest
git clone https://github.com/CEA-MetroCarac/fitspy.git
cd fitspy
pytest
python examples/ex_gui_auto_decomposition.py
python examples/ex_.......

(See the documentation for more details)

Quick start

Launch the application:

fitspy

Then, from the top to the bottom of the right panel:

  • Select file(s)
  • (Optional) Define the X-range
  • Define the baseline to subtract (left or right click on the figure to add or delete (resp.) a baseline point)
  • (Optional) Normalize the spectrum/spectra
  • Click on the Fitting panel to activate it
  • Select Peak model and add peaks (left or right click on the figure to add or delete (resp.) a peak)
  • (Optional) Add a background (BKG model) to be fitted
  • (Optional) Use Parameters to set bounds and constraints
  • Fit the selected spectrum/spectra
  • (Optional) Save the parameters in .csv format
  • (Optional) Save the Model in a .json file (to be replayed later)

(See the documentation for more details)

Acknowledgements

This work, carried out on the CEA - Platform for Nanocharacterisation (PFNC), was supported by the “Recherche Technologique de Base” program of the French National Research Agency (ANR).

Warm thanks to the JOSS reviewers (@maurov and @FCMeng) and editor (@phibeck) for their contributions to enhancing Fitspy.

Citations

In case you use the results of this code in an article, please cite:

  • Quéméré P., (2024). Fitspy: A python package for spectral decomposition. Journal of Open Source Software. doi: 10.21105/joss.05868

  • Newville M., (2014). LMFIT: Non-Linear Least-Square Minimization and Curve-Fitting for Python. Zenodo. doi: 10.5281/zenodo.11813.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fitspy-2024.5.tar.gz (20.2 MB view details)

Uploaded Source

Built Distribution

fitspy-2024.5-py3-none-any.whl (60.9 kB view details)

Uploaded Python 3

File details

Details for the file fitspy-2024.5.tar.gz.

File metadata

  • Download URL: fitspy-2024.5.tar.gz
  • Upload date:
  • Size: 20.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for fitspy-2024.5.tar.gz
Algorithm Hash digest
SHA256 276cb83c14f461ae9ee38df81c176acadbd63282e94e840b2c30aba6a119be76
MD5 36b8372ab541bdecd39ff5e678be6b5a
BLAKE2b-256 81b43f10c7ffe29b0d54e8af6b7a3e1993e7c3ab2da9c4b6a7bb8c30d7f2e623

See more details on using hashes here.

Provenance

File details

Details for the file fitspy-2024.5-py3-none-any.whl.

File metadata

  • Download URL: fitspy-2024.5-py3-none-any.whl
  • Upload date:
  • Size: 60.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for fitspy-2024.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1f9f3b22014432aac03c1a3d6fe622782fd0fafdc8a87b3f91ceed9a4510e3d4
MD5 fbeae70f81604da2fad920b83f427bb6
BLAKE2b-256 f6d08a597617082b6c0e5cd7ace62356af1bd0dab2b11e391dd17bdd2cee6cff

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page