lsst.scarlet.lite.models.parametric.EllipticalParametricComponent Class Reference

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

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)
float	semi_major (self)
float	semi_minor (self)
float	theta (self)
np.ndarray	ellipse_params (self)
np.ndarray	radial_params (self)
EllipseFrame	frame (self)
Callable	morph_prox (self)
Callable	morph_grad (self)
	update (self, int it, np.ndarray input_grad)

Public Attributes
	ellipse_params

Protected Attributes
	_bbox

Detailed Description

A radial density/surface brightness profile with elliptical symmetry

Parameters
----------
bands:
    The bands used in the model.
bbox:
    The bounding box that holds this component model.
spectrum:
    The spectrum of the component.
morph_params:
    The parameters passed to `morph_func` to
    generate the morphology in image space.
morph_func:
    The function to generate the morphology
    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.
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 838 of file parametric.py.

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.__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 )

Reimplemented from lsst.scarlet.lite.models.parametric.ParametricComponent.

Definition at line 869 of file parametric.py.

    ):
        super().__init__(
            bands=bands,
            bbox=bbox,
            spectrum=spectrum,
            morph_params=morph_params,
            morph_func=morph_func,
            morph_grad=morph_grad,
            morph_prox=morph_prox,
            morph_step=morph_step,
            prox_spectrum=prox_spectrum,
            floor=floor,
        )
 

Member Function Documentation

ellipse_params()

np.ndarray lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.ellipse_params

(

self

)

The parameters used to generate the scaled radius

Definition at line 913 of file parametric.py.

    def ellipse_params(self) -> np.ndarray:
        """The parameters used to generate the scaled radius"""
        return self._params.x[:5]
 

frame()

EllipseFrame lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.frame

(

self

)

The `EllipseFrame` that parameterizes the model

Reimplemented from lsst.scarlet.lite.models.parametric.ParametricComponent.

Definition at line 923 of file parametric.py.

    def frame(self) -> EllipseFrame:
        """The `EllipseFrame` that parameterizes the model"""
        return EllipseFrame(*self.ellipse_params, self._bbox)  # type: ignore
 

morph_grad()

Callable lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.morph_grad

(

self

)

The function that calculates the gradient of the
morphological model

Definition at line 933 of file parametric.py.

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

morph_prox()

Callable lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.morph_prox

(

self

)

The function used to constrain the morphological model

Definition at line 928 of file parametric.py.

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

radial_params()

np.ndarray lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.radial_params

(

self

)

The parameters used to model the radial function

Reimplemented from lsst.scarlet.lite.models.parametric.ParametricComponent.

Definition at line 918 of file parametric.py.

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

semi_major()

float lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.semi_major

(

self

)

The length of the semi-major axis of the model

Definition at line 896 of file parametric.py.

    def semi_major(self) -> float:
        """The length of the semi-major axis of the model"""
        return self._params.x[2]
 

semi_minor()

float lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.semi_minor

(

self

)

The length of the semi-minor axis of the model

Definition at line 901 of file parametric.py.

    def semi_minor(self) -> float:
        """The length of the semi-minor axis of the model"""
        return self._params.x[3]
 

theta()

float lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.theta

(

self

)

The counter-clockwise rotation angle of the model from the
x-axis.

Definition at line 906 of file parametric.py.

    def theta(self) -> float:
        """The counter-clockwise rotation angle of the model from the
        x-axis.
        """
        return self._params.x[4]
 

update()

lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.update	(		self,
		int	it,
		np.ndarray	input_grad )

Update the component

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

Reimplemented from lsst.scarlet.lite.models.parametric.ParametricComponent.

Definition at line 939 of file parametric.py.

    def update(self, it: int, input_grad: np.ndarray):
        """Update the component
 
        Parameters
        ----------
        it:
            The current iteration of the optimizer.
        input_grad:
            Gradient of the likelihood wrt the component model
        """
        ellipse = self.frame
        spectrum = self.spectrum.copy()
        morph = self._func(self.radial_params, ellipse)
        self._spectrum.update(it, input_grad, morph)
        self._params.update(it, input_grad, morph, spectrum, ellipse)

Member Data Documentation

_bbox

lsst.scarlet.lite.models.parametric.EllipticalParametricComponent._bbox

protected

Definition at line 925 of file parametric.py.

ellipse_params

lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.ellipse_params

Definition at line 925 of file parametric.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/gae0086650b+585e252eca/python/lsst/scarlet/lite/models/parametric.py