LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst.afw.detection._heavyFootprintContinued.HeavyFootprint Class Reference
Inheritance diagram for lsst.afw.detection._heavyFootprintContinued.HeavyFootprint:

Public Member Functions

 addTo (self, image)
 
 subtractFrom (self, image)
 
 extractImage (self, fill=np.nan, bbox=None, imageType=None)
 

Detailed Description

Definition at line 28 of file _heavyFootprintContinued.py.

Member Function Documentation

◆ addTo()

lsst.afw.detection._heavyFootprintContinued.HeavyFootprint.addTo ( self,
image )
Add this heavy footprint to an image.

Parameters
----------
image : `lsst.afw.image`

Definition at line 29 of file _heavyFootprintContinued.py.

29 def addTo(self, image):
30 """Add this heavy footprint to an image.
31
32 Parameters
33 ----------
34 image : `lsst.afw.image`
35 """
36 indices = self.spans.indices()
37 image.array[indices[0, :] - image.getY0(),
38 indices[1, :] - image.getX0()] += self.getImageArray()
39

◆ extractImage()

lsst.afw.detection._heavyFootprintContinued.HeavyFootprint.extractImage ( self,
fill = np.nan,
bbox = None,
imageType = None )
Create a 2D image of a HeavyFootprint

Parameters
----------
fill: number
    Number to fill the pixels in the image that are not
    contained in `heavy`.
bbox : `Box2I`
    Bounding box of the output image.
imageType : `type`
    This should be either a `MaskedImage` or `Image` and describes
    the type of the output image.
    If `imageType` is `None` then `Image` will be used.

Returns
-------
image : `lsst.afw.image.MaskedImage` or `lsst.afw.image.Image`
    An image defined by `bbox` and padded with `fill` that
    contains the projected flux in `heavy`.

Definition at line 51 of file _heavyFootprintContinued.py.

51 def extractImage(self, fill=np.nan, bbox=None, imageType=None):
52 """Create a 2D image of a HeavyFootprint
53
54 Parameters
55 ----------
56 fill: number
57 Number to fill the pixels in the image that are not
58 contained in `heavy`.
59 bbox : `Box2I`
60 Bounding box of the output image.
61 imageType : `type`
62 This should be either a `MaskedImage` or `Image` and describes
63 the type of the output image.
64 If `imageType` is `None` then `Image` will be used.
65
66 Returns
67 -------
68 image : `lsst.afw.image.MaskedImage` or `lsst.afw.image.Image`
69 An image defined by `bbox` and padded with `fill` that
70 contains the projected flux in `heavy`.
71 """
72 # Prevent circular import
73 from lsst.afw.image import Image
74 if imageType is None:
75 imageType = Image
76 if bbox is None:
77 bbox = self.getBBox()
78 image = imageType(bbox, dtype=self.getImageArray().dtype)
79 image.set(fill)
80 self.insert(image)
81 return image
82
83

◆ subtractFrom()

lsst.afw.detection._heavyFootprintContinued.HeavyFootprint.subtractFrom ( self,
image )
Subtract this heavy footprint from an image.

Parameters
----------
image : `lsst.afw.image`

Definition at line 40 of file _heavyFootprintContinued.py.

40 def subtractFrom(self, image):
41 """Subtract this heavy footprint from an image.
42
43 Parameters
44 ----------
45 image : `lsst.afw.image`
46 """
47 indices = self.spans.indices()
48 image.array[indices[0, :] - image.getY0(),
49 indices[1, :] - image.getX0()] -= self.getImageArray()
50

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