LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
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: