lsst.pipe.tasks g0537c5b946+40d232efd9
|
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.
Given an exposure with defects repaired (masked and interpolated over, e.g. as output by IsrTask):
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. # TODO DM-34769: remove rebObjLoader kwarg here. @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
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:
The command line task interface supports a flag --debug
to import debug.py
from your $PYTHONPATH
; see the lsstDebug documentation for more about debug.py
.
CharacterizeImageTask has a debug dictionary with the following keys:
For example, put something like:
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 253 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. # TODO DM-34769: remove rebObjLoader kwarg here. @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 350 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 541 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 630 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.getInitOutputDatasets | ( | self | ) |
Definition at line 394 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 623 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 452 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 400 of file characterizeImage.py.
def lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.runQuantum | ( | self, | |
butlerQC, | |||
inputRefs, | |||
outputRefs | |||
) |
Definition at line 343 of file characterizeImage.py.
lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.algMetadata |
Definition at line 380 of file characterizeImage.py.
|
static |
Definition at line 339 of file characterizeImage.py.
lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.outputSchema |
Definition at line 392 of file characterizeImage.py.
|
static |
Definition at line 341 of file characterizeImage.py.
lsst.pipe.tasks.characterizeImage.CharacterizeImageTask.schema |
Definition at line 369 of file characterizeImage.py.