pycfit 1.0.0

Component Fitting package

Python Component Fitting Tool (pycfit)

Python program to replicate many spectral fitting functions of the CFIT system from SolarSoft IDL.

Installation

pip install pycfit

🛠 Important: Conda Environments Must Have Python Installed

If using Conda, ensure your environment includes Python before installing:

conda create --name myenv python
conda activate myenv

pip install pycfit

Use

Use interactive fitter to find an initial model based on an averaged spectra

import pycfit

# Retrieve sample data
wavelength, intensity, uncertainty = pycfit.data.get_example_single_spectrum()

# Call the GUI fitter
model = pycfit.cfit_gui(wavelength, intensity, uncertainty=uncertainty)

If you export your model from within the GUI, you can initialize a new pyCFIT instance with it later

from pathlib import Path

fname = Path('path/to/saved/model.py')
model = pycfit.cfit_gui(wavelength, intensity, uncertainty=uncertainty, function=fname)

Use the interactive viewer to fit each point of the raster to the initial model and adjust or mask individual point fittings as needed

# Retrieve a small-patch of sample data
wavelength, intensity, uncertainty, mask = pycfit.data.get_example_grid_spectra(patch=True)

# Create a Grid fitter, using the previously defined model
myGrid = pycfit.cfit_grid(model, wavelength, intensity, 
                uncertainty=uncertainty, mask=mask)

# Fit the whole raster
myGrid.fit(maxiter=100) # Astropy fitter keywords like "maxiter" can be passed through

# Inspect and modify the fits at each point
print(myGrid.shape)
myGrid = pycfit.cfit_grid_gui(myGrid)

# Get results
results = myGrid.get_results()

Contacts:

Software Maintenance:

Ayris Narock: [e-mail]

NASA Official:

Therese Kucera: [e-mail]

License

This project is Copyright (c) National Aeronautics and Space Administration and licensed under the terms of the Apache Software License 2.0 license. This package is based upon the Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>_ which is licensed under the BSD 3-clause licence. See the licenses folder for more information.