lsst.pipe.drivers g96f01af41f+e7dd7bd53f
|
Public Member Functions | |
def | fromCamera (cls, config, camera) |
def | __init__ (self, config, dims, transform, values=None, numbers=None) |
def | __reduce__ (self) |
def | clone (self) |
def | addCcd (self, exposure) |
def | toCcdBackground (self, detector, bbox) |
def | merge (self, other) |
def | __iadd__ (self, other) |
def | getStatsImage (self) |
Public Attributes | |
config | |
dims | |
transform | |
Background model for a focal plane camera We model the background empirically with the "superpixel" method: we measure the background in each superpixel and interpolate between superpixels to yield the model. The principal difference between this and `lsst.afw.math.BackgroundMI` is that here the superpixels are defined in the frame of the focal plane of the camera which removes discontinuities across detectors. The constructor you probably want to use is the `fromCamera` classmethod. There are two use patterns for building a background model: * Serial: create a `FocalPlaneBackground`, then `addCcd` for each of the CCDs in an exposure. * Parallel: create a `FocalPlaneBackground`, then `clone` it for each of the CCDs in an exposure and use those to `addCcd` their respective CCD image. Finally, `merge` all the clones into the original. Once you've built the background model, you can apply it to individual CCDs with the `toCcdBackground` method.
Definition at line 489 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.__init__ | ( | self, | |
config, | |||
dims, | |||
transform, | |||
values = None , |
|||
numbers = None |
|||
) |
Constructor Developers should note that changes to the signature of this method require coordinated changes to the `__reduce__` and `clone` methods. Parameters ---------- config : `FocalPlaneBackgroundConfig` Configuration for measuring backgrounds. dims : `lsst.geom.Extent2I` Dimensions for background samples. transform : `lsst.afw.geom.TransformPoint2ToPoint2` Transformation from focal plane coordinates to sample coordinates. values : `lsst.afw.image.ImageF` Measured background values. numbers : `lsst.afw.image.ImageF` Number of pixels in each background measurement.
Definition at line 543 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.__iadd__ | ( | self, | |
other | |||
) |
Merge with another FocalPlaneBackground Parameters ---------- other : `FocalPlaneBackground` Another background model to merge. Returns ------- self : `FocalPlaneBackground` The merged background model.
Definition at line 715 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.__reduce__ | ( | self | ) |
Definition at line 581 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.addCcd | ( | self, | |
exposure | |||
) |
Add CCD to model We measure the background on the CCD (clipped mean), and record the results in the model. For simplicity, measurements are made in a box on the CCD corresponding to the warped coordinates of the superpixel rather than accounting for little rotations, etc. We also record the number of pixels used in the measurement so we can have a measure of confidence in each bin's value. Parameters ---------- exposure : `lsst.afw.image.Exposure` CCD exposure to measure
Definition at line 587 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.clone | ( | self | ) |
Definition at line 584 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.fromCamera | ( | cls, | |
config, | |||
camera | |||
) |
Construct from a camera object Parameters ---------- config : `FocalPlaneBackgroundConfig` Configuration for measuring backgrounds. camera : `lsst.afw.cameraGeom.Camera` Camera for which to measure backgrounds.
Definition at line 515 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.getStatsImage | ( | self | ) |
Return the background model data This is the measurement of the background for each of the superpixels.
Definition at line 730 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.merge | ( | self, | |
other | |||
) |
Merge with another FocalPlaneBackground This allows multiple background models to be constructed from different CCDs, and then merged to form a single consistent background model for the entire focal plane. Parameters ---------- other : `FocalPlaneBackground` Another background model to merge. Returns ------- self : `FocalPlaneBackground` The merged background model.
Definition at line 689 of file background.py.
def lsst.pipe.drivers.background.FocalPlaneBackground.toCcdBackground | ( | self, | |
detector, | |||
bbox | |||
) |
Produce a background model for a CCD The superpixel background model is warped back to the CCD frame, for application to the individual CCD. Parameters ---------- detector : `lsst.afw.cameraGeom.Detector` CCD for which to produce background model. bbox : `lsst.geom.Box2I` Bounding box of CCD exposure. Returns ------- bg : `lsst.afw.math.BackgroundList` Background model for CCD.
Definition at line 639 of file background.py.
lsst.pipe.drivers.background.FocalPlaneBackground.config |
Definition at line 562 of file background.py.
lsst.pipe.drivers.background.FocalPlaneBackground.dims |
Definition at line 563 of file background.py.
lsst.pipe.drivers.background.FocalPlaneBackground.transform |
Definition at line 564 of file background.py.