lsst.scarlet.lite gee10cc3b42+772f6ae910
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.scarlet.lite.io.ScarletModelData Class Reference

Public Member Functions

 __init__ (self, np.ndarray psf, dict[int, ScarletBlendData]|None blends=None)
 
str json (self)
 
ScarletModelData parse_obj (cls, dict data)
 

Public Attributes

 psf
 
 blends
 

Detailed Description

A container that propagates scarlet models for an entire catalog.

Constructor & Destructor Documentation

◆ __init__()

lsst.scarlet.lite.io.ScarletModelData.__init__ ( self,
np.ndarray psf,
dict[int, ScarletBlendData] | None blends = None )
Initialize an instance

Parameters
----------
bands:
    The names of the bands.
    The order of the bands must be the same as the order of
    the multiband model arrays, and SEDs.
psf:
    The 2D array of the PSF in scarlet model space.
    This is typically a narrow Gaussian integrated over the
    pixels in the exposure.
blends:
    Map from parent IDs in the source catalog
    to scarlet model data for each parent ID (blend).

Member Function Documentation

◆ json()

str lsst.scarlet.lite.io.ScarletModelData.json ( self)
Serialize the data model to a JSON formatted string

Returns
-------
result : `str`
    The result of the object converted into a JSON format

◆ parse_obj()

ScarletModelData lsst.scarlet.lite.io.ScarletModelData.parse_obj ( cls,
dict data )
Construct a ScarletModelData from python decoded JSON object.

Parameters
----------
data:
    The result of json.load(s) on a JSON persisted ScarletModelData

Returns
-------
result:
    The `ScarletModelData` that was loaded the from the input object

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