User Guide
Installation
Installation using conda
1. Creating a conda environment
2. Installing the package in the new environment
3. Getting Started
Installation using pip
Updating the package
Introduction
What is LumiSpy
Signal types
Where are we heading?
Non-uniform signal axes
The energy axis
The wavenumber axis/Raman shifts
Jacobian transformation
Transformation of the variance
Interpolation to uniform axes
Signal tools
Scaling and normalizing signal data
Peak positions and properties
Peak identification
Peak Width
Calculating the centroid of a spectrum (centre of mass)
Signal statistics and analytical operations
Replacing negative data values
Crop edges
Working with streak images
Transition to one-dimensional signals
Iteration over the spectral or time dimension
Fitting luminescence data
Signal variance (noise)
Utility functions
Join spectra
Exporting text files
Mathematical routines
Unit conversion
Solving the grating equation
Cropping multiple signals in the navigation axis
LumiSpy metadata structure
General
Sample
Signal
Acquisition Instrument
Laser / SEM / TEM
Laser
Filter
Spectrometer
Grating
Filter
Detector
Spectral_image
Bibliography
Examples
Gallery of Examples
Data Processing
Remove Pixels
Remove Background
Remove Spikes
Rebinning
Data Smoothing
Plotting
Chromatic Imaging
Extraction of linescan
API reference
lumispy
lumispy package
Subpackages
lumispy.data package
lumispy.signals package
lumispy.utils package
Module contents
Tutorials
Demo notebooks
Release Notes
Changelog
UNRELEASED
0.2.3.dev173+g6521492c9 [UNRELEASED] (2026-06-11)
New features
Enhancements
Improved Documentation
Maintenance
0.3.0 (2025-02-23)
New features
Enhancements
Improved Documentation
Maintenance
2023-03-15 - version 0.2.2
Changed
Maintenance
2022-11-02 - version 0.2.1
Added
Changed
Maintenance
2022-04-29 - version 0.2.0
Added
Changed
2021-11-23 - version 0.1.3
Changed
2021-08-22 - version 0.1.2
Added
Changed
2021-03-26 - version 0.1.0
Added
Credits and citation
Citing LumiSpy
Contributing
Issues
Pull Requests
Reviewing
Documentation
Code style
Writing tests
Releasing a new version
License
On GitHub
LumiSpy
Index
Index
_
|
A
|
C
|
D
|
E
|
I
|
J
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
V
_
_convert_data() (lumispy.signals.common_luminescence.CommonLumi method)
_make_signal_mask() (lumispy.signals.cl_spectrum.CLSpectrum method)
_n_air() (in module lumispy.utils.axes)
_reset_variance_linear_model() (lumispy.signals.common_luminescence.CommonLumi method)
_signal_math() (lumispy.signals.common_luminescence.CommonLumi method)
A
asymmetric_peak_map() (in module lumispy.data)
axis2eV() (in module lumispy.utils.axes)
axis2invcm() (in module lumispy.utils.axes)
C
calculate_spectral_response() (lumispy.signals.common_luminescence.CommonLumi method)
centroid() (lumispy.signals.luminescence_spectrum.LumiSpectrum method)
CLSEMSpectrum (class in lumispy.signals.cl_spectrum)
CLSpectrum (class in lumispy.signals.cl_spectrum)
CLSTEMSpectrum (class in lumispy.signals.cl_spectrum)
com() (in module lumispy.utils.signals)
CommonLumi (class in lumispy.signals.common_luminescence)
CommonTransient (class in lumispy.signals.common_transient)
correct_grating_shift() (lumispy.signals.cl_spectrum.CLSEMSpectrum method)
crop_edges() (in module lumispy.utils.signals)
(lumispy.signals.common_luminescence.CommonLumi method)
D
data2eV() (in module lumispy.utils.axes)
data2invcm() (in module lumispy.utils.axes)
E
ELSpectrum (class in lumispy.signals.el_spectrum)
eV2nm() (in module lumispy.utils.axes)
I
invcm2nm() (in module lumispy.utils.axes)
J
join_spectra() (in module lumispy.utils.axes)
L
LazyCLSEMSpectrum (class in lumispy.signals.cl_spectrum)
LazyCLSpectrum (class in lumispy.signals.cl_spectrum)
LazyCLSTEMSpectrum (class in lumispy.signals.cl_spectrum)
LazyELSpectrum (class in lumispy.signals.el_spectrum)
LazyLumiSpectrum (class in lumispy.signals.luminescence_spectrum)
LazyLumiTransient (class in lumispy.signals.luminescence_transient)
LazyLumiTransientSpectrum (class in lumispy.signals.luminescence_transientspec)
LazyPLSpectrum (class in lumispy.signals.pl_spectrum)
LumiSpectrum (class in lumispy.signals.luminescence_spectrum)
lumispy
module
lumispy.data
module
lumispy.signals
module
lumispy.signals.cl_spectrum
module
lumispy.signals.common_luminescence
module
lumispy.signals.common_transient
module
lumispy.signals.el_spectrum
module
lumispy.signals.luminescence_spectrum
module
lumispy.signals.luminescence_transient
module
lumispy.signals.luminescence_transientspec
module
lumispy.signals.pl_spectrum
module
lumispy.utils
module
lumispy.utils.axes
module
lumispy.utils.io
module
lumispy.utils.signals
module
LumiTransient (class in lumispy.signals.luminescence_transient)
LumiTransientSpectrum (class in lumispy.signals.luminescence_transientspec)
M
module
lumispy
lumispy.data
lumispy.signals
lumispy.signals.cl_spectrum
lumispy.signals.common_luminescence
lumispy.signals.common_transient
lumispy.signals.el_spectrum
lumispy.signals.luminescence_spectrum
lumispy.signals.luminescence_transient
lumispy.signals.luminescence_transientspec
lumispy.signals.pl_spectrum
lumispy.utils
lumispy.utils.axes
lumispy.utils.io
lumispy.utils.signals
N
nanoparticles() (in module lumispy.data)
nm2eV() (in module lumispy.utils.axes)
nm2invcm() (in module lumispy.utils.axes)
normalize() (lumispy.signals.common_luminescence.CommonLumi method)
P
PLSpectrum (class in lumispy.signals.pl_spectrum)
px_to_nm_grating_solver() (lumispy.signals.luminescence_spectrum.LumiSpectrum method)
R
remove_background_from_file() (lumispy.signals.luminescence_spectrum.LumiSpectrum method)
remove_negative() (lumispy.signals.common_luminescence.CommonLumi method)
remove_spikes() (lumispy.signals.cl_spectrum.CLSpectrum method)
S
savetxt() (in module lumispy.utils.io)
(lumispy.signals.luminescence_spectrum.LumiSpectrum method)
scale_by_exposure() (lumispy.signals.common_luminescence.CommonLumi method)
solve_grating_equation() (in module lumispy.utils.axes)
spec2nav() (lumispy.signals.luminescence_transientspec.LumiTransientSpectrum method)
spectral_response_correction() (lumispy.signals.common_luminescence.CommonLumi method)
T
time2nav() (lumispy.signals.luminescence_transientspec.LumiTransientSpectrum method)
to_array() (in module lumispy.utils.io)
(lumispy.signals.luminescence_spectrum.LumiSpectrum method)
to_eV() (lumispy.signals.common_luminescence.CommonLumi method)
to_invcm() (lumispy.signals.common_luminescence.CommonLumi method)
to_invcm_relative() (lumispy.signals.common_luminescence.CommonLumi method)
to_raman_shift() (lumispy.signals.common_luminescence.CommonLumi method)
TransientSpectrumCasting (class in lumispy.signals.luminescence_transientspec)
V
var2eV() (in module lumispy.utils.axes)
var2invcm() (in module lumispy.utils.axes)