lsst.scarlet.lite.source.Source Class Reference
Inheritance diagram for lsst.scarlet.lite.source.Source:
Public Member Functions | |
| __init__ (self, list[Component] components, dict|None metadata=None) | |
| 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) | |
| ScarletSourceData | to_data (self) |
| __str__ (self) | |
| __repr__ (self) | |
Public Attributes | |
| components = components | |
| Image|None | flux_weighted_image = None |
| int | n_components = 0 |
| is_null | |
Static Public Attributes | |
| dict | metadata = None |
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, | ||
| dict | None | metadata = None ) |
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 105 of file source.py.
105 def bbox(self) -> Box:
106 """The minimal bounding box to contain all of this sources components
107
108 Null sources have a bounding box with shape `(0,0,0)`
109 """
110 if self.n_components == 0:
111 return Box((0, 0))
112 bbox = self.components[0].bbox
113 for component in self.components[1:]:
114 bbox = bbox | component.bbox
115 return bbox
116
◆ center()
| tuple[int, int] | None lsst.scarlet.lite.source.Source.center | ( | self | ) |
The center of the source in the full Blend.
Definition at line 80 of file source.py.
80 def center(self) -> tuple[int, int] | None:
81 """The center of the source in the full Blend."""
82 if not self.is_null and hasattr(self.components[0], "peak"):
83 return self.components[0].peak # type: ignore
84 return None
85
◆ 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 124 of file source.py.
124 def get_model(self, use_flux: bool = False) -> Image:
125 """Build the model for the source
126
127 This is never called during optimization and is only used
128 to generate a model of the source for investigative purposes.
129
130 Parameters
131 ----------
132 use_flux:
133 Whether to use the re-distributed flux associated with the source
134 instead of the component models.
135
136 Returns
137 -------
138 model:
139 The full-color model.
140 """
141 if self.n_components == 0:
142 return 0 # type: ignore
143
144 if use_flux:
145 # Return the redistributed flux
146 # (calculated by scarlet.lite.measure.weight_sources)
147 return self.flux_weighted_image # type: ignore
148
149 model = self.components[0].get_model()
150 for component in self.components[1:]:
151 model = model + component.get_model()
152 return model
153
◆ 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 154 of file source.py.
154 def parameterize(self, parameterization: Callable):
155 """Convert the component parameter arrays into Parameter instances
156
157 Parameters
158 ----------
159 parameterization:
160 A function to use to convert parameters of a given type into
161 a `Parameter` in place. It should take a single argument that
162 is the `Component` or `Source` that is to be parameterized.
163 """
164 for component in self.components:
165 component.parameterize(parameterization)
166
◆ 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 87 of file source.py.
87 def source_center(self) -> tuple[int, int] | None:
88 """The center of the source in its local bounding box."""
89 _center = self.center
90 _origin = self.bbox.origin
91 if _center is not None:
92 center = (
93 _center[0] - _origin[0],
94 _center[1] - _origin[1],
95 )
96 return center
97 return None
98
◆ to_data()
| ScarletSourceData lsst.scarlet.lite.source.Source.to_data | ( | self | ) |
Convert to a `ScarletSourceData` for serialization
Returns
-------
source_data:
The `ScarletSourceData` representation of this source.
Reimplemented from lsst.scarlet.lite.source.SourceBase.
Definition at line 167 of file source.py.
167 def to_data(self) -> ScarletSourceData:
168 """Convert to a `ScarletSourceData` for serialization
169
170 Returns
171 -------
172 source_data:
173 The `ScarletSourceData` representation of this source.
174 """
175 from .io import ScarletSourceData
176
177 component_data = [c.to_data() for c in self.components]
178 return ScarletSourceData(components=component_data, metadata=self.metadata)
179
Member Data Documentation
◆ components
◆ flux_weighted_image
| Image | None lsst.scarlet.lite.source.Source.flux_weighted_image = None |
◆ is_null
◆ metadata
|
staticinherited |
◆ n_components
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/scarlet_lite/ga2180abaac+8c5ae1fdc5/python/lsst/scarlet/lite/source.py
Generated on Mon Nov 3 2025 08:01:57 for LSST Applications by
1.13.2