lsst.scarlet.lite.models.free_form.FreeFormComponent Class Reference

Inheritance diagram for lsst.scarlet.lite.models.free_form.FreeFormComponent:

Public Member Functions
	__init__ (self, tuple bands, np.ndarray|Parameter spectrum, np.ndarray|Parameter morph, Box model_bbox, float|None bg_thresh=None, np.ndarray|None bg_rms=None, float floor=1e-20, list[tuple[int, int]]|None peaks=None, float min_area=0)
np.ndarray	prox_spectrum (self, np.ndarray spectrum)
np.ndarray	prox_morph (self, np.ndarray morph)
bool	resize (self, Box model_box)
	__str__ (self)
	__repr__ (self)

Public Attributes
	peaks
	min_area
	bg_rms

Detailed Description

Implements a free-form component

With no constraints this component is typically either a garbage collector,
or part of a set of components to deconvolve an image by separating out
the different spectral components.

See `FactorizedComponent` for a list of parameters not shown here.

Parameters
----------
peaks: `list` of `tuple`
    A set of ``(cy, cx)`` peaks for detected sources.
    If peak is not ``None`` then only pixels in the same "footprint"
    as one of the peaks are included in the morphology.
    If `peaks` is ``None`` then there is no constraint applied.
min_area: float
    The minimum area for a peak.
    If `min_area` is not `None` then all regions of the morphology
    with fewer than `min_area` connected pixels are removed.

Definition at line 34 of file free_form.py.

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.models.free_form.FreeFormComponent.__init__	(		self,
		tuple	bands,
		np.ndarray | Parameter	spectrum,
		np.ndarray | Parameter	morph,
		Box	model_bbox,
		float | None	bg_thresh = None,
		np.ndarray | None	bg_rms = None,
		float	floor = 1e-20,
		list[tuple[int, int]] | None	peaks = None,
		float	min_area = 0 )

Reimplemented from lsst.scarlet.lite.component.FactorizedComponent.

Definition at line 56 of file free_form.py.

    ):
        super().__init__(
            bands=bands,
            spectrum=spectrum,
            morph=morph,
            bbox=model_bbox,
            peak=None,
            bg_rms=bg_rms,
            bg_thresh=bg_thresh,
            floor=floor,
        )
 
        self.peaks = peaks
        self.min_area = min_area
 

Member Function Documentation

__repr__()

lsst.scarlet.lite.models.free_form.FreeFormComponent.__repr__

(

self

)

Reimplemented from lsst.scarlet.lite.component.FactorizedComponent.

Definition at line 134 of file free_form.py.

    def __repr__(self):
        return self.__str__()

__str__()

lsst.scarlet.lite.models.free_form.FreeFormComponent.__str__

(

self

)

Reimplemented from lsst.scarlet.lite.component.FactorizedComponent.

Definition at line 127 of file free_form.py.

    def __str__(self):
        return (
            f"FreeFormComponent(\n    bands={self.bands}\n    "
            f"spectrum={self.spectrum})\n    center={self.peak}\n    "
            f"morph_shape={self.morph.shape}"
        )
 

prox_morph()

np.ndarray lsst.scarlet.lite.models.free_form.FreeFormComponent.prox_morph	(		self,
		np.ndarray	morph )

Apply a prox-like update to the morphology

This is the main difference between an `SedComponent` and a
`FactorizedComponent`, since this component has fewer constraints.

Reimplemented from lsst.scarlet.lite.component.FactorizedComponent.

Definition at line 94 of file free_form.py.

    def prox_morph(self, morph: np.ndarray) -> np.ndarray:
        """Apply a prox-like update to the morphology
 
        This is the main difference between an `SedComponent` and a
        `FactorizedComponent`, since this component has fewer constraints.
        """
        from lsst.scarlet.lite.detect_pybind11 import get_connected_multipeak, get_footprints  # type: ignore
 
        if self.bg_thresh is not None and isinstance(self.bg_rms, np.ndarray):
            bg_thresh = self.bg_rms * self.bg_thresh
            # Enforce background thresholding
            model = self.spectrum[:, None, None] * morph[None, :, :]
            morph[np.all(model < bg_thresh[:, None, None], axis=0)] = 0
        else:
            # enforce positivity
            morph[morph < 0] = 0
 
        if self.peaks is not None:
            morph = morph * get_connected_multipeak(morph > 0, self.peaks, 0)
 
        if self.min_area > 0:
            footprints = get_footprints(morph > 0, 4.0, self.min_area, 0, False)
            footprint_image = footprints_to_image(footprints, cast(tuple[int, int], morph.shape))
            morph = morph * (footprint_image > 0).data
 
        if np.all(morph == 0):
            morph[0, 0] = self.floor
 
        return morph
 

prox_spectrum()

np.ndarray lsst.scarlet.lite.models.free_form.FreeFormComponent.prox_spectrum	(		self,
		np.ndarray	spectrum )

Apply a prox-like update to the spectrum

This differs from `FactorizedComponent` because an
`SedComponent` has the spectrum normalized to unity.

Reimplemented from lsst.scarlet.lite.component.FactorizedComponent.

Definition at line 82 of file free_form.py.

    def prox_spectrum(self, spectrum: np.ndarray) -> np.ndarray:
        """Apply a prox-like update to the spectrum
 
        This differs from `FactorizedComponent` because an
        `SedComponent` has the spectrum normalized to unity.
        """
        # prevent divergent spectrum
        spectrum[spectrum < self.floor] = self.floor
        # Normalize the spectrum
        spectrum = spectrum / np.sum(spectrum)
        return spectrum
 

resize()

bool lsst.scarlet.lite.models.free_form.FreeFormComponent.resize	(		self,
		Box	model_box )

Test whether or not the component needs to be resized

Reimplemented from lsst.scarlet.lite.component.FactorizedComponent.

Definition at line 124 of file free_form.py.

    def resize(self, model_box: Box) -> bool:
        return False
 

Member Data Documentation

bg_rms

lsst.scarlet.lite.models.free_form.FreeFormComponent.bg_rms

Definition at line 102 of file free_form.py.

min_area

lsst.scarlet.lite.models.free_form.FreeFormComponent.min_area

Definition at line 80 of file free_form.py.

peaks

lsst.scarlet.lite.models.free_form.FreeFormComponent.peaks

Definition at line 79 of file free_form.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/scarlet_lite/gee10cc3b42+a6fc98d2e7/python/lsst/scarlet/lite/models/free_form.py