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 Member Functions inherited from 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)
tuple[float, float]	peak (self)
float	y0 (self)
float	x0 (self)
np.ndarray	spectrum (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)
bool	resize (self, Box model_box)
None	parameterize (self, Callable parameterization)
ScarletComponentBaseData	to_data (self)
ParametricComponent	__getitem__ (self, Any indices)
ParametricComponent	__deepcopy__ (self, dict[int, Any] memo)
ParametricComponent	__copy__ (self)
Public Member Functions inherited from lsst.scarlet.lite.component.Component
	__init__ (self, tuple bands, Box bbox)
Box	bbox (self)
tuple	bands (self)
Component	__getitem__ (self, Any indices)
Component	__copy__ (self)
Component	__deepcopy__ (self, dict[int, Any] memo)
Component	copy (self, bool deep=False)

Public Attributes
	ellipse_params
Public Attributes inherited from lsst.scarlet.lite.models.parametric.ParametricComponent
	floor = floor
	y0

Additional Inherited Members
Protected Member Functions inherited from lsst.scarlet.lite.models.parametric.ParametricComponent
np.ndarray	_get_morph (self, CartesianFrame|None frame=None)
Protected Attributes inherited from lsst.scarlet.lite.models.parametric.ParametricComponent
	_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
Protected Attributes inherited from lsst.scarlet.lite.component.Component
tuple	_bands = bands
Box	_bbox = 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.

Member Function Documentation

ellipse_params()

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

(

self

)

The parameters used to generate the scaled radius

frame()

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

(

self

)

The `EllipseFrame` that parameterizes the model

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

morph_grad()

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

(

self

)

The function that calculates the gradient of the
morphological model

morph_prox()

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

(

self

)

The function used to constrain the morphological model

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.

semi_major()

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

(

self

)

The length of the semi-major axis of the model

semi_minor()

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

(

self

)

The length of the semi-minor axis of the model

theta()

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

(

self

)

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

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.

---

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

• python/lsst/scarlet/lite/models/parametric.py