lsst.scarlet.lite.io.factorized_component.ScarletFactorizedComponentData Class Reference

Inheritance diagram for lsst.scarlet.lite.io.factorized_component.ScarletFactorizedComponentData:

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

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

Detailed Description

Data for a factorized component

Attributes
----------
component_type :
    The type of component being stored.
origin :
    The lower bound of the component's bounding box.
peak :
    The ``(y, x)`` peak of the component.
spectrum :
    The SED of the component.
morph :
    The 2D morphology of the component.
version :
    The schema version of the stored data.

Member Function Documentation

as_dict()

dict lsst.scarlet.lite.io.factorized_component.ScarletFactorizedComponentData.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()

ScarletFactorizedComponentData lsst.scarlet.lite.io.factorized_component.ScarletFactorizedComponentData.from_dict	(		cls,
		dict	data,
		DTypeLike	dtype = np.float32 )

Reconstruct `ScarletFactorizedComponentData` 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.

shape()

lsst.scarlet.lite.io.factorized_component.ScarletFactorizedComponentData.shape

(

self

)

The shape of the component's morphology

to_component()

FactorizedComponent lsst.scarlet.lite.io.factorized_component.ScarletFactorizedComponentData.to_component	(		self,
		Observation	observation )

Convert the storage data model into a scarlet FactorizedComponent

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

Returns
-------
factorized_component :
    A scarlet factorized 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/factorized_component.py