lsst.scarlet.lite.detect.Footprint Class Reference

Public Member Functions
Box	bbox (self)
tuple[int, int]	yx0 (self)
Image|None	intersection (self, Footprint other)
Image|None	union (self, Footprint other)

Public Attributes
	bounds

Detailed Description

Definition at line 94 of file detect.py.

Member Function Documentation

bbox()

Box lsst.scarlet.lite.detect.Footprint.bbox

(

self

)

Bounding box for the Footprint

Returns
-------
bbox:
    The minimal `Box` that contains the entire `Footprint`.

Definition at line 96 of file detect.py.

    def bbox(self) -> Box:
        """Bounding box for the Footprint
 
        Returns
        -------
        bbox:
            The minimal `Box` that contains the entire `Footprint`.
        """
        return bounds_to_bbox(self.bounds)  # type: ignore
 

intersection()

Image | None lsst.scarlet.lite.detect.Footprint.intersection	(		self,
		Footprint	other )

The intersection of two footprints

Parameters
----------
other:
    The other footprint to compare.

Returns
-------
intersection:
    The intersection of two footprints.

Definition at line 111 of file detect.py.

    def intersection(self, other: Footprint) -> Image | None:
        """The intersection of two footprints
 
        Parameters
        ----------
        other:
            The other footprint to compare.
 
        Returns
        -------
        intersection:
            The intersection of two footprints.
        """
        footprint1 = Image(self.data, yx0=self.yx0)  # type: ignore
        footprint2 = Image(other.data, yx0=other.yx0)  # type: ignore # noqa
        return footprint1 & footprint2
 

union()

Image | None lsst.scarlet.lite.detect.Footprint.union	(		self,
		Footprint	other )

The intersection of two footprints

Parameters
----------
other:
    The other footprint to compare.

Returns
-------
union:
    The union of two footprints.

Definition at line 128 of file detect.py.

    def union(self, other: Footprint) -> Image | None:
        """The intersection of two footprints
 
        Parameters
        ----------
        other:
            The other footprint to compare.
 
        Returns
        -------
        union:
            The union of two footprints.
        """
        footprint1 = Image(self.data, yx0=self.yx0)  # type: ignore
        footprint2 = Image(other.data, yx0=other.yx0)
        return footprint1 | footprint2
 
 

yx0()

tuple[int, int] lsst.scarlet.lite.detect.Footprint.yx0

(

self

)

Origin in y, x of the lower left corner of the footprint

Definition at line 107 of file detect.py.

    def yx0(self) -> tuple[int, int]:
        """Origin in y, x of the lower left corner of the footprint"""
        return self.bounds[0], self.bounds[2]  # type: ignore
 

Member Data Documentation

bounds

lsst.scarlet.lite.detect.Footprint.bounds

Definition at line 104 of file detect.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/scarlet_lite/g00274db5b6+edbf708997/python/lsst/scarlet/lite/detect.py