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 (99 lines) | stat: -rw-r--r-- 2,487 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
# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.

"""
Image objects subpackage
========================

This subpackage provides image data structures and utilities.

The subpackage is organized into the following modules:

- `roi`: Region of Interest (ROI) classes and parameters
- `object`: Main ImageObj class for handling 2D image data
- `creation`: Image 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.image import ImageObj`
will continue to work.
"""

# Import all public classes and functions from submodules
from .creation import (
    # Constants
    DEFAULT_TITLE,
    Checkerboard2DParam,
    Gauss2DParam,
    # Enums
    ImageDatatypes,
    ImageTypes,
    # Base parameter classes
    NewImageParam,
    NormalDistribution2DParam,
    PoissonDistribution2DParam,
    Ramp2DParam,
    Ring2DParam,
    SiemensStar2DParam,
    Sinc2DParam,
    SinusoidalGrating2DParam,
    UniformDistribution2DParam,
    # Specific parameter classes
    Zero2DParam,
    check_all_image_parameters_classes,
    # Factory and utility functions
    create_image,
    create_image_from_param,
    create_image_parameters,
    get_next_image_number,
    # Registration functions
    register_image_parameters_class,
)
from .object import (
    ImageObj,
)
from .roi import (
    # ROI classes
    BaseSingleImageROI,
    CircularROI,
    # Specific ROI types
    ImageROI,
    PolygonalROI,
    RectangularROI,
    ROI2DParam,
    # ROI utility function
    create_image_roi,
    create_image_roi_around_points,
)

# Define __all__ for explicit public API
__all__ = [
    "DEFAULT_TITLE",
    "BaseSingleImageROI",
    "Checkerboard2DParam",
    "CircularROI",
    "Gauss2DParam",
    "ImageDatatypes",
    "ImageObj",
    "ImageROI",
    "ImageTypes",
    "NewImageParam",
    "NormalDistribution2DParam",
    "PoissonDistribution2DParam",
    "PolygonalROI",
    "ROI2DParam",
    "Ramp2DParam",
    "RectangularROI",
    "Ring2DParam",
    "SiemensStar2DParam",
    "Sinc2DParam",
    "SinusoidalGrating2DParam",
    "UniformDistribution2DParam",
    "Zero2DParam",
    "check_all_image_parameters_classes",
    "create_image",
    "create_image_from_param",
    "create_image_parameters",
    "create_image_roi",
    "create_image_roi_around_points",
    "get_next_image_number",
    "register_image_parameters_class",
]