crikit.measurement package¶
Subpackages¶
Submodules¶
crikit.measurement.peakamps module¶
Measurement methods to quantify peak relationships
Note
For complex-valued measurements, all methods perform the math separately for real and imag
-
class
crikit.measurement.peakamps.
AbstractMeasureThree
(f1, f2, f3)[source]¶ Bases:
object
Abstract class for measurements that take 3 things
-
class
crikit.measurement.peakamps.
AbstractMeasureTwo
(f1, f2)[source]¶ Bases:
object
Abstract class for measurements that take 2 things
-
class
crikit.measurement.peakamps.
AbstractMeasureTwoOrdered
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwo
Abstract class for measurements that take 2 things, where f1 < f2
-
class
crikit.measurement.peakamps.
MeasurePeak
(f1)[source]¶ Bases:
object
Meausure peak amplitude.
- Parameters
f1 (int) – Peak location in pixel coordinates
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakAdd
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwo
Meausure the addition of two peaks (f1 + f2).
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakBWTroughs
(pk, tr1, tr2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureThree
Meausure the amplitude of a peak between troughs.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakDivide
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwo
Meausure the ratio (division) of two peaks. f1/f2
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakMax
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwoOrdered
- Meausure the maximum across the range [f1,f2]. Note
that real and imag are treated separately.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakMaxAbs
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwoOrdered
Meausure the maximum across the absolute value across the range [f1,f2]. Note that real and imag are
treated separately.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakMin
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwoOrdered
- Meausure the minimum across the range [f1,f2]. Note
that real and imag are treated separately.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakMinAbs
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwoOrdered
Meausure the summation of all amplitudes between (inclusive) two peak locations. Note that real and imag are treated
separately.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakMinus
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwo
Meausure the difference (subtraction) of two peaks (f1 - f2).
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakMultiply
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwo
Meausure the multiplication of two peak.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakSum
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwoOrdered
Meausure the summation of all amplitudes between (inclusive) two peak locations.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
class
crikit.measurement.peakamps.
MeasurePeakSumAbsReImag
(f1, f2)[source]¶ Bases:
crikit.measurement.peakamps.AbstractMeasureTwoOrdered
Meausure the summation of the absolute value of all amplitudes between (inclusive) two peak locations. Note that the absolute value is performed on the real and imaginary parts separately – it’s not a true absolute value.
- Parameters
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
crikit.measurement.peakfind module¶
Peak-finding utilities
Notes
-
class
crikit.measurement.peakfind.
PeakFinder
(noise_sigma, cwt_width=10, n_noise_tests=1000, cutoff_d1=None, cutoff_d2=None, verbose=True)[source]¶ Bases:
object
Find peaks and shoulders of a signal.
- Parameters
QQ (int) – Peak location in pixel coordinates
-
calculate : Calculate the amplitude
-
Static Methods
-
--------------
-
measure : Same as calculate but static (returns the amplitude directly)
-
static
cwt_diff
(signal, wv_width, order=1, method='auto')[source]¶ Take a numerical derivative using a Haar wavelet (noise-supression)
- Parameters
- Returns
deriv – Derivative of input signal
- Return type
ndarray (1D)
-
property
cwt_width
¶
-
property
noise_sigma
¶