lsst.scarlet.lite.io.ComponentCube Class Reference

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

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)
Box	bbox (self)
tuple	bands (self)

Public Attributes
	peak = peak

Protected Attributes
	_model = model
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.

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

Definition at line 931 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.

Definition at line 941 of file io.py.

    def __init__(self, bands: tuple[Any, ...], bbox: Box, model: Image, peak: tuple[int, int]):
        """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.
        """
        super().__init__(bands, bbox)
        self._model = model
        self.peak = peak
 

Member Function Documentation

bands()

tuple lsst.scarlet.lite.component.Component.bands ( self )

inherited

The bands in the component model

Definition at line 66 of file component.py.

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

bbox()

Box lsst.scarlet.lite.component.Component.bbox ( self )

inherited

The bounding box that contains the component in the full image

Definition at line 61 of file component.py.

    def bbox(self) -> Box:
        """The bounding box that contains the component in the full image"""
        return self._bbox
 

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 958 of file io.py.

    def get_model(self) -> Image:
        """Generate the model for the source
 
        Returns
        -------
        model :
            The model as a 3D `(band, y, x)` array.
        """
        return self._model
 

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 975 of file io.py.

    def parameterize(self, parameterization: Callable) -> None:
        """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 968 of file io.py.

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

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 972 of file io.py.

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

Member Data Documentation

_bands

tuple lsst.scarlet.lite.component.Component._bands = bands

protectedinherited

Definition at line 57 of file component.py.

_bbox

Box lsst.scarlet.lite.component.Component._bbox = bbox

protectedinherited

Definition at line 58 of file component.py.

_model

lsst.scarlet.lite.io.ComponentCube._model = 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 955 of file io.py.

peak

lsst.scarlet.lite.io.ComponentCube.peak = peak

Definition at line 956 of file io.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/scarlet_lite/gce8aa8abaa+8c5ae1fdc5/python/lsst/scarlet/lite/io.py