Inheritance diagram for lsst.scarlet.lite.models.parametric.ParametricComponent:

Public Member Functions
	__init__ (self, tuple bands, Box bbox, Parameter\|np.ndarray spectrum, Parameter\|np.ndarray morph_params, Callable morph_func, Callable morph_grad, Callable morph_prox, Callable\|np.ndarray morph_step, Callable\|None prox_spectrum=None, float floor=1e-20)

tuple[float, float]	peak (self)

float	y0 (self)

float	x0 (self)

np.ndarray	spectrum (self)

CartesianFrame	frame (self)

np.ndarray	radial_params (self)

np.ndarray	morph (self, CartesianFrame\|None frame=None)

Callable	prox_morph (self)

Callable	grad_morph (self)

Callable	morph_step (self)

Image	get_model (self, CartesianFrame\|None frame=None)

np.ndarray	prox_spectrum (self, np.ndarray spectrum)

np.ndarray	grad_spectrum (self, np.ndarray input_grad, np.ndarray spectrum, np.ndarray morph)

	update (self, int it, np.ndarray input_grad)

bool	resize (self, Box model_box)

None	parameterize (self, Callable parameterization)

ScarletComponentBaseData	to_data (self)

Box	bbox (self)

tuple	bands (self)

Public Attributes
	floor = floor

	y0

	radial_params

	frame

Protected Member Functions
np.ndarray	_get_morph (self, CartesianFrame\|None frame=None)

Protected Attributes
	_spectrum = parameter(spectrum)

	_params = parameter(morph_params)

	_func = morph_func

	_morph_grad = morph_grad

	_morph_prox = morph_prox

Callable	_morph_step = morph_step

Callable	_prox_spectrum = self.prox_spectrum

tuple	_bands = bands

Box	_bbox = bbox

Detailed Description

A parametric model of an astrophysical source

Parameters
----------
bands:
    The bands used in the model.
bbox:
    The bounding box that holds the model.
spectrum:
    The spectrum of the component.
morph_params:
    The parameters of the morphology.
morph_func:
    The function to generate the 2D morphology image
    based on `morphParams`.
morph_grad:
    The function to calculate the gradient of the
    likelihood wrt the morphological parameters.
morph_prox:
    The proximal operator for the morphology parameters.
morph_step:
    The function that calculates the gradient of the
    morphological model.
prox_spectrum:
    Proximal operator for the spectrum.
    If `prox_spectrum` is `None` then the default proximal
    operator `self.prox_spectrum` is used.
floor:
    The minimum value of the spectrum, used to prevent
    divergences in the gradients.

Definition at line 636 of file parametric.py.

Constructor & Destructor Documentation

◆ init()

lsst.scarlet.lite.models.parametric.ParametricComponent.__init__	(		self,
		tuple	bands,
		Box	bbox,
		Parameter \| np.ndarray	spectrum,
		Parameter \| np.ndarray	morph_params,
		Callable	morph_func,
		Callable	morph_grad,
		Callable	morph_prox,
		Callable \| np.ndarray	morph_step,
		Callable \| None	prox_spectrum = None,
		float	floor = 1e-20 )

Definition at line 669 of file parametric.py.

    ):
        super().__init__(bands=bands, bbox=bbox)
 
        self._spectrum = parameter(spectrum)
        self._params = parameter(morph_params)
        self._func = morph_func
        self._morph_grad = morph_grad
        self._morph_prox = morph_prox
        self._morph_step = morph_step
        self._bbox = bbox
        if prox_spectrum is None:
            self._prox_spectrum: Callable = self.prox_spectrum
        else:
            self._prox_spectrum = prox_spectrum
        self.floor = floor
 

Member Function Documentation

◆ _get_morph()

np.ndarray lsst.scarlet.lite.models.parametric.ParametricComponent._get_morph	(		self,
		CartesianFrame \| None	frame = None )

protected

The 2D image of the morphology

This callable generates an image of the morphology
in the given frame.

Parameters
----------
frame:
    The frame (bounding box, pixel grid) that the image is
    placed in.

Returns
-------
result:
    The image of the morphology in the `frame`.

Definition at line 727 of file parametric.py.

    def _get_morph(self, frame: CartesianFrame | None = None) -> np.ndarray:
        """The 2D image of the morphology
 
        This callable generates an image of the morphology
        in the given frame.
 
        Parameters
        ----------
        frame:
            The frame (bounding box, pixel grid) that the image is
            placed in.
 
        Returns
        -------
        result:
            The image of the morphology in the `frame`.
        """
        if frame is None:
            frame = self.frame
        return self._func(self.radial_params, frame)
 

◆ 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
 

◆ frame()

CartesianFrame lsst.scarlet.lite.models.parametric.ParametricComponent.frame ( self )

The coordinate system that contains the model

Reimplemented in lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.

Definition at line 718 of file parametric.py.

    def frame(self) -> CartesianFrame:
        """The coordinate system that contains the model"""
        return CartesianFrame(self._bbox)
 

◆ get_model()

Image lsst.scarlet.lite.models.parametric.ParametricComponent.get_model	(		self,
		CartesianFrame \| None	frame = None )

Generate the full model for this component

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

Definition at line 772 of file parametric.py.

    def get_model(self, frame: CartesianFrame | None = None) -> Image:
        """Generate the full model for this component"""
        model = self.spectrum[:, None, None] * self._get_morph(frame)[None, :, :]
        return Image(model, bands=self.bands, yx0=cast(tuple[int, int], self.bbox.origin[-2:]))
 

◆ grad_morph()

Callable lsst.scarlet.lite.models.parametric.ParametricComponent.grad_morph ( self )

The function that calculates the gradient of the
morphological model

Definition at line 759 of file parametric.py.

    def grad_morph(self) -> Callable:
        """The function that calculates the gradient of the
        morphological model
        """
        return self._morph_grad
 

◆ grad_spectrum()

np.ndarray lsst.scarlet.lite.models.parametric.ParametricComponent.grad_spectrum	(		self,
		np.ndarray	input_grad,
		np.ndarray	spectrum,
		np.ndarray	morph )

Gradient of the spectrum wrt. the component model

Parameters
----------
input_grad:
    Gradient of the likelihood wrt the component model
spectrum:
    The model of the spectrum.
morph:
    The model of the morphology.

Returns
-------
result:
    The gradient of the likelihood wrt. the spectrum.

Definition at line 789 of file parametric.py.

    def grad_spectrum(self, input_grad: np.ndarray, spectrum: np.ndarray, morph: np.ndarray) -> np.ndarray:
        """Gradient of the spectrum wrt. the component model
 
        Parameters
        ----------
        input_grad:
            Gradient of the likelihood wrt the component model
        spectrum:
            The model of the spectrum.
        morph:
            The model of the morphology.
 
        Returns
        -------
        result:
            The gradient of the likelihood wrt. the spectrum.
        """
        return np.einsum("...jk,jk", input_grad, morph)
 

◆ morph()

np.ndarray lsst.scarlet.lite.models.parametric.ParametricComponent.morph	(		self,
		CartesianFrame \| None	frame = None )

The morphological model

Definition at line 749 of file parametric.py.

    def morph(self, frame: CartesianFrame | None = None) -> np.ndarray:
        """The morphological model"""
        return self._get_morph(frame)
 

◆ morph_step()

Callable lsst.scarlet.lite.models.parametric.ParametricComponent.morph_step ( self )

The function that calculates the gradient of the
morphological model

Definition at line 766 of file parametric.py.

    def morph_step(self) -> Callable:
        """The function that calculates the gradient of the
        morphological model
        """
        return cast(Callable, self._morph_step)
 

◆ parameterize()

None lsst.scarlet.lite.models.parametric.ParametricComponent.parameterize	(		self,
		Callable	parameterization )

Convert the component parameter arrays into Parameter instances

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

Definition at line 832 of file parametric.py.

    def parameterize(self, parameterization: Callable) -> None:
        """Convert the component parameter arrays into Parameter instances"""
        # Update the spectrum and morph in place
        parameterization(self)
        # update the parameters
        self._spectrum.grad = self.grad_spectrum
        self._spectrum.prox = self.prox_spectrum
        self._params.grad = self.grad_morph
        self._params.prox = self.prox_morph
 

◆ peak()

tuple[float, float] lsst.scarlet.lite.models.parametric.ParametricComponent.peak ( self )

The center of the component

Definition at line 698 of file parametric.py.

    def peak(self) -> tuple[float, float]:
        """The center of the component"""
        return self.y0, self.x0
 

◆ prox_morph()

Callable lsst.scarlet.lite.models.parametric.ParametricComponent.prox_morph ( self )

The function used to constrain the morphological model

Definition at line 754 of file parametric.py.

    def prox_morph(self) -> Callable:
        """The function used to constrain the morphological model"""
        return self._morph_prox
 

◆ prox_spectrum()

np.ndarray lsst.scarlet.lite.models.parametric.ParametricComponent.prox_spectrum	(		self,
		np.ndarray	spectrum )

Apply a prox-like update to the spectrum

Parameters
----------
spectrum:
    The spectrum of the model.

Definition at line 777 of file parametric.py.

    def prox_spectrum(self, spectrum: np.ndarray) -> np.ndarray:
        """Apply a prox-like update to the spectrum
 
        Parameters
        ----------
        spectrum:
            The spectrum of the model.
        """
        # prevent divergent spectrum
        spectrum[spectrum < self.floor] = self.floor
        return spectrum
 

◆ radial_params()

np.ndarray lsst.scarlet.lite.models.parametric.ParametricComponent.radial_params ( self )

The parameters used to model the radial function

Reimplemented in lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.

Definition at line 723 of file parametric.py.

    def radial_params(self) -> np.ndarray:
        """The parameters used to model the radial function"""
        return self._params.x
 

◆ resize()

bool lsst.scarlet.lite.models.parametric.ParametricComponent.resize	(		self,
		Box	model_box )

Resize the box that contains the model

Not yet implemented, so for now the model box
does not grow. If this is ever implemented in production,
in the long run this will be based on a cutoff value for the model.

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

Definition at line 823 of file parametric.py.

    def resize(self, model_box: Box) -> bool:
        """Resize the box that contains the model
 
        Not yet implemented, so for now the model box
        does not grow. If this is ever implemented in production,
        in the long run this will be based on a cutoff value for the model.
        """
        return False
 

◆ spectrum()

np.ndarray lsst.scarlet.lite.models.parametric.ParametricComponent.spectrum ( self )

The array of spectrum values

Definition at line 713 of file parametric.py.

    def spectrum(self) -> np.ndarray:
        """The array of spectrum values"""
        return self._spectrum.x
 

◆ to_data()

ScarletComponentBaseData lsst.scarlet.lite.models.parametric.ParametricComponent.to_data ( self )

Convert the component to persistable ScarletComponentBaseData

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

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

Definition at line 842 of file parametric.py.

    def to_data(self) -> ScarletComponentBaseData:
        raise NotImplementedError("Saving elliptical parametric components is not yet implemented")

◆ update()

lsst.scarlet.lite.models.parametric.ParametricComponent.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.

Reimplemented in lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.

Definition at line 808 of file parametric.py.

    def update(self, it: int, input_grad: np.ndarray):
        """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
        """
        spectrum = self.spectrum.copy()
        morph = self.morph
        self._spectrum.update(it, input_grad, morph)
        self._params.update(it, input_grad, morph, spectrum, self.frame)
 

◆ x0()

float lsst.scarlet.lite.models.parametric.ParametricComponent.x0 ( self )

The x-center of the component

Definition at line 708 of file parametric.py.

    def x0(self) -> float:
        """The x-center of the component"""
        return self._params.x[1]
 

◆ y0()

float lsst.scarlet.lite.models.parametric.ParametricComponent.y0 ( self )

The y-center of the component

Definition at line 703 of file parametric.py.

    def y0(self) -> float:
        """The y-center of the component"""
        return self._params.x[0]
 

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.

◆ _func

lsst.scarlet.lite.models.parametric.ParametricComponent._func = morph_func

protected

Definition at line 686 of file parametric.py.

◆ _morph_grad

lsst.scarlet.lite.models.parametric.ParametricComponent._morph_grad = morph_grad

protected

Definition at line 687 of file parametric.py.

◆ _morph_prox

lsst.scarlet.lite.models.parametric.ParametricComponent._morph_prox = morph_prox

protected

Definition at line 688 of file parametric.py.

◆ _morph_step

lsst.scarlet.lite.models.parametric.ParametricComponent._morph_step = morph_step

protected

Definition at line 689 of file parametric.py.

◆ _params

lsst.scarlet.lite.models.parametric.ParametricComponent._params = parameter(morph_params)

protected

Definition at line 685 of file parametric.py.

◆ _prox_spectrum

Callable lsst.scarlet.lite.models.parametric.ParametricComponent._prox_spectrum = self.prox_spectrum

protected

Definition at line 692 of file parametric.py.

◆ _spectrum

lsst.scarlet.lite.models.parametric.ParametricComponent._spectrum = parameter(spectrum)

protected

Definition at line 684 of file parametric.py.

◆ floor

lsst.scarlet.lite.models.parametric.ParametricComponent.floor = floor

Definition at line 695 of file parametric.py.

◆ frame

lsst.scarlet.lite.models.parametric.ParametricComponent.frame

Reimplemented in lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.

Definition at line 821 of file parametric.py.

◆ radial_params

lsst.scarlet.lite.models.parametric.ParametricComponent.radial_params

Reimplemented in lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.

Definition at line 746 of file parametric.py.

◆ y0

lsst.scarlet.lite.models.parametric.ParametricComponent.y0

Definition at line 700 of file parametric.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/scarlet_lite/g00274db5b6+edbf708997/python/lsst/scarlet/lite/models/parametric.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _get_morph()

◆ bands()

◆ bbox()

◆ frame()

◆ get_model()

◆ grad_morph()

◆ grad_spectrum()

◆ morph()

◆ morph_step()

◆ parameterize()

◆ peak()

◆ prox_morph()

◆ prox_spectrum()

◆ radial_params()

◆ resize()

◆ spectrum()

◆ to_data()

◆ update()

◆ x0()

◆ y0()

Member Data Documentation

◆ _bands

◆ _bbox

◆ _func

◆ _morph_grad

◆ _morph_prox

◆ _morph_step

◆ _params

◆ _prox_spectrum

◆ _spectrum

◆ floor

◆ frame

◆ radial_params

◆ y0

◆ init()