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.

Definition at line 446 of file io.py.

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).

Definition at line 449 of file io.py.

    def __init__(self, psf: np.ndarray, blends: dict[int, ScarletBlendData] | None = 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).
        """
        self.psf = psf
        if blends is None:
            blends = {}
        self.blends = blends
 

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

Definition at line 471 of file io.py.

    def json(self) -> str:
        """Serialize the data model to a JSON formatted string
 
        Returns
        -------
        result : `str`
            The result of the object converted into a JSON format
        """
        result = {
            "psfShape": self.psf.shape,
            "psf": list(self.psf.flatten().astype(float)),
            "blends": {bid: blend.as_dict() for bid, blend in self.blends.items()},
        }
        return json.dumps(result)
 

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

Definition at line 487 of file io.py.

    def parse_obj(cls, data: dict) -> ScarletModelData:
        """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
        """
        model_psf = np.array(data["psf"]).reshape(data["psfShape"]).astype(np.float32)
        return cls(
            psf=model_psf,
            blends={int(bid): ScarletBlendData.from_dict(blend) for bid, blend in data["blends"].items()},
        )
 
 

Member Data Documentation

blends

lsst.scarlet.lite.io.ScarletModelData.blends

Definition at line 469 of file io.py.

psf

lsst.scarlet.lite.io.ScarletModelData.psf

Definition at line 466 of file io.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/scarlet_lite/gae0086650b+585e252eca/python/lsst/scarlet/lite/io.py