lsst.scarlet.lite.source.Source Class Reference
Public Member Functions | |
| __init__ (self, list[Component] components) | |
| int | n_components (self) |
| tuple[int, int]|None | center (self) |
| tuple[int, int]|None | source_center (self) |
| bool | is_null (self) |
| Box | bbox (self) |
| tuple | bands (self) |
| Image | get_model (self, bool use_flux=False) |
| parameterize (self, Callable parameterization) | |
| __str__ (self) | |
| __repr__ (self) | |
Public Attributes | |
| components = components | |
| Image|None | flux_weighted_image = None |
| int | n_components = 0 |
| is_null | |
Detailed Description
A container for components associated with the same astrophysical object
A source can have a single component, or multiple components,
and each can be contained in different bounding boxes.
Parameters
----------
components:
The components contained in the source.
Constructor & Destructor Documentation
◆ __init__()
| lsst.scarlet.lite.source.Source.__init__ | ( | self, | |
| list[Component] | components ) |
Member Function Documentation
◆ __repr__()
| lsst.scarlet.lite.source.Source.__repr__ | ( | self | ) |
◆ __str__()
| lsst.scarlet.lite.source.Source.__str__ | ( | self | ) |
◆ bands()
| tuple lsst.scarlet.lite.source.Source.bands | ( | self | ) |
◆ bbox()
| Box lsst.scarlet.lite.source.Source.bbox | ( | self | ) |
The minimal bounding box to contain all of this sources components Null sources have a bounding box with shape `(0,0,0)`
Definition at line 78 of file source.py.
78 def bbox(self) -> Box:
79 """The minimal bounding box to contain all of this sources components
80
81 Null sources have a bounding box with shape `(0,0,0)`
82 """
83 if self.n_components == 0:
84 return Box((0, 0))
85 bbox = self.components[0].bbox
86 for component in self.components[1:]:
87 bbox = bbox | component.bbox
88 return bbox
89
◆ center()
| tuple[int, int] | None lsst.scarlet.lite.source.Source.center | ( | self | ) |
The center of the source in the full Blend.
Definition at line 53 of file source.py.
53 def center(self) -> tuple[int, int] | None:
54 """The center of the source in the full Blend."""
55 if not self.is_null and hasattr(self.components[0], "peak"):
56 return self.components[0].peak # type: ignore
57 return None
58
◆ get_model()
| Image lsst.scarlet.lite.source.Source.get_model | ( | self, | |
| bool | use_flux = False ) |
Build the model for the source
This is never called during optimization and is only used
to generate a model of the source for investigative purposes.
Parameters
----------
use_flux:
Whether to use the re-distributed flux associated with the source
instead of the component models.
Returns
-------
model:
The full-color model.
Definition at line 97 of file source.py.
97 def get_model(self, use_flux: bool = False) -> Image:
98 """Build the model for the source
99
100 This is never called during optimization and is only used
101 to generate a model of the source for investigative purposes.
102
103 Parameters
104 ----------
105 use_flux:
106 Whether to use the re-distributed flux associated with the source
107 instead of the component models.
108
109 Returns
110 -------
111 model:
112 The full-color model.
113 """
114 if self.n_components == 0:
115 return 0 # type: ignore
116
117 if use_flux:
118 # Return the redistributed flux
119 # (calculated by scarlet.lite.measure.weight_sources)
120 return self.flux_weighted_image # type: ignore
121
122 model = self.components[0].get_model()
123 for component in self.components[1:]:
124 model = model + component.get_model()
125 return model
126
◆ is_null()
| bool lsst.scarlet.lite.source.Source.is_null | ( | self | ) |
◆ n_components()
| int lsst.scarlet.lite.source.Source.n_components | ( | self | ) |
◆ parameterize()
| lsst.scarlet.lite.source.Source.parameterize | ( | self, | |
| Callable | parameterization ) |
Convert the component parameter arrays into Parameter instances
Parameters
----------
parameterization:
A function to use to convert parameters of a given type into
a `Parameter` in place. It should take a single argument that
is the `Component` or `Source` that is to be parameterized.
Definition at line 127 of file source.py.
127 def parameterize(self, parameterization: Callable):
128 """Convert the component parameter arrays into Parameter instances
129
130 Parameters
131 ----------
132 parameterization:
133 A function to use to convert parameters of a given type into
134 a `Parameter` in place. It should take a single argument that
135 is the `Component` or `Source` that is to be parameterized.
136 """
137 for component in self.components:
138 component.parameterize(parameterization)
139
◆ source_center()
| tuple[int, int] | None lsst.scarlet.lite.source.Source.source_center | ( | self | ) |
The center of the source in its local bounding box.
Definition at line 60 of file source.py.
60 def source_center(self) -> tuple[int, int] | None:
61 """The center of the source in its local bounding box."""
62 _center = self.center
63 _origin = self.bbox.origin
64 if _center is not None:
65 center = (
66 _center[0] - _origin[0],
67 _center[1] - _origin[1],
68 )
69 return center
70 return None
71
Member Data Documentation
◆ components
◆ flux_weighted_image
| Image | None lsst.scarlet.lite.source.Source.flux_weighted_image = None |
◆ is_null
◆ n_components
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.1.0/Linux/scarlet_lite/g04e9c324dd+8c5ae1fdc5/python/lsst/scarlet/lite/source.py
Generated on Sun Aug 31 2025 07:01:51 for LSST Applications by
1.13.2