lsst.scarlet.lite.io.cube_component.ComponentCube Class Reference

Inheritance diagram for lsst.scarlet.lite.io.cube_component.ComponentCube:

Public Member Functions
	__init__ (self, 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)
ScarletCubeComponentData	to_data (self)
Public Member Functions inherited from lsst.scarlet.lite.component.Component
	__init__ (self, tuple bands, Box bbox)
Box	bbox (self)
tuple	bands (self)

Public Attributes
	peak = peak

Protected Attributes
	_model = model
Protected Attributes inherited from lsst.scarlet.lite.component.Component
tuple	_bands = bands
Box	_bbox = 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 but it is currently not functional
in that it cannot be optimized, only persisted and loaded.

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

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.io.cube_component.ComponentCube.__init__	(		self,
		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.

Member Function Documentation

get_model()

Image lsst.scarlet.lite.io.cube_component.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.cube_component.ComponentCube.parameterize	(		self,
		Callable	parameterization )

Implementation of unused abstract method

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

resize()

bool lsst.scarlet.lite.io.cube_component.ComponentCube.resize	(		self,
		Box	model_box )

Test whether or not the component needs to be resized

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

to_data()

ScarletCubeComponentData lsst.scarlet.lite.io.cube_component.ComponentCube.to_data

(

self

)

Convert the component to persistable ScarletComponentData

Returns
-------
component_data: ScarletComponentData
    The data object containing the component information

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

update()

None lsst.scarlet.lite.io.cube_component.ComponentCube.update	(		self,
		int	it,
		np.ndarray	input_grad )

Implementation of unused abstract method

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

---

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

• python/lsst/scarlet/lite/io/cube_component.py