LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
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.

Definition at line 41 of file component.py.

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

Definition at line 66 of file component.py.

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

◆ bbox()

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

Definition at line 61 of file component.py.

61 def bbox(self) -> Box:
62 """The bounding box that contains the component in the full image"""
63 return self._bbox
64
AmpInfoBoxKey bbox
Definition Amplifier.cc:117

◆ 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.

Definition at line 91 of file component.py.

91 def get_model(self) -> Image:
92 """Generate a model for the component
93
94 This must be implemented in inherited classes.
95
96 Returns
97 -------
98 model: Image
99 The image of the component model.
100 """
101

◆ 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.

Definition at line 103 of file component.py.

103 def parameterize(self, parameterization: Callable) -> None:
104 """Convert the component parameter arrays into Parameter instances
105
106 Parameters
107 ----------
108 parameterization: Callable
109 A function to use to convert parameters of a given type into
110 a `Parameter` in place. It should take a single argument that
111 is the `Component` or `Source` that is to be parameterized.
112 """
113
114

◆ 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.

Definition at line 71 of file component.py.

71 def resize(self, model_box: Box) -> bool:
72 """Test whether or not the component needs to be resized
73
74 This should be overriden in inherited classes and return `True`
75 if the component needs to be resized.
76 """
77

◆ 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.

Definition at line 79 of file component.py.

79 def update(self, it: int, input_grad: np.ndarray) -> None:
80 """Update the component parameters from an input gradient
81
82 Parameters
83 ----------
84 it:
85 The current iteration of the optimizer.
86 input_grad:
87 Gradient of the likelihood wrt the component model
88 """
89

Member Data Documentation

◆ _bands

lsst.scarlet.lite.component.Component._bands
protected

Definition at line 57 of file component.py.

◆ _bbox

lsst.scarlet.lite.component.Component._bbox
protected

Definition at line 58 of file component.py.


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