HyperbolaParam

Hyperbola parameters.

Attributes:

Name Type Description
semix float

The semi-major axis length of the hyperbola.
semiy float

The semi-minor axis length of the hyperbola.
x0 float

The x-coordinate of the hyperbola's center.
y0 float

The y-coordinate of the hyperbola's center.
std Optional[HyperbolaParam]

The standard deviation of the hyperbola parameters.
Source code in ffit/funcs/hyperbola.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@dataclass(frozen=True)
class HyperbolaParam(ParamDataclass):
    """Hyperbola parameters.

    Attributes:
        semix (float):
            The semi-major axis length of the hyperbola.
        semiy (float):
            The semi-minor axis length of the hyperbola.
        x0 (float):
            The x-coordinate of the hyperbola's center.
        y0 (float):
            The y-coordinate of the hyperbola's center.
        std (Optional[HyperbolaParam]):
            The standard deviation of the hyperbola parameters.
    """

    semix: float
    semiy: float
    x0: float
    y0: float
    std: "_t.Optional[HyperbolaParam]" = None