LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
LSST Data Management Base Package
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 Attributes

 peak
 

Protected Attributes

 _model
 

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.

Definition at line 507 of file io.py.

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.

Definition at line 517 of file io.py.

517 def __init__(self, bands: tuple[Any, ...], bbox: Box, model: Image, peak: tuple[int, int]):
518 """Initialization
519
520 Parameters
521 ----------
522 bands:
523 model:
524 The 3D (bands, y, x) model of the component.
525 peak:
526 The `(y, x)` peak of the component.
527 bbox:
528 The bounding box of the component.
529 """
530 super().__init__(bands, bbox)
531 self._model = model
532 self.peak = peak
533

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.

Definition at line 534 of file io.py.

534 def get_model(self) -> Image:
535 """Generate the model for the source
536
537 Returns
538 -------
539 model:
540 The model as a 3D `(band, y, x)` array.
541 """
542 return self._model
543

◆ parameterize()

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

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

Definition at line 551 of file io.py.

551 def parameterize(self, parameterization: Callable) -> None:
552 """Implementation of unused abstract method"""

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

Definition at line 544 of file io.py.

544 def resize(self, model_box: Box) -> bool:
545 """Test whether or not the component needs to be resized"""
546 return False
547

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

Definition at line 548 of file io.py.

548 def update(self, it: int, input_grad: np.ndarray) -> None:
549 """Implementation of unused abstract method"""
550

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.

Definition at line 531 of file io.py.

◆ peak

lsst.scarlet.lite.io.ComponentCube.peak

Definition at line 532 of file io.py.


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