lsst.scarlet.lite.io.ScarletSourceData Class Reference

Public Member Functions
dict	as_dict (self)
ScarletSourceData	from_dict (cls, dict data, DTypeLike dtype=np.float32)

Public Attributes
	peak_id

Static Public Attributes
list	components [ScarletComponentData]
list	factorized_components [ScarletFactorizedComponentData]
int	peak_id

Detailed Description

Data for a scarlet source

Attributes
----------
components:
    The components contained in the source that are not factorized.
factorized_components:
    The components contained in the source that are factorized.
peak_id:
    The peak ID of the source in it's parent's footprint peak catalog.

Definition at line 165 of file io.py.

Member Function Documentation

as_dict()

dict lsst.scarlet.lite.io.ScarletSourceData.as_dict

(

self

)

Return the object encoded into a dict for JSON serialization

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

Definition at line 182 of file io.py.

    def as_dict(self) -> dict:
        """Return the object encoded into a dict for JSON serialization
 
        Returns
        -------
        result:
            The object encoded as a JSON compatible dict
        """
        result = {
            "components": [component.as_dict() for component in self.components],
            "factorized": [component.as_dict() for component in self.factorized_components],
            "peak_id": self.peak_id,
        }
        return result
 

from_dict()

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

Reconstruct `ScarletSourceData` from JSON compatible
dict.

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

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

Definition at line 198 of file io.py.

    def from_dict(cls, data: dict, dtype: DTypeLike = np.float32) -> ScarletSourceData:
        """Reconstruct `ScarletSourceData` from JSON compatible
        dict.
 
        Parameters
        ----------
        data:
            Dictionary representation of the object
        dtype:
            Datatype of the resulting model.
 
        Returns
        -------
        result:
            The reconstructed object
        """
        components = []
        for component in data["components"]:
            component = ScarletComponentData.from_dict(component, dtype=dtype)
            components.append(component)
 
        factorized = []
        for component in data["factorized"]:
            component = ScarletFactorizedComponentData.from_dict(component, dtype=dtype)
            factorized.append(component)
 
        return cls(components=components, factorized_components=factorized, peak_id=int(data["peak_id"]))
 
 
@dataclass(kw_only=True)

Member Data Documentation

components

list lsst.scarlet.lite.io.ScarletSourceData.components [ScarletComponentData]

static

Definition at line 178 of file io.py.

factorized_components

list lsst.scarlet.lite.io.ScarletSourceData.factorized_components [ScarletFactorizedComponentData]

static

Definition at line 179 of file io.py.

peak_id [1/2]

int lsst.scarlet.lite.io.ScarletSourceData.peak_id

static

Definition at line 180 of file io.py.

peak_id [2/2]

lsst.scarlet.lite.io.ScarletSourceData.peak_id

Definition at line 193 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