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.meas.algorithms.subtractBackground Namespace Reference

Classes

class  SubtractBackgroundConfig
 
class  SubtractBackgroundTask
 
class  TooManyMaskedPixelsError
 

Functions

 backgroundFlatContext (maskedImage, doApply, backgroundToPhotometricRatio=None)
 
 filterSuperPixels (bbox, background, superPixelFilterSize=3)
 

Function Documentation

◆ backgroundFlatContext()

lsst.meas.algorithms.subtractBackground.backgroundFlatContext ( maskedImage,
doApply,
backgroundToPhotometricRatio = None )
Context manager to convert from photometric-flattened to background-
flattened image.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    Masked image (image + mask + variance) to convert from a
    photometrically flat image to an image suitable for background
    subtraction.
doApply : `bool`
    Apply the conversion? If False, this context manager will not
    do anything.
backgroundToPhotometricRatio : `lsst.afw.image.Image`, optional
    Image to multiply a photometrically-flattened image by to obtain a
    background-flattened image.
    Only used if ``doApply`` is ``True``.

Yields
------
maskedImage : `lsst.afw.image.MaskedImage`
    Masked image converted into an image suitable for background
    subtraction.

Raises
------
RuntimeError if doApply is True and no ratio is supplied.
ValueError if the ratio is not an `lsst.afw.image.Image`.

Definition at line 43 of file subtractBackground.py.

43def backgroundFlatContext(maskedImage, doApply, backgroundToPhotometricRatio=None):
44 """Context manager to convert from photometric-flattened to background-
45 flattened image.
46
47 Parameters
48 ----------
49 maskedImage : `lsst.afw.image.MaskedImage`
50 Masked image (image + mask + variance) to convert from a
51 photometrically flat image to an image suitable for background
52 subtraction.
53 doApply : `bool`
54 Apply the conversion? If False, this context manager will not
55 do anything.
56 backgroundToPhotometricRatio : `lsst.afw.image.Image`, optional
57 Image to multiply a photometrically-flattened image by to obtain a
58 background-flattened image.
59 Only used if ``doApply`` is ``True``.
60
61 Yields
62 ------
63 maskedImage : `lsst.afw.image.MaskedImage`
64 Masked image converted into an image suitable for background
65 subtraction.
66
67 Raises
68 ------
69 RuntimeError if doApply is True and no ratio is supplied.
70 ValueError if the ratio is not an `lsst.afw.image.Image`.
71 """
72 if doApply:
73 if backgroundToPhotometricRatio is None:
74 raise RuntimeError("backgroundFlatContext called with doApply=True, "
75 "but without a backgroundToPhotometricRatio")
76 if not isinstance(backgroundToPhotometricRatio, afwImage.Image):
77 raise ValueError("The backgroundToPhotometricRatio must be an lsst.afw.image.Image")
78
79 maskedImage *= backgroundToPhotometricRatio
80
81 try:
82 yield maskedImage
83 finally:
84 if doApply:
85 maskedImage /= backgroundToPhotometricRatio
86
87
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51

◆ filterSuperPixels()

lsst.meas.algorithms.subtractBackground.filterSuperPixels ( bbox,
background,
superPixelFilterSize = 3 )
Remove outliers from the binned background model.

Parameters
----------
bbox : `lsst.geom.Box2I`
    Bounding box of the original image.
background : `lsst.afw.math.BackgroundMI`
    Fit and binned background image, which will be modified in place.
superPixelFilterSize : `int`, optional
    Size of the median filter to use, in pixels.

Definition at line 416 of file subtractBackground.py.

416def filterSuperPixels(bbox, background, superPixelFilterSize=3):
417 """Remove outliers from the binned background model.
418
419 Parameters
420 ----------
421 bbox : `lsst.geom.Box2I`
422 Bounding box of the original image.
423 background : `lsst.afw.math.BackgroundMI`
424 Fit and binned background image, which will be modified in place.
425 superPixelFilterSize : `int`, optional
426 Size of the median filter to use, in pixels.
427 """
428 statsImg = background.getStatsImage()
429 # scipy's median_filter can't handle NaN values
430 bad = numpy.isnan(statsImg.image.array)
431 if numpy.count_nonzero(bad) > 0:
432 statsImg.image.array[bad] = numpy.nanmedian(statsImg.image.array)
433 statsImg.image.array = median_filter(statsImg.image.array, mode="reflect", size=superPixelFilterSize)
434 background = afwMath.BackgroundMI(bbox, statsImg)
A class to evaluate image background levels.
Definition Background.h:435