lsst.scarlet.lite gee10cc3b42+772f6ae910
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
lsst.scarlet.lite.io.ComponentCube Class Reference
Inheritance diagram for lsst.scarlet.lite.io.ComponentCube:
lsst.scarlet.lite.component.Component

Public Member Functions

 __init__ (self, tuple[Any,...] bands, Box bbox, Image model, tuple[int, int] peak)
 
Image get_model (self)
 
bool resize (self, Box model_box)
 
None update (self, int it, np.ndarray input_grad)
 
None parameterize (self, Callable parameterization)
 
- Public Member Functions inherited from lsst.scarlet.lite.component.Component
Box bbox (self)
 
tuple bands (self)
 

Public Attributes

 peak
 

Protected Attributes

 _model
 
- Protected Attributes inherited from lsst.scarlet.lite.component.Component
 _bands
 
 _bbox
 

Detailed Description

Dummy component for a component cube.

This is duck-typed to a `lsst.scarlet.lite.Component` in order to
generate a model from the component.

If scarlet lite ever implements a component as a data cube,
this class can be removed.

Constructor & Destructor Documentation

◆ __init__()

lsst.scarlet.lite.io.ComponentCube.__init__ ( self,
tuple[Any, ...] bands,
Box bbox,
Image model,
tuple[int, int] peak )
Initialization

Parameters
----------
bands:
model:
    The 3D (bands, y, x) model of the component.
peak:
    The `(y, x)` peak of the component.
bbox:
    The bounding box of the component.

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

Member Function Documentation

◆ get_model()

Image lsst.scarlet.lite.io.ComponentCube.get_model ( self)
Generate the model for the source

Returns
-------
model:
    The model as a 3D `(band, y, x)` array.

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

◆ parameterize()

None lsst.scarlet.lite.io.ComponentCube.parameterize ( self,
Callable parameterization )
Implementation of unused abstract method

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

◆ resize()

bool lsst.scarlet.lite.io.ComponentCube.resize ( self,
Box model_box )
Test whether or not the component needs to be resized

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

◆ update()

None lsst.scarlet.lite.io.ComponentCube.update ( self,
int it,
np.ndarray input_grad )
Implementation of unused abstract method

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

Member Data Documentation

◆ _model

lsst.scarlet.lite.io.ComponentCube._model
protected
Initialization

Parameters
----------
bands:
model:
    The 3D (bands, y, x) model of the component.
peak:
    The `(y, x)` peak of the component.
bbox:
    The bounding box of the component.

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