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

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

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.

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.

yx0()

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

(

self

)

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

---

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

• python/lsst/scarlet/lite/detect.py