lsst.scarlet.lite gee10cc3b42+43dac7135f
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.scarlet.lite.io.ScarletComponentData Class Reference

Public Member Functions

 shape (self)
 
dict as_dict (self)
 
ScarletComponentData from_dict (cls, dict data, DTypeLike dtype=np.float32)
 

Public Attributes

 origin
 
 peak
 

Static Public Attributes

tuple origin [int, int]
 
tuple peak [float, float]
 
np model .ndarray
 

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.ScarletComponentData.as_dict ( self)
Return the object encoded into a dict for JSON serialization

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

◆ from_dict()

ScarletComponentData lsst.scarlet.lite.io.ScarletComponentData.from_dict ( cls,
dict data,
DTypeLike dtype = np.float32 )
Reconstruct `ScarletComponentData` from JSON compatible dict

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

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

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