lsst.pipe.tasks g35da1f9f46+057a7ca058
|
Public Member Functions | |
__init__ (self, butler=None, initInputs=None, *args, **kwargs) | |
applySkyCorr (self, calexp, skyCorr) | |
extractStamps (self, inputExposure, refObjLoader=None) | |
warpStamps (self, stamps, pixCenters) | |
run (self, inputExposure, refObjLoader=None, dataId=None, skyCorr=None) | |
runQuantum (self, butlerQC, inputRefs, outputRefs) | |
Public Attributes | |
modelStampSize | |
modelCenter | |
Static Public Attributes | |
ConfigClass = ProcessBrightStarsConfig | |
Static Protected Attributes | |
str | _DefaultName = "processBrightStars" |
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.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.__init__ | ( | self, | |
butler = None , |
|||
initInputs = None , |
|||
* | args, | ||
** | kwargs | ||
) |
Definition at line 212 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.applySkyCorr | ( | self, | |
calexp, | |||
skyCorr | |||
) |
Apply correction to the sky background level. Sky corrections can be generated using the ``SkyCorrectionTask``. As the sky model generated there extends over the full focal plane, this should produce a more optimal sky subtraction solution. Parameters ---------- calexp : `~lsst.afw.image.Exposure` or `~lsst.afw.image.MaskedImage` Calibrated exposure. skyCorr : `~lsst.afw.math.backgroundList.BackgroundList`, optional Full focal plane sky correction from ``SkyCorrectionTask``. Notes ----- This method modifies the input ``calexp`` in-place.
Definition at line 230 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.extractStamps | ( | self, | |
inputExposure, | |||
refObjLoader = None |
|||
) |
Read the position of bright stars within an input exposure using a refCat and extract them. Parameters ---------- inputExposure : `~lsst.afw.image.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`` Postage stamps (`list`). ``pixCenters`` Corresponding coords to each star's center, in pixels (`list`). ``GMags`` Corresponding (Gaia) G magnitudes (`list`). ``gaiaIds`` Corresponding unique Gaia identifiers (`np.ndarray`).
Definition at line 252 of file processBrightStars.py.
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 : `~lsst.afw.image.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`, optional Full focal plane sky correction obtained by `SkyCorrectionTask`. Returns ------- result : `~lsst.pipe.base.Struct` Results as a struct with attributes: ``brightStarStamps`` (`~lsst.meas.algorithms.brightStarStamps.BrightStarStamps`)
Definition at line 453 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.runQuantum | ( | self, | |
butlerQC, | |||
inputRefs, | |||
outputRefs | |||
) |
Definition at line 536 of file processBrightStars.py.
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 : `Sequence` [`~lsst.afw.image.ExposureF`] Image cutouts centered on a single object. pixCenters : `Sequence` [`~lsst.geom.Point2D`] Positions of each object's center (from the refCat) in pixels. Returns ------- result : `~lsst.pipe.base.Struct` Results as a struct with attributes: ``warpedStars`` Stamps of warped stars. (`list` [`~lsst.afw.image.MaskedImage`]) ``warpTransforms`` The corresponding Transform from the initial star stamp to the common model grid. (`list` [`~lsst.afw.geom.TransformPoint2ToPoint2`]) ``xy0s`` Coordinates of the bottom-left pixels of each stamp, before rotation. (`list` [`~lsst.geom.Point2I`]) ``nb90Rots`` The number of 90 degrees rotations required to compensate for detector orientation. (`int`)
Definition at line 356 of file processBrightStars.py.
|
staticprotected |
Definition at line 210 of file processBrightStars.py.
|
static |
Definition at line 209 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.modelCenter |
Definition at line 225 of file processBrightStars.py.
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.modelStampSize |
Definition at line 215 of file processBrightStars.py.