lsst.pipe.tasks
16.0-49-g42e581f7+2
|
Merge coadd detections from multiple bands. More...
Public Member Functions | |
def | getInputSchema (self, butler=None, schema=None) |
def | __init__ (self, butler=None, schema=None, initInputs=None, kwargs) |
Initialize the merge detections task. More... | |
def | getInitOutputDatasets (self) |
def | runDataRef (self, patchRefList) |
def | adaptArgsAndRun (self, inputData, inputDataIds, outputDataIds, butler) |
def | run (self, catalogs, skyInfo, idFactory, skySeed) |
Merge multiple catalogs. More... | |
def | cullPeaks (self, catalog) |
Attempt to remove garbage peaks (mostly on the outskirts of large blends). More... | |
def | getSchemaCatalogs (self) |
Return a dict of empty catalogs for each catalog dataset produced by this task. More... | |
def | getSkySourceFootprints (self, mergedList, skyInfo, seed) |
Return a list of Footprints of sky objects which don't overlap with anything in mergedList. More... | |
def | write (self, patchRef, catalog) |
Write the output. More... | |
def | writeMetadata (self, dataRefList) |
No metadata to write, and not sure how to write it for a list of dataRefs. More... | |
Public Attributes | |
schema | |
merged | |
Static Public Attributes | |
ConfigClass = MergeDetectionsConfig | |
RunnerClass = MergeSourcesRunner | |
string | inputDataset = "det" |
string | outputDataset = "mergeDet" |
makeIdFactory = _makeMakeIdFactory("MergedCoaddId") | |
Merge coadd detections from multiple bands.
Command-line task that merges sources detected in coadds of exposures obtained with different filters.
To perform photometry consistently across coadds in multiple filter bands, we create a master catalog of sources from all bands by merging the sources (peaks & footprints) detected in each coadd, while keeping track of which band each source originates in.
The catalog merge is performed by getMergedSourceCatalog. Spurious peaks detected around bright objects are culled as described in CullPeaksConfig_.
Initialize the merge detections task. A FootprintMergeList will be used to merge the source catalogs.
[in] | schema | the schema of the detection catalogs used as input to this one |
[in] | butler | a butler used to read the input schema from disk, if schema is None |
[in] | initInputs | This a PipelineTask-only argument that holds all inputs passed in through the PipelineTask middleware |
[in] | **kwargs | keyword arguments to be passed to CmdLineTask.__init__ |
The task will set its own self.schema attribute to the schema of the output merged catalog.
Merge multiple catalogs. After ordering the catalogs and filters in priority order, getMergedSourceCatalog of the FootprintMergeList created by __init__ is used to perform the actual merging. Finally, cullPeaks is used to remove garbage peaks detected around bright objects.
[in] | catalogs | |
[in] | patchRef | |
[out] | mergedList |
The command line task interface supports a flag -d
to import debug.py from your PYTHONPATH
; see Using lsstDebug to control debugging output for more about debug.py files.
MergeDetectionsTask has no debug variables.
MergeDetectionsTask is meant to be run after detecting sources in coadds generated for the chosen subset of the available bands. The purpose of the task is to merge sources (peaks & footprints) detected in the coadds generated from the chosen subset of filters. Subsequent tasks in the multi-band processing procedure will deblend the generated master list of sources and, eventually, perform forced photometry. Command-line usage of MergeDetectionsTask expects data references for all the coadds to be processed. A list of the available optional arguments can be obtained by calling mergeCoaddDetections.py with the --help
command line argument:
To demonstrate usage of the DetectCoaddSourcesTask in the larger context of multi-band processing, we will process HSC data in the ci_hsc package. Assuming one has finished step 5 at pipeTasks_multiBand, one may merge the catalogs of sources from each coadd as follows:
This will merge the HSC-I & -R band parent source catalogs and write the results to $CI_HSC_DIR/DATA/deepCoadd-results/merged/0/5,4/mergeDet-0-5,4.fits
.
The next step in the multi-band processing procedure is MeasureMergedCoaddSourcesTask
Definition at line 109 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.__init__ | ( | self, | |
butler = None , |
|||
schema = None , |
|||
initInputs = None , |
|||
kwargs | |||
) |
Initialize the merge detections task.
A FootprintMergeList will be used to merge the source catalogs.
[in] | schema | the schema of the detection catalogs used as input to this one |
[in] | butler | a butler used to read the input schema from disk, if schema is None |
[in] | initInputs | This a PipelineTask-only argument that holds all inputs passed in through the PipelineTask middleware |
[in] | **kwargs | keyword arguments to be passed to CmdLineTask.__init__ |
The task will set its own self.schema attribute to the schema of the output merged catalog.
Definition at line 202 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.adaptArgsAndRun | ( | self, | |
inputData, | |||
inputDataIds, | |||
outputDataIds, | |||
butler | |||
) |
Definition at line 240 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.cullPeaks | ( | self, | |
catalog | |||
) |
Attempt to remove garbage peaks (mostly on the outskirts of large blends).
[in] | catalog | Source catalog |
Definition at line 309 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.getInitOutputDatasets | ( | self | ) |
Definition at line 229 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.getInputSchema | ( | self, | |
butler = None , |
|||
schema = None |
|||
) |
Definition at line 199 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.getSchemaCatalogs | ( | self | ) |
Return a dict of empty catalogs for each catalog dataset produced by this task.
[out] | dictionary | of empty catalogs |
Definition at line 337 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.getSkySourceFootprints | ( | self, | |
mergedList, | |||
skyInfo, | |||
seed | |||
) |
Return a list of Footprints of sky objects which don't overlap with anything in mergedList.
mergedList | The merged Footprints from all the input bands |
skyInfo | A description of the patch |
seed | Seed for the random number generator |
Definition at line 348 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.run | ( | self, | |
catalogs, | |||
skyInfo, | |||
idFactory, | |||
skySeed | |||
) |
Merge multiple catalogs.
After ordering the catalogs and filters in priority order, getMergedSourceCatalog of the FootprintMergeList created by __init__ is used to perform the actual merging. Finally, cullPeaks is used to remove garbage peaks detected around bright objects.
[in] | catalogs | |
[in] | patchRef | |
[out] | mergedList |
Definition at line 262 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.runDataRef | ( | self, | |
patchRefList | |||
) |
Definition at line 232 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.write | ( | self, | |
patchRef, | |||
catalog | |||
) |
Write the output.
[in] | patchRef | data reference for patch |
[in] | catalog | catalog |
We write as the dataset provided by the 'outputDataset' class variable.
Definition at line 379 of file mergeDetections.py.
def lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.writeMetadata | ( | self, | |
dataRefList | |||
) |
No metadata to write, and not sure how to write it for a list of dataRefs.
Definition at line 396 of file mergeDetections.py.
|
static |
Definition at line 188 of file mergeDetections.py.
|
static |
Definition at line 191 of file mergeDetections.py.
|
static |
Definition at line 193 of file mergeDetections.py.
lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.merged |
Definition at line 227 of file mergeDetections.py.
|
static |
Definition at line 192 of file mergeDetections.py.
|
static |
Definition at line 189 of file mergeDetections.py.
lsst.pipe.tasks.mergeDetections.MergeDetectionsTask.schema |
Definition at line 223 of file mergeDetections.py.