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 model, 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	model (self)
Image	get_model (self)
tuple	shape (self)
np.ndarray	grad_model (self, np.ndarray input_grad, np.ndarray model)
np.ndarray	prox_model (self, np.ndarray model)
bool	resize (self, Box model_box)
	update (self, int it, np.ndarray grad_log_likelihood)
None	parameterize (self, Callable parameterization)
	__str__ (self)
	__repr__ (self)
Box	bbox (self)
tuple	bands (self)
ScarletComponentBaseData	to_data (self)

Public Attributes
	bg_rms = bg_rms
	bg_thresh = bg_thresh
	floor = floor
	peaks = peaks
	min_area = min_area
	model

Protected Attributes
	_model = parameter(model)
tuple	_bands = bands
Box	_bbox = bbox

Detailed Description

Implements a component with no spectral or monotonicty constraints

This is a FreeFormComponent that is not factorized into a
spectrum and morphology with no monotonicity constraint.

Definition at line 143 of file free_form.py.

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.models.free_form.FreeFormComponent.__init__	(		self,
		tuple	bands,
		np.ndarray | Parameter	model,
		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 )

Definition at line 150 of file free_form.py.

    ):
        super().__init__(bands=bands, bbox=model_bbox)
        self._model = parameter(model)
        self.bg_rms = bg_rms
        self.bg_thresh = bg_thresh
        self.floor = floor
        self.peaks = peaks
        self.min_area = min_area
 

Member Function Documentation

__repr__()

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

(

self

)

Definition at line 239 of file free_form.py.

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

__str__()

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

(

self

)

Definition at line 235 of file free_form.py.

    def __str__(self):
        result = f"FreeFormComponent<bands={self.bands}, shape={self.shape}>"
        return result
 

bands()

tuple lsst.scarlet.lite.component.Component.bands ( self )

inherited

The bands in the component model

Definition at line 71 of file component.py.

    def bands(self) -> tuple:
        """The bands in the component model"""
        return self._bands
 

bbox()

Box lsst.scarlet.lite.component.Component.bbox ( self )

inherited

The bounding box that contains the component in the full image

Definition at line 66 of file component.py.

    def bbox(self) -> Box:
        """The bounding box that contains the component in the full image"""
        return self._bbox
 

get_model()

Image lsst.scarlet.lite.models.free_form.FreeFormComponent.get_model

(

self

)

Generate a model for the component

This must be implemented in inherited classes.

Returns
-------
model: Image
    The image of the component model.

Reimplemented from lsst.scarlet.lite.component.Component.

Definition at line 173 of file free_form.py.

    def get_model(self) -> Image:
        return Image(self.model, bands=self.bands, yx0=cast(tuple[int, int], self.bbox.origin))
 

grad_model()

np.ndarray lsst.scarlet.lite.models.free_form.FreeFormComponent.grad_model	(		self,
		np.ndarray	input_grad,
		np.ndarray	model )

Definition at line 180 of file free_form.py.

    def grad_model(self, input_grad: np.ndarray, model: np.ndarray) -> np.ndarray:
        return input_grad
 

model()

np.ndarray lsst.scarlet.lite.models.free_form.FreeFormComponent.model

(

self

)

Definition at line 170 of file free_form.py.

    def model(self) -> np.ndarray:
        return self._model.x
 

parameterize()

None lsst.scarlet.lite.models.free_form.FreeFormComponent.parameterize	(		self,
		Callable	parameterization )

Convert the component parameter arrays into Parameter instances

Parameters
----------
parameterization: Callable
    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.

Reimplemented from lsst.scarlet.lite.component.Component.

Definition at line 219 of file free_form.py.

    def parameterize(self, parameterization: Callable) -> None:
        """Convert the component parameter arrays into Parameter instances
 
        Parameters
        ----------
        parameterization: Callable
            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.
        """
        # Update the spectrum and morph in place
        parameterization(self)
        # update the parameters
        self._model.grad = self.grad_model
        self._model.prox = self.prox_model
 

prox_model()

np.ndarray lsst.scarlet.lite.models.free_form.FreeFormComponent.prox_model	(		self,
		np.ndarray	model )

Definition at line 183 of file free_form.py.

    def prox_model(self, model: np.ndarray) -> np.ndarray:
        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[model < bg_thresh[:, None, None]] = 0
        else:
            # enforce positivity
            model[model < 0] = 0
 
        if self.peaks is not None:
            # Remove pixels not connected to one of the peaks
            model2d = np.sum(model, axis=0)
            footprint = get_connected_multipeak(model2d, self.peaks, 0)
            model = model * footprint[None, :, :]
 
        if self.min_area > 0:
            # Remove regions with fewer than min_area connected pixels
            model2d = np.sum(model, axis=0)
            footprints = get_footprints(model2d, 4.0, self.min_area, 0, 0, False)
            bbox = self.bbox.copy()
            bbox.origin = (0, 0)
            footprint_image = footprints_to_image(footprints, bbox)
            model = model * (footprint_image > 0).data[None, :, :]
 
        if np.all(model == 0):
            # If the model is all zeros, set a single pixel to the floor
            model[0, 0] = self.floor
 
        return model
 

resize()

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

Test whether or not the component needs to be resized

This should be overriden in inherited classes and return `True`
if the component needs to be resized.

Reimplemented from lsst.scarlet.lite.component.Component.

Definition at line 213 of file free_form.py.

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

shape()

tuple lsst.scarlet.lite.models.free_form.FreeFormComponent.shape

(

self

)

Definition at line 177 of file free_form.py.

    def shape(self) -> tuple:
        return self.model.shape
 

to_data()

ScarletComponentBaseData lsst.scarlet.lite.component.Component.to_data ( self )

inherited

Convert the component to persistable ScarletComponentBaseData

Returns
-------
component_data: ScarletComponentBaseData
    The data object containing the component information

Reimplemented in lsst.scarlet.lite.component.FactorizedComponent, lsst.scarlet.lite.io.cube_component.ComponentCube, and lsst.scarlet.lite.models.parametric.ParametricComponent.

Definition at line 120 of file component.py.

    def to_data(self) -> ScarletComponentBaseData:
        """Convert the component to persistable ScarletComponentBaseData
 
        Returns
        -------
        component_data: ScarletComponentBaseData
            The data object containing the component information
        """
 
 

update()

lsst.scarlet.lite.models.free_form.FreeFormComponent.update	(		self,
		int	it,
		np.ndarray	input_grad )

Update the component parameters from an input gradient

Parameters
----------
it:
    The current iteration of the optimizer.
input_grad:
    Gradient of the likelihood wrt the component model

Reimplemented from lsst.scarlet.lite.component.Component.

Definition at line 216 of file free_form.py.

    def update(self, it: int, grad_log_likelihood: np.ndarray):
        self._model.update(it, grad_log_likelihood)
 

Member Data Documentation

_bands

tuple lsst.scarlet.lite.component.Component._bands = bands

protectedinherited

Definition at line 62 of file component.py.

_bbox

Box lsst.scarlet.lite.component.Component._bbox = bbox

protectedinherited

Definition at line 63 of file component.py.

_model

lsst.scarlet.lite.models.free_form.FreeFormComponent._model = parameter(model)

protected

Definition at line 162 of file free_form.py.

bg_rms

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

Definition at line 163 of file free_form.py.

bg_thresh

lsst.scarlet.lite.models.free_form.FreeFormComponent.bg_thresh = bg_thresh

Definition at line 164 of file free_form.py.

floor

lsst.scarlet.lite.models.free_form.FreeFormComponent.floor = floor

Definition at line 165 of file free_form.py.

min_area

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

Definition at line 167 of file free_form.py.

model

lsst.scarlet.lite.models.free_form.FreeFormComponent.model

Definition at line 174 of file free_form.py.

peaks

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

Definition at line 166 of file free_form.py.

---

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+edbf708997/python/lsst/scarlet/lite/models/free_form.py