Inheritance diagram for lsst.scarlet.lite.blend.BlendBase:

Public Member Functions
tuple[int, int, int]	shape (self)

Box	bbox (self)

list[Component]	components (self)

Image	get_model (self, bool convolve=False, bool use_flux=False)

ScarletBlendData	to_data (self)

Static Public Attributes
list	sources [Source]

dict	metadata \| None

Detailed Description

A base class for blends that can be extended to add additional
functionality.

This class holds all of the sources and observation that are to be fit,
as well as performing fitting and joint initialization of the
spectral components (when applicable).

Parameters
----------
sources:
    The sources to fit.
observation:
    The observation that contains the images,
        PSF, etc. that are being fit.
metadata:
    Additional metadata to store with the blend.

Member Function Documentation

◆ bbox()

Box lsst.scarlet.lite.blend.BlendBase.bbox ( self )

The bounding box of the entire blend.

◆ components()

list[Component] lsst.scarlet.lite.blend.BlendBase.components ( self )

The list of all components in the blend.

Since the list of sources might change,
this is always built on the fly.

◆ get_model()

Image lsst.scarlet.lite.blend.BlendBase.get_model	(		self,
		bool	convolve = False,
		bool	use_flux = False )

Generate a model of the entire blend.

Parameters
----------
convolve:
    Whether to convolve the model with the observed PSF in each band.
use_flux:
    Whether to use the re-distributed flux associated with the sources
    instead of the component models.

Returns
-------
model:
    The model created by combining all of the source models.

Reimplemented in lsst.scarlet.lite.blend.Blend.

◆ shape()

tuple[int, int, int] lsst.scarlet.lite.blend.BlendBase.shape ( self )

Shape of the model for the entire `Blend`.

◆ to_data()

ScarletBlendData lsst.scarlet.lite.blend.BlendBase.to_data ( self )

Convert the blend into a serializable dictionary format.

Returns
-------
data:
    A dictionary containing all of the information needed to
    reconstruct the blend.