LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
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 62 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 64 of file detect.py.

64 def bbox(self) -> Box:
65 """Bounding box for the Footprint
66
67 Returns
68 -------
69 bbox:
70 The minimal `Box` that contains the entire `Footprint`.
71 """
72 return bounds_to_bbox(self.bounds) # type: ignore
73
AmpInfoBoxKey bbox
Definition Amplifier.cc:117

◆ 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 79 of file detect.py.

79 def intersection(self, other: Footprint) -> Image | None:
80 """The intersection of two footprints
81
82 Parameters
83 ----------
84 other:
85 The other footprint to compare.
86
87 Returns
88 -------
89 intersection:
90 The intersection of two footprints.
91 """
92 footprint1 = Image(self.data, yx0=self.yx0) # type: ignore
93 footprint2 = Image(other.data, yx0=other.yx0) # type: ignore # noqa
94 return footprint1 & footprint2
95

◆ 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 96 of file detect.py.

96 def union(self, other: Footprint) -> Image | None:
97 """The intersection of two footprints
98
99 Parameters
100 ----------
101 other:
102 The other footprint to compare.
103
104 Returns
105 -------
106 union:
107 The union of two footprints.
108 """
109 footprint1 = Image(self.data, yx0=self.yx0) # type: ignore
110 footprint2 = Image(other.data, yx0=other.yx0)
111 return footprint1 | footprint2
112
113

◆ 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 75 of file detect.py.

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

Member Data Documentation

◆ bounds

lsst.scarlet.lite.detect.Footprint.bounds

Definition at line 72 of file detect.py.


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