GaussianParam

Gaussian parameters.

mu (float):
    The  Gaussian peak.
sigma (float):
    The sqrt of the standard deviation.
amplitude (float):
    Teh normalization factor.
offset (float):
    The baseline offset from zero.

Attention to not use std as it is reserved for standard deviation of the parameters.

Source code in ffit/funcs/gaussian.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@dataclass(frozen=True)
class GaussianParam(ParamDataclass):
    """Gaussian parameters.

    Attributes:
    -----------------
        mu (float):
            The  Gaussian peak.
        sigma (float):
            The sqrt of the standard deviation.
        amplitude (float):
            Teh normalization factor.
        offset (float):
            The baseline offset from zero.

    Attention to not use `std` as it is reserved for standard deviation of the parameters.
    """

    mu: float
    sigma: float
    amplitude: float
    offset: float
    std: "_t.Optional[GaussianParam]" = None