lsst.scarlet.lite gee10cc3b42+585e252eca
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
lsst.scarlet.lite.component.Component Class Reference
Inheritance diagram for lsst.scarlet.lite.component.Component:
lsst.scarlet.lite.component.FactorizedComponent lsst.scarlet.lite.io.ComponentCube lsst.scarlet.lite.models.parametric.ParametricComponent lsst.scarlet.lite.models.free_form.FreeFormComponent lsst.scarlet.lite.models.parametric.EllipticalParametricComponent

Public Member Functions

 __init__ (self, tuple bands, Box bbox)
 
Box bbox (self)
 
tuple bands (self)
 
bool resize (self, Box model_box)
 
None update (self, int it, np.ndarray input_grad)
 
Image get_model (self)
 
None parameterize (self, Callable parameterization)
 

Protected Attributes

 _bands
 
 _bbox
 

Detailed Description

A base component in scarlet lite.

Parameters
----------
bands:
    The bands used when the component model is created.
bbox: Box
    The bounding box for this component.

Constructor & Destructor Documentation

◆ __init__()

lsst.scarlet.lite.component.Component.__init__ ( self,
tuple bands,
Box bbox )

Member Function Documentation

◆ bands()

tuple lsst.scarlet.lite.component.Component.bands ( self)
The bands in the component model

◆ bbox()

Box lsst.scarlet.lite.component.Component.bbox ( self)
The bounding box that contains the component in the full image

◆ get_model()

Image lsst.scarlet.lite.component.Component.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 in lsst.scarlet.lite.component.FactorizedComponent, lsst.scarlet.lite.io.ComponentCube, and lsst.scarlet.lite.models.parametric.ParametricComponent.

◆ parameterize()

None lsst.scarlet.lite.component.Component.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 in lsst.scarlet.lite.component.FactorizedComponent, lsst.scarlet.lite.io.ComponentCube, and lsst.scarlet.lite.models.parametric.ParametricComponent.

◆ resize()

bool lsst.scarlet.lite.component.Component.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 in lsst.scarlet.lite.component.FactorizedComponent, lsst.scarlet.lite.io.ComponentCube, lsst.scarlet.lite.models.free_form.FreeFormComponent, and lsst.scarlet.lite.models.parametric.ParametricComponent.

◆ update()

None lsst.scarlet.lite.component.Component.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 in lsst.scarlet.lite.component.FactorizedComponent, lsst.scarlet.lite.io.ComponentCube, lsst.scarlet.lite.models.parametric.ParametricComponent, and lsst.scarlet.lite.models.parametric.EllipticalParametricComponent.


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