LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.

96 def bbox(self) -> Box:
97 """Bounding box for the Footprint
98
99 Returns
100 -------
101 bbox:
102 The minimal `Box` that contains the entire `Footprint`.
103 """
104 return bounds_to_bbox(self.bounds) # type: ignore
105

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

111 def intersection(self, other: Footprint) -> Image | None:
112 """The intersection of two footprints
113
114 Parameters
115 ----------
116 other:
117 The other footprint to compare.
118
119 Returns
120 -------
121 intersection:
122 The intersection of two footprints.
123 """
124 footprint1 = Image(self.data, yx0=self.yx0) # type: ignore
125 footprint2 = Image(other.data, yx0=other.yx0) # type: ignore # noqa
126 return footprint1 & footprint2
127

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

128 def union(self, other: Footprint) -> Image | None:
129 """The intersection of two footprints
130
131 Parameters
132 ----------
133 other:
134 The other footprint to compare.
135
136 Returns
137 -------
138 union:
139 The union of two footprints.
140 """
141 footprint1 = Image(self.data, yx0=self.yx0) # type: ignore
142 footprint2 = Image(other.data, yx0=other.yx0)
143 return footprint1 | footprint2
144
145

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

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

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: