Skip to content

peak Module

This module defines a signal peak for Spyral.

Peak dataclass

Dataclass representing a singal peak in a trace

Attributes:

Name Type Description
centroid float

The peak location
amplitude float

The amplitude of the peak
positive_inflection float

The location of the left edge of the peak for integration TODO: This name is bad, change it
negative_inflection float

The location of the right edge of the peak for integration TODO: This name is bad, change it
integral float

The integral of the peak between postive_inflection and negative_inflection
Source code in src/spyral/trace/peak.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@dataclass
class Peak:
    """Dataclass representing a singal peak in a trace

    Attributes
    ----------
    centroid: float
        The peak location
    amplitude: float
        The amplitude of the peak
    positive_inflection: float
        The location of the left edge of the peak for integration
        TODO: This name is bad, change it
    negative_inflection: float
        The location of the right edge of the peak for integration
        TODO: This name is bad, change it
    integral: float
        The integral of the peak between postive_inflection and negative_inflection
    """

    centroid: float = INVALID_PEAK_CENTROID
    positive_inflection: float = 0.0
    negative_inflection: float = 0.0
    amplitude: float = 0.0
    uncorrected_amplitude: float = 0.0
    integral: float = 0.0