Skip to main content

Fitspy (A generic tool to fit spectra in python)

Project description

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 fitting algorithm has multiprocessing capabilities and relies on the lmfit library.
Bounds and constraints can be set on each peaks models parameter.

The peak models considered in Fitspy are :

  • Gaussian
  • Lorentzian
  • Asymetric Gaussian
  • Asymetric Lorentzian
  • 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.

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

Tests and examples execution

pip install pytest
git clone https://github.com/CEA-MetroCarac/fitspy.git
cd fitspy
pytest
python example/ex0_gui_auto_decomposition.py
...

Quick start

Launch the application:

fitspy

Then, from the top to the bottom of the right GUI 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 Peaks 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.

Authors information

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

  • Quéméré, (2024). Fitspy: A python package for spectral decomposition. Journal of Open Source Software. (submitted)

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fitspy-2024.1-py3-none-any.whl (53.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fitspy-2024.1-py3-none-any.whl
  • Upload date:
  • Size: 53.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 55b61a2cb8e3008dd92886a829a328ef316caeb863176341cc4cc971644d6dbd
MD5 ef71c06b56ae164101fa143f35fa6442
BLAKE2b-256 f0829851cf0b743a79344a8a0b1c27626ceab4316b087fe66403b9c9530541c1

See more details on using hashes here.

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