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

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

Public Member Functions
	shape (self)
CubeComponent	to_component (self, Observation observation)
dict	as_dict (self)
ScarletCubeComponentData	from_dict (cls, dict data, DTypeLike|None dtype=None)
Public Member Functions inherited from lsst.scarlet.lite.io.component.ScarletComponentBaseData
None	register (cls)

Static Public Attributes
tuple	origin [int, int]
tuple	peak [float, float]
np	model .ndarray
str	component_type = COMPONENT_TYPE
str	version = CURRENT_SCHEMA
Static Public Attributes inherited from lsst.scarlet.lite.io.component.ScarletComponentBaseData
dict	component_registry = {}

Detailed Description

Data for a component expressed as a 3D data cube

This is used for scarlet component models that are not factorized,
storing their entire model as a 3D data cube (bands, y, x).

Attributes
----------
origin :
    The lower bound of the components bounding box.
peak :
    The peak of the component.
model :
    The model for the component.

Member Function Documentation

as_dict()

dict lsst.scarlet.lite.io.cube_component.ScarletCubeComponentData.as_dict

(

self

)

Return the object encoded into a dict for JSON serialization

Returns
-------
result :
    The object encoded as a JSON compatible dict

Reimplemented from lsst.scarlet.lite.io.component.ScarletComponentBaseData.

from_dict()

ScarletCubeComponentData lsst.scarlet.lite.io.cube_component.ScarletCubeComponentData.from_dict	(		cls,
		dict	data,
		DTypeLike | None	dtype = None )

Reconstruct `ScarletComponentData` from JSON compatible dict

Parameters
----------
data :
    Dictionary representation of the object
dtype :
    Datatype of the resulting model.

Returns
-------
result :
    The reconstructed object

Reimplemented from lsst.scarlet.lite.io.component.ScarletComponentBaseData.

to_component()

CubeComponent lsst.scarlet.lite.io.cube_component.ScarletCubeComponentData.to_component	(		self,
		Observation	observation )

Convert the storage data model into a scarlet Component

Parameters
----------
observation :
    The observation that the component is associated with

Returns
-------
component :
    A scarlet component extracted from persisted data.

Reimplemented from lsst.scarlet.lite.io.component.ScarletComponentBaseData.

---

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

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