lsst.pipe.tasks g167d89548d+3a17f43c43
|
Public Member Functions | |
def | __init__ (self, butler=None, initInputs=None, *args, **kwargs) |
def | applySkyCorr (self, calexp, skyCorr) |
def | extractStamps (self, inputExposure, refObjLoader=None) |
def | warpStamps (self, stamps, pixCenters) |
def | run (self, inputExposure, refObjLoader=None, dataId=None, skyCorr=None) |
def | runQuantum (self, butlerQC, inputRefs, outputRefs) |
Public Attributes | |
modelStampSize | |
modelCenter | |
Static Public Attributes | |
ConfigClass = ProcessBrightStarsConfig | |
The description of the parameters for this Task are detailed in :lsst-task:`~lsst.pipe.base.PipelineTask`. Parameters ---------- initInputs : `Unknown` *args Additional positional arguments. **kwargs Additional keyword arguments. Notes ----- `ProcessBrightStarsTask` is used to extract, process, and store small image cut-outs (or "postage stamps") around bright stars. It relies on three methods, called in succession: `extractStamps` Find bright stars within the exposure using a reference catalog and extract a stamp centered on each. `warpStamps` Shift and warp each stamp to remove optical distortions and sample all stars on the same pixel grid. `measureAndNormalize` Compute the flux of an object in an annulus and normalize it. This is required to normalize each bright star stamp as their central pixels are likely saturated and/or contain ghosts, and cannot be used.
Definition at line 179 of file processBrightStars.py.
def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.__init__ | ( | self, | |
butler = None , |
|||
initInputs = None , |
|||
* | args, | ||
** | kwargs | ||
) |
Definition at line 211 of file processBrightStars.py.
def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.applySkyCorr | ( | self, | |
calexp, | |||
skyCorr | |||
) |
Apply correction to the sky background level. Sky corrections can be generated with the 'skyCorrection.py' executable in pipe_drivers. Because the sky model used by that code extends over the entire focal plane, this can produce better sky subtraction. The calexp is updated in-place. Parameters ---------- calexp : `lsst.afw.image.Exposure` or `lsst.afw.image.MaskedImage` Calibrated exposure. skyCorr : `lsst.afw.math.backgroundList.BackgroundList` or `None`, optional Full focal plane sky correction, obtained by running `lsst.pipe.drivers.skyCorrection.SkyCorrectionTask`.
Definition at line 227 of file processBrightStars.py.
def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.extractStamps | ( | self, | |
inputExposure, | |||
refObjLoader = None |
|||
) |
Read position of bright stars within `inputExposure` from refCat and extract them. Parameters ---------- inputExposure : `afwImage.exposure.exposure.ExposureF` The image from which bright star stamps should be extracted. refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`, optional Loader to find objects within a reference catalog. Returns ------- result : `lsst.pipe.base.Struct` Results as a struct with attributes: ``starIms`` List of stamps (`list`). ``pixCenters`` List of corresponding coordinates to each star's center, in pixels (`list`). ``GMags`` List of corresponding (Gaia) G magnitudes (`list`). ``gaiaIds`` Array of corresponding unique Gaia identifiers (`np.ndarray`).
Definition at line 249 of file processBrightStars.py.
def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.run | ( | self, | |
inputExposure, | |||
refObjLoader = None , |
|||
dataId = None , |
|||
skyCorr = None |
|||
) |
Identify bright stars within an exposure using a reference catalog, extract stamps around each, then preprocess them. The preprocessing steps are: shifting, warping and potentially rotating them to the same pixel grid; computing their annular flux and normalizing them. Parameters ---------- inputExposure : `afwImage.exposure.exposure.ExposureF` The image from which bright star stamps should be extracted. refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`, optional Loader to find objects within a reference catalog. dataId : `dict` or `lsst.daf.butler.DataCoordinate` The dataId of the exposure (and detector) bright stars should be extracted from. skyCorr : `lsst.afw.math.backgroundList.BackgroundList` or `None`, optional Full focal plane sky correction, obtained by running `lsst.pipe.drivers.skyCorrection.SkyCorrectionTask`. Returns ------- result : `lsst.pipe.base.Struct` Results as a struct with attributes: ``brightStarStamps`` (`bSS.BrightStarStamps`)
Definition at line 442 of file processBrightStars.py.
def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.runQuantum | ( | self, | |
butlerQC, | |||
inputRefs, | |||
outputRefs | |||
) |
Definition at line 515 of file processBrightStars.py.
def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.warpStamps | ( | self, | |
stamps, | |||
pixCenters | |||
) |
Warps and shifts all given stamps so they are sampled on the same pixel grid and centered on the central pixel. This includes rotating the stamp depending on detector orientation. Parameters ---------- stamps : `collections.abc.Sequence` [`afwImage.exposure.exposure.ExposureF`] Image cutouts centered on a single object. pixCenters : `collections.abc.Sequence` [`geom.Point2D`] Positions of each object's center (as obtained from the refCat), in pixels. Returns ------- result : `lsst.pipe.base.Struct` Results as a struct with attributes: ``warpedStars`` List of stamps of warped stars (`list` of `afwImage.maskedImage.maskedImage.MaskedImage`). ``warpTransforms`` List of the corresponding Transform from the initial star stamp to the common model grid (`list` of `afwGeom.TransformPoint2ToPoint2`). ``xy0s`` List of coordinates of the bottom-left pixels of each stamp, before rotation (`list` of `geom.Point2I`). ``nb90Rots`` The number of 90 degrees rotations required to compensate for detector orientation (`int`).
Definition at line 349 of file processBrightStars.py.
|
static |
Definition at line 208 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.modelCenter |
Definition at line 222 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.modelStampSize |
Definition at line 214 of file processBrightStars.py.