File: __init__.py

package info (click to toggle)
python-sigima 1.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 24,956 kB
  • sloc: python: 33,326; makefile: 3
file content (154 lines) | stat: -rw-r--r-- 3,743 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.

"""
Sigima
======

Sigima is a scientific computing engine for 1D signals and 2D images.

It provides a set of tools for image and signal processing, including
denoising, segmentation, and restoration. It is designed to be used in
scientific and research applications.

It is a part of the DataLab Platform, which aims at providing a
comprehensive set of tools for data analysis and visualization, around
the DataLab application.
"""

# TODO: Use `numpy.typing.NDArray` for more precise type annotations once NumPy >= 1.21
# can be safely required (e.g. after raising the minimum required version of
# scikit-image to >= 0.19).

__all__ = [
    "NO_ROI",
    "Checkerboard2DParam",
    "CircularROI",
    "ExponentialParam",
    "Gauss2DParam",
    "GaussParam",
    "GeometryResult",
    "ImageDatatypes",
    "ImageObj",
    "ImageROI",
    "ImageTypes",
    "KindShape",
    "LinearChirpParam",
    "LogisticParam",
    "LorentzParam",
    "NormalDistribution1DParam",
    "NormalDistribution2DParam",
    "PlanckParam",
    "PolygonalROI",
    "ROI1DParam",
    "ROI2DParam",
    "Ramp2DParam",
    "RectangularROI",
    "Ring2DParam",
    "SegmentROI",
    "SiemensStar2DParam",
    "SignalObj",
    "SignalROI",
    "SignalTypes",
    "SimpleBaseProxy",
    "SimpleRemoteProxy",
    "Sinc2DParam",
    "SinusoidalGrating2DParam",
    "StepParam",
    "TableResult",
    "TypeObj",
    "TypeROI",
    "UniformDistribution1DParam",
    "UniformDistribution2DParam",
    "VoigtParam",
    "calc_table_from_data",
    "create_image",
    "create_image_from_param",
    "create_image_parameters",
    "create_image_roi",
    "create_image_roi_around_points",
    "create_signal",
    "create_signal_from_param",
    "create_signal_parameters",
    "create_signal_roi",
    "read_image",
    "read_images",
    "read_signal",
    "read_signals",
    "write_image",
    "write_signal",
]


from guidata.config import ValidationMode, set_validation_mode

from sigima.client import SimpleBaseProxy, SimpleRemoteProxy
from sigima.io import (
    read_image,
    read_images,
    read_signal,
    read_signals,
    write_image,
    write_signal,
)
from sigima.objects import (
    NO_ROI,
    Checkerboard2DParam,
    CircularROI,
    ExponentialParam,
    Gauss2DParam,
    GaussParam,
    GeometryResult,
    ImageDatatypes,
    ImageObj,
    ImageROI,
    ImageTypes,
    KindShape,
    LinearChirpParam,
    LogisticParam,
    LorentzParam,
    NormalDistribution1DParam,
    NormalDistribution2DParam,
    PlanckParam,
    PolygonalROI,
    Ramp2DParam,
    RectangularROI,
    Ring2DParam,
    ROI1DParam,
    ROI2DParam,
    SegmentROI,
    SiemensStar2DParam,
    SignalObj,
    SignalROI,
    SignalTypes,
    Sinc2DParam,
    SinusoidalGrating2DParam,
    StepParam,
    TableResult,
    TypeObj,
    TypeROI,
    UniformDistribution1DParam,
    UniformDistribution2DParam,
    VoigtParam,
    calc_table_from_data,
    create_image,
    create_image_from_param,
    create_image_parameters,
    create_image_roi,
    create_image_roi_around_points,
    create_signal,
    create_signal_from_param,
    create_signal_parameters,
    create_signal_roi,
)

# Set validation mode to ENABLED by default (issue warnings for invalid inputs)
set_validation_mode(ValidationMode.ENABLED)

__version__ = "1.0.3"
__docurl__ = "https://sigima.readthedocs.io/"
__homeurl__ = "https://github.com/DataLab-Platform/Sigima"
__supporturl__ = "https://github.com/DataLab-Platform/sigima/issues/new/choose"

# Dear (Debian, RPM, ...) package makers, please feel free to customize the
# following path to module's data (images) and translations:
DATAPATH = LOCALEPATH = ""