LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Measure bright sources and use this to estimate background and PSF of an exposure. More...
Public Member Functions | |
def | runQuantum (self, butlerQC, inputRefs, outputRefs) |
def | __init__ (self, butler=None, refObjLoader=None, schema=None, **kwargs) |
Construct a CharacterizeImageTask. More... | |
def | getInitOutputDatasets (self) |
def | runDataRef (self, dataRef, exposure=None, background=None, doUnpersist=True) |
Characterize a science image and, if wanted, persist the results. More... | |
def | run (self, exposure, exposureIdInfo=None, background=None) |
Characterize a science image. More... | |
def | detectMeasureAndEstimatePsf (self, exposure, exposureIdInfo, background) |
Perform one iteration of detect, measure and estimate PSF. More... | |
def | getSchemaCatalogs (self) |
def | display (self, itemName, exposure, sourceCat=None) |
Public Attributes | |
schema | |
algMetadata | |
outputSchema | |
Static Public Attributes | |
ConfigClass = CharacterizeImageConfig | |
RunnerClass = pipeBase.ButlerInitializedTaskRunner | |
Measure bright sources and use this to estimate background and PSF of an exposure.
@anchor CharacterizeImageTask_ @section pipe_tasks_characterizeImage_Contents Contents - @ref pipe_tasks_characterizeImage_Purpose - @ref pipe_tasks_characterizeImage_Initialize - @ref pipe_tasks_characterizeImage_IO - @ref pipe_tasks_characterizeImage_Config - @ref pipe_tasks_characterizeImage_Debug @section pipe_tasks_characterizeImage_Purpose Description Given an exposure with defects repaired (masked and interpolated over, e.g. as output by IsrTask): - detect and measure bright sources - repair cosmic rays - measure and subtract background - measure PSF @section pipe_tasks_characterizeImage_Initialize Task initialisation @copydoc \_\_init\_\_ @section pipe_tasks_characterizeImage_IO Invoking the Task If you want this task to unpersist inputs or persist outputs, then call the `runDataRef` method (a thin wrapper around the `run` method). If you already have the inputs unpersisted and do not want to persist the output then it is more direct to call the `run` method: @section pipe_tasks_characterizeImage_Config Configuration parameters See @ref CharacterizeImageConfig @section pipe_tasks_characterizeImage_Debug Debug variables The @link lsst.pipe.base.cmdLineTask.CmdLineTask command line task@endlink interface supports a flag `--debug` to import `debug.py` from your `$PYTHONPATH`; see @ref baseDebug for more about `debug.py`. CharacterizeImageTask has a debug dictionary with the following keys: <dl> <dt>frame <dd>int: if specified, the frame of first debug image displayed (defaults to 1) <dt>repair_iter <dd>bool; if True display image after each repair in the measure PSF loop <dt>background_iter <dd>bool; if True display image after each background subtraction in the measure PSF loop <dt>measure_iter <dd>bool; if True display image and sources at the end of each iteration of the measure PSF loop See @ref lsst.meas.astrom.displayAstrometry for the meaning of the various symbols. <dt>psf <dd>bool; if True display image and sources after PSF is measured; this will be identical to the final image displayed by measure_iter if measure_iter is true <dt>repair <dd>bool; if True display image and sources after final repair <dt>measure <dd>bool; if True display image and sources after final measurement </dl> For example, put something like: @code{.py} import lsstDebug def DebugInfo(name): di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively if name == "lsst.pipe.tasks.characterizeImage": di.display = dict( repair = True, ) return di lsstDebug.Info = DebugInfo @endcode into your `debug.py` file and run `calibrateTask.py` with the `--debug` flag. Some subtasks may have their own debug variables; see individual Task documentation.
Definition at line 251 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.__init__ | ( | self, | |
butler = None , |
|||
refObjLoader = None , |
|||
schema = None , |
|||
** | kwargs | ||
) |
Construct a CharacterizeImageTask.
@param[in] butler A butler object is passed to the refObjLoader constructor in case it is needed to load catalogs. May be None if a catalog-based star selector is not used, if the reference object loader constructor does not require a butler, or if a reference object loader is passed directly via the refObjLoader argument. @param[in] refObjLoader An instance of LoadReferenceObjectsTasks that supplies an external reference catalog to a catalog-based star selector. May be None if a catalog star selector is not used or the loader can be constructed from the butler argument. @param[in,out] schema initial schema (an lsst.afw.table.SourceTable), or None @param[in,out] kwargs other keyword arguments for lsst.pipe.base.CmdLineTask
Definition at line 346 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.detectMeasureAndEstimatePsf | ( | self, | |
exposure, | |||
exposureIdInfo, | |||
background | |||
) |
Perform one iteration of detect, measure and estimate PSF.
Performs the following operations: - if config.doMeasurePsf or not exposure.hasPsf(): - install a simple PSF model (replacing the existing one, if need be) - interpolate over cosmic rays with keepCRs=True - estimate background and subtract it from the exposure - detect, deblend and measure sources, and subtract a refined background model; - if config.doMeasurePsf: - measure PSF @param[in,out] exposure exposure to characterize (an lsst.afw.image.ExposureF or similar) The following changes are made: - update or set psf - update detection and cosmic ray mask planes - subtract background @param[in] exposureIdInfo ID info for exposure (an lsst.obs_base.ExposureIdInfo) @param[in,out] background initial model of background already subtracted from exposure (an lsst.afw.math.BackgroundList). @return pipe_base Struct containing these fields, all from the final iteration of detect sources, measure sources and estimate PSF: - exposure characterized exposure; image is repaired by interpolating over cosmic rays, mask is updated accordingly, and the PSF model is set - sourceCat detected sources (an lsst.afw.table.SourceCatalog) - background model of background subtracted from exposure (an lsst.afw.math.BackgroundList) - psfCellSet spatial cells of PSF candidates (an lsst.afw.math.SpatialCellSet)
Definition at line 531 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.display | ( | self, | |
itemName, | |||
exposure, | |||
sourceCat = None |
|||
) |
Display exposure and sources on next frame, if display of itemName has been requested @param[in] itemName name of item in debugInfo @param[in] exposure exposure to display @param[in] sourceCat source catalog to display
Definition at line 619 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.getInitOutputDatasets | ( | self | ) |
Definition at line 388 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.getSchemaCatalogs | ( | self | ) |
Return a dict of empty catalogs for each catalog dataset produced by this task.
Definition at line 612 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.run | ( | self, | |
exposure, | |||
exposureIdInfo = None , |
|||
background = None |
|||
) |
Characterize a science image.
Peforms the following operations: - Iterate the following config.psfIterations times, or once if config.doMeasurePsf false: - detect and measure sources and estimate PSF (see detectMeasureAndEstimatePsf for details) - interpolate over cosmic rays - perform final measurement @param[in,out] exposure exposure to characterize (an lsst.afw.image.ExposureF or similar). The following changes are made: - update or set psf - set apCorrMap - update detection and cosmic ray mask planes - subtract background and interpolate over cosmic rays @param[in] exposureIdInfo ID info for exposure (an lsst.obs.base.ExposureIdInfo). If not provided, returned SourceCatalog IDs will not be globally unique. @param[in,out] background initial model of background already subtracted from exposure (an lsst.afw.math.BackgroundList). May be None if no background has been subtracted, which is typical for image characterization. @return pipe_base Struct containing these fields, all from the final iteration of detectMeasureAndEstimatePsf: - exposure: characterized exposure; image is repaired by interpolating over cosmic rays, mask is updated accordingly, and the PSF model is set - sourceCat: detected sources (an lsst.afw.table.SourceCatalog) - background: model of background subtracted from exposure (an lsst.afw.math.BackgroundList) - psfCellSet: spatial cells of PSF candidates (an lsst.afw.math.SpatialCellSet)
Definition at line 446 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.runDataRef | ( | self, | |
dataRef, | |||
exposure = None , |
|||
background = None , |
|||
doUnpersist = True |
|||
) |
Characterize a science image and, if wanted, persist the results.
This simply unpacks the exposure and passes it to the characterize method to do the work. @param[in] dataRef: butler data reference for science exposure @param[in,out] exposure exposure to characterize (an lsst.afw.image.ExposureF or similar). If None then unpersist from "postISRCCD". The following changes are made, depending on the config: - set psf to the measured PSF - set apCorrMap to the measured aperture correction - subtract background - interpolate over cosmic rays - update detection and cosmic ray mask planes @param[in,out] background initial model of background already subtracted from exposure (an lsst.afw.math.BackgroundList). May be None if no background has been subtracted, which is typical for image characterization. A refined background model is output. @param[in] doUnpersist if True the exposure is read from the repository and the exposure and background arguments must be None; if False the exposure must be provided. True is intended for running as a command-line task, False for running as a subtask @return same data as the characterize method
Definition at line 394 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.runQuantum | ( | self, | |
butlerQC, | |||
inputRefs, | |||
outputRefs | |||
) |
Definition at line 339 of file characterizeImage.py.
lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.algMetadata |
Definition at line 374 of file characterizeImage.py.
|
static |
Definition at line 335 of file characterizeImage.py.
lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.outputSchema |
Definition at line 386 of file characterizeImage.py.
|
static |
Definition at line 337 of file characterizeImage.py.
lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.schema |
Definition at line 364 of file characterizeImage.py.