enlighten.post_processing.DespikingFeature.DespikingFeature Class Reference

Provides access to the removal of cosmic spikes that could impact analysis. More...

Public Member Functions
	__init__ (self, spin_tau, spin_window)
ProcessedReading	DarrenEtAlAlgo (self, ProcessedReading processed_reading)
None	interpolate_zs (self, np.ndarray spectra, np.ndarray scores, list[int] candidate_idxs, float tau, int m)
ProcessedReading	process (self, ProcessedReading processed_reading)

Public Attributes
	spin_tau = spin_tau
	spin_window = spin_window

Detailed Description

Provides access to the removal of cosmic spikes that could impact analysis.

Currently only implements the algorithm in the paper by Whitaker and Hayes. Future improvements will provide different algorithms to choose from.

Constructor & Destructor Documentation

__init__()

enlighten.post_processing.DespikingFeature.DespikingFeature.__init__	(		self,
			spin_tau,
			spin_window )

Member Function Documentation

DarrenEtAlAlgo()

ProcessedReading enlighten.post_processing.DespikingFeature.DespikingFeature.DarrenEtAlAlgo	(		self,
		ProcessedReading	processed_reading )

See also

Whitaker, Darren, and Kevin Hayes. "A Simple Algorithm for Despiking Raman Spectra." ChemRxiv (2018)

interpolate_zs()

None enlighten.post_processing.DespikingFeature.DespikingFeature.interpolate_zs	(		self,
		np.ndarray	spectra,
		np.ndarray	scores,
		list[int]	candidate_idxs,
		float	tau,
		int	m )

Parameters

tau,sensitivity	to spikes, lower means more likely to consider something a spike, Whitaker and Hayes used 6.5 for default
m	window size, larger window means grabs more neighbors for averaging in the moving window takes the pre-identified indicies that are believed to be spikes and applies the algorithm from the paper on them. Modification is done in place

process()

ProcessedReading enlighten.post_processing.DespikingFeature.DespikingFeature.process	(		self,
		ProcessedReading	processed_reading )

Member Data Documentation

spin_tau

enlighten.post_processing.DespikingFeature.DespikingFeature.spin_tau = spin_tau

spin_window

enlighten.post_processing.DespikingFeature.DespikingFeature.spin_window = spin_window

---

The documentation for this class was generated from the following file:

• enlighten/post_processing/DespikingFeature.py