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.

Definition at line 32 of file io.py.

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

Definition at line 56 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": self.origin,
            "shape": self.model.shape,
            "peak": self.peak,
            "model": tuple(self.model.flatten().astype(float)),
        }
 

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

Definition at line 72 of file io.py.

    def from_dict(cls, data: dict, dtype: DTypeLike = np.float32) -> ScarletComponentData:
        """Reconstruct `ScarletComponentData` 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"],
            model=np.array(data["model"]).reshape(shape).astype(dtype),
        )
 
 
@dataclass(kw_only=True)

shape()

lsst.scarlet.lite.io.ScarletComponentData.shape

(

self

)

Definition at line 53 of file io.py.

    def shape(self):
        return self.model.shape[-2:]
 

Member Data Documentation

model

np lsst.scarlet.lite.io.ScarletComponentData.model .ndarray

static

Definition at line 50 of file io.py.

origin [1/2]

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

static

Definition at line 48 of file io.py.

origin [2/2]

lsst.scarlet.lite.io.ScarletComponentData.origin

Definition at line 65 of file io.py.

peak [1/2]

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

static

Definition at line 49 of file io.py.

peak [2/2]

lsst.scarlet.lite.io.ScarletComponentData.peak

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