|
| | __init__ (self, config=None, *, name=None, parentTask=None, log=None) |
| |
| | run (self, exposure, background=None, stats=True, statsKeys=None, backgroundToPhotometricRatio=None) |
| |
| | fitBackground (self, maskedImage, nx=0, ny=0, algorithm=None) |
| |
|
| int | binSizeX = 0 else self.config.binSizeX |
| |
| int | binSizeY = 0 else self.config.binSizeY |
| |
|
| | _addStats (self, exposure, background, statsKeys=None) |
| |
Subtract the background from an exposure
Definition at line 200 of file subtractBackground.py.
◆ __init__()
| lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.__init__ |
( |
| self, |
|
|
| config = None, |
|
|
* | , |
|
|
| name = None, |
|
|
| parentTask = None, |
|
|
| log = None ) |
◆ _addStats()
| lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask._addStats |
( |
| self, |
|
|
| exposure, |
|
|
| background, |
|
|
| statsKeys = None ) |
|
protected |
Add statistics about the background to the exposure's metadata
Parameters
----------
exposure : `lsst.afw.image.Exposure`
Exposure whose background was subtracted.
background : `lsst.afw.math.BackgroundList`
Background model
statsKeys : `tuple`
Key names used to store the mean and variance of the background in
the exposure's metadata (a tuple); if None then use
("BGMEAN", "BGVAR"); ignored if stats is false.
Definition at line 279 of file subtractBackground.py.
◆ fitBackground()
| lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.fitBackground |
( |
| self, |
|
|
| maskedImage, |
|
|
| nx = 0, |
|
|
| ny = 0, |
|
|
| algorithm = None ) |
Estimate the background of a masked image
Parameters
----------
maskedImage : `lsst.afw.image.maskedImage`
Masked image whose background is to be computed
nx : 'int`
Number of x bands; if 0 compute from width and `self.config.binSizeX`
ny : `int`
Number of y bands; if 0 compute from height and `self.config.binSizeY`
algorithm : `str`
Name of interpolation algorithm; if None use `self.config.algorithm`
Returns
-------
bg : `lsst.afw.math.Background`
A fit background
Raises
------
RuntimeError
Raised if lsst.afw.math.makeBackground returns None, an indicator
of failure.
Definition at line 304 of file subtractBackground.py.
◆ run()
| lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.run |
( |
| self, |
|
|
| exposure, |
|
|
| background = None, |
|
|
| stats = True, |
|
|
| statsKeys = None, |
|
|
| backgroundToPhotometricRatio = None ) |
Fit and subtract the background of an exposure.
Parameters
----------
exposure : `lsst.afw.image.Exposure`
Exposure whose background is to be subtracted.
background : `lsst.afw.math.BackgroundList`
Initial background model already subtracted. May be None if no background
has been subtracted.
stats : `bool`
If True then measure the mean and variance of the full background model and
record the results in the exposure's metadata.
statsKeys : `tuple`
Key names used to store the mean and variance of the background in the
exposure's metadata (another tuple); if None then use ("BGMEAN", "BGVAR");
ignored if stats is false.
backgroundToPhotometricRatio : `lsst.afw.image.Image`, optional
Image to multiply a photometrically-flattened image by to obtain a
background-flattened image.
Only used if config.doApplyFlatBackgroundRatio = True.
Returns
-------
background : `lsst.afw.math.BackgroundList`
Full background model (initial model with changes), contained in an
`lsst.pipe.base.Struct`.
Definition at line 211 of file subtractBackground.py.
◆ _DefaultName
| str lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask._DefaultName = "subtractBackground" |
|
staticprotected |
◆ binSizeX
| lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.binSizeX = 0 else self.config.binSizeX |
◆ binSizeY
| lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.binSizeY = 0 else self.config.binSizeY |
◆ ConfigClass
The documentation for this class was generated from the following file:
1.13.2