File: __init__.py

package info (click to toggle)
python-sigima 1.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 25,608 kB
  • sloc: python: 35,251; makefile: 3
file content (133 lines) | stat: -rw-r--r-- 3,218 bytes parent folder | download
1
2
3
4
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.

"""
Signal objects subpackage
=========================

This subpackage provides signal data structures and utilities.

The subpackage is organized into the following modules:

- `roi`: Region of Interest (ROI) classes and parameters for 1D signals
- `object`: Main SignalObj class for handling 1D signal data
- `creation`: Signal creation utilities and parameter classes

All classes and functions are re-exported at the subpackage level for backward
compatibility. Existing imports like `from sigima.objects.signal import SignalObj`
will continue to work.
"""

# Import all public classes and functions from submodules
from .creation import (
    # Constants
    DEFAULT_TITLE,
    # Mathematical function parameter classes
    BaseGaussLorentzVoigtParam,
    BasePeriodicParam,
    BasePulseParam,
    CosineParam,
    CustomSignalParam,
    # Pulse signal classes
    ExpectedFeatures,
    ExponentialParam,
    FeatureTolerances,
    # Periodic function parameter classes
    FreqUnits,
    GaussParam,
    # Other signal types
    LinearChirpParam,
    LogisticParam,
    LorentzParam,
    # Base parameter classes
    NewSignalParam,
    NormalDistribution1DParam,
    PlanckParam,
    PoissonDistribution1DParam,
    # Polynomial and custom signals
    PolyParam,
    PulseParam,
    SawtoothParam,
    # Enums
    SignalTypes,
    SincParam,
    SineParam,
    SquareParam,
    SquarePulseParam,
    StepParam,
    StepPulseParam,
    TriangleParam,
    UniformDistribution1DParam,
    VoigtParam,
    # Distribution parameter classes
    ZeroParam,
    check_all_signal_parameters_classes,
    # Core creation functions
    create_signal,
    create_signal_from_param,
    # Factory and utility functions
    create_signal_parameters,
    get_next_signal_number,
    # Registration functions
    register_signal_parameters_class,
    triangle_func,
)
from .object import (
    # Main signal class
    SignalObj,
)
from .roi import (
    # ROI classes
    ROI1DParam,
    SegmentROI,
    SignalROI,
    # ROI functions
    create_signal_roi,
)

# Define __all__ for explicit public API
__all__ = [
    "DEFAULT_TITLE",
    "BaseGaussLorentzVoigtParam",
    "BasePeriodicParam",
    "BasePulseParam",
    "CosineParam",
    "CustomSignalParam",
    "ExpectedFeatures",
    "ExponentialParam",
    "FeatureTolerances",
    "FreqUnits",
    "GaussParam",
    "LinearChirpParam",
    "LogisticParam",
    "LorentzParam",
    "NewSignalParam",
    "NormalDistribution1DParam",
    "PlanckParam",
    "PoissonDistribution1DParam",
    "PolyParam",
    "PulseParam",
    "ROI1DParam",
    "SawtoothParam",
    "SegmentROI",
    "SignalObj",
    "SignalROI",
    "SignalTypes",
    "SincParam",
    "SineParam",
    "SquareParam",
    "SquarePulseParam",
    "StepParam",
    "StepPulseParam",
    "TriangleParam",
    "UniformDistribution1DParam",
    "VoigtParam",
    "ZeroParam",
    "check_all_signal_parameters_classes",
    "create_signal",
    "create_signal_from_param",
    "create_signal_parameters",
    "create_signal_roi",
    "get_next_signal_number",
    "register_signal_parameters_class",
    "triangle_func",
]