lsst.scarlet.lite.io.ScarletFactorizedComponentData Class Reference

Public Member Functions
	shape (self)
dict	as_dict (self)
ScarletFactorizedComponentData	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	spectrum .ndarray
np	morph .ndarray

Detailed Description

Data for a factorized component

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

Definition at line 97 of file io.py.

Member Function Documentation

as_dict()

dict lsst.scarlet.lite.io.ScarletFactorizedComponentData.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 121 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
        """
        return {
            "origin": tuple(int(o) for o in self.origin),
            "shape": tuple(int(s) for s in self.morph.shape),
            "peak": tuple(int(p) for p in self.peak),
            "spectrum": tuple(self.spectrum.astype(float)),
            "morph": tuple(self.morph.flatten().astype(float)),
        }
 

from_dict()

ScarletFactorizedComponentData lsst.scarlet.lite.io.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

Definition at line 138 of file io.py.

    def from_dict(cls, data: dict, dtype: DTypeLike = np.float32) -> ScarletFactorizedComponentData:
        """Reconstruct `ScarletFactorizedComponentData` from JSON compatible
        dict.
 
        Parameters
        ----------
        data:
            Dictionary representation of the object
        dtype:
            Datatype of the resulting model.
 
        Returns
        -------
        result:
            The reconstructed object
        """
        shape = tuple(data["shape"])
 
        return cls(
            origin=tuple(data["origin"]),  # type: ignore
            peak=data["peak"],
            spectrum=np.array(data["spectrum"]).astype(dtype),
            morph=np.array(data["morph"]).reshape(shape).astype(dtype),
        )
 
 
@dataclass(kw_only=True)

shape()

lsst.scarlet.lite.io.ScarletFactorizedComponentData.shape

(

self

)

Definition at line 118 of file io.py.

    def shape(self):
        return self.morph.shape
 

Member Data Documentation

morph

np lsst.scarlet.lite.io.ScarletFactorizedComponentData.morph .ndarray

static

Definition at line 115 of file io.py.

origin [1/2]

tuple lsst.scarlet.lite.io.ScarletFactorizedComponentData.origin [int, int]

static

Definition at line 112 of file io.py.

origin [2/2]

lsst.scarlet.lite.io.ScarletFactorizedComponentData.origin

Definition at line 130 of file io.py.

peak [1/2]

tuple lsst.scarlet.lite.io.ScarletFactorizedComponentData.peak [float, float]

static

Definition at line 113 of file io.py.

peak [2/2]

lsst.scarlet.lite.io.ScarletFactorizedComponentData.peak

Definition at line 132 of file io.py.

spectrum

np lsst.scarlet.lite.io.ScarletFactorizedComponentData.spectrum .ndarray

static

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