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
	n_components

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.

Definition at line 31 of file source.py.

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.source.Source.__init__	(		self,
		list[Component]	components )

Definition at line 43 of file source.py.

    def __init__(self, components: list[Component]):
        self.components = components
        self.flux_weighted_image: Image | None = None
 

Member Function Documentation

__repr__()

lsst.scarlet.lite.source.Source.__repr__

(

self

)

Definition at line 143 of file source.py.

    def __repr__(self):
        return f"Source(components={repr(self.components)})>"

__str__()

lsst.scarlet.lite.source.Source.__str__

(

self

)

Definition at line 140 of file source.py.

    def __str__(self):
        return f"Source<{len(self.components)}>"
 

bands()

tuple lsst.scarlet.lite.source.Source.bands

(

self

)

The bands in the full source model.

Definition at line 91 of file source.py.

    def bands(self) -> tuple:
        """The bands in the full source model."""
        if self.is_null:
            return ()
        return self.components[0].bands
 

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.

    def bbox(self) -> Box:
        """The minimal bounding box to contain all of this sources components
 
        Null sources have a bounding box with shape `(0,0,0)`
        """
        if self.n_components == 0:
            return Box((0, 0))
        bbox = self.components[0].bbox
        for component in self.components[1:]:
            bbox = bbox | component.bbox
        return bbox
 

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.

    def center(self) -> tuple[int, int] | None:
        """The center of the source in the full Blend."""
        if not self.is_null and hasattr(self.components[0], "peak"):
            return self.components[0].peak  # type: ignore
        return None
 

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.

    def get_model(self, use_flux: bool = False) -> Image:
        """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.
        """
        if self.n_components == 0:
            return 0  # type: ignore
 
        if use_flux:
            # Return the redistributed flux
            # (calculated by scarlet.lite.measure.weight_sources)
            return self.flux_weighted_image  # type: ignore
 
        model = self.components[0].get_model()
        for component in self.components[1:]:
            model = model + component.get_model()
        return model
 

is_null()

bool lsst.scarlet.lite.source.Source.is_null

(

self

)

True if the source does not have any components

Definition at line 73 of file source.py.

    def is_null(self) -> bool:
        """True if the source does not have any components"""
        return self.n_components == 0
 

n_components()

int lsst.scarlet.lite.source.Source.n_components

(

self

)

The number of components in this source

Definition at line 48 of file source.py.

    def n_components(self) -> int:
        """The number of components in this source"""
        return len(self.components)
 

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.

    def parameterize(self, parameterization: Callable):
        """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.
        """
        for component in self.components:
            component.parameterize(parameterization)
 

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.

    def source_center(self) -> tuple[int, int] | None:
        """The center of the source in its local bounding box."""
        _center = self.center
        _origin = self.bbox.origin
        if _center is not None:
            center = (
                _center[0] - _origin[0],
                _center[1] - _origin[1],
            )
            return center
        return None
 

Member Data Documentation

components

lsst.scarlet.lite.source.Source.components

Definition at line 44 of file source.py.

n_components

lsst.scarlet.lite.source.Source.n_components

Definition at line 75 of file source.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/scarlet_lite/gae0086650b+a8ce1bb630/python/lsst/scarlet/lite/source.py