The purpose of this was project was to learn how to use and create Classes, and to create a Spectrum object to use within my Phd work.
The main goals of this project are basically complete.
- create a class to contain spectrum
- automatic interpolation
- overloaded operators especially
- Spectral division (spectrum_A / spectrum_B )
- Spectral subtraction (spectrum_A - spectrum_B)
- Powers/exponents (spectrum ** x)
Further documentation can be found on read the docs.
When the spectra have different wavelength vectors spectrum_overload interpolates
to the wavelength of the first spectrum. This may not suit your requirements.
pip install spectrum-overload
Currently to install and use Spectrum class for your own projects.
clone the git repository where you want it then type:
git clone https://github.com/jason-neal/spectrum_overload.git
cd spectrum_overload
python setup.py install
or python setup.py develop if you want to make changes.
To use import the class using :
from spectrum_overload import Spectrum
...
my_spectrum = Spectrum(flux, xaxis)
or :
from spectrum_overload.spectrum import Spectrum as spec
...
my_spectrum = spec(flux, xaxis)
or however else you would like to name it.
A tutorial is provided here to show an example of how to use this class.
Contributions are very welcome.
I would really appreciate user feedback or suggested improvements if you have any.
Feel free to submit issues or create pull requests.
Python 2.7 is only supported in versions <0.2.1 (also available on pip) to make use of useful python3 features.
There are many other spectrum classes around but I didn't see any that overload the operators. (I could be blind).
One of these may better suit your needs
- https://github.com/crawfordsm/specreduce
- https://github.com/crawfordsm/pyspectrograph/tree/master/PySpectrograph/Spectra
- http://pyspeckit.bitbucket.org/html/sphinx/spectrum.html#pyspeckit.spectrum.classes.Spectrum
- https://github.com/cokelaer/spectrum
- https://github.com/astropy/specutils
Wow A lot. I probably should not reinvent the wheel too much then...
It turns out that astropy/specutils is very similar to what I have created but its direction is uncertain at the moment and they do not use overloaded operators and will not implement in the foreseeable future.
Some tasks still to do:
- Improve Documentation
- Generate Calibration solution (outside spectrum class)?