lsst.pipe.tasks  17.0.1-23-gf3eadeb7+3
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig Class Reference

Configuration parameters for the MergeDetectionsTask. More...

Inheritance diagram for lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig:

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 minNewPeak
 
 maxSamePeak
 
 cullPeaks = ConfigField(dtype=CullPeaksConfig, doc="Configuration for how to cull peaks.")
 
 skyFilterName
 
 skyObjects = ConfigurableField(target=SkyObjectsTask, doc="Generate sky objects")
 
 priorityList
 
 coaddName = Field(dtype=str, default="deep", doc="Name of coadd")
 
 schema
 
 outputSchema
 
 outputPeakSchema
 
 catalogs
 
 skyMap
 
 outputCatalog
 

Detailed Description

Configuration parameters for the MergeDetectionsTask.

Definition at line 39 of file mergeDetections.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.setDefaults (   self)

Definition at line 102 of file mergeDetections.py.

◆ validate()

def lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.validate (   self)

Definition at line 108 of file mergeDetections.py.

Member Data Documentation

◆ catalogs

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.catalogs
static
Initial value:
= InputDatasetField(
doc="Detection Catalogs to be merged",
nameTemplate="{inputCoaddName}Coadd_det",
storageClass="SourceCatalog",
dimensions=("tract", "patch", "skymap", "abstract_filter")
)

Definition at line 79 of file mergeDetections.py.

◆ coaddName

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.coaddName = Field(dtype=str, default="deep", doc="Name of coadd")
static

Definition at line 59 of file mergeDetections.py.

◆ cullPeaks

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.cullPeaks = ConfigField(dtype=CullPeaksConfig, doc="Configuration for how to cull peaks.")
static

Definition at line 51 of file mergeDetections.py.

◆ maxSamePeak

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.maxSamePeak
static
Initial value:
= Field(dtype=float, default=0.3,
doc="When adding new catalogs to the merge, all peaks less than this distance "
" (in arcsec) to an existing peak will be flagged as detected in that catalog.")

Definition at line 48 of file mergeDetections.py.

◆ minNewPeak

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.minNewPeak
static
Initial value:
= Field(dtype=float, default=1,
doc="Minimum distance from closest peak to create a new one (in arcsec).")

Definition at line 45 of file mergeDetections.py.

◆ outputCatalog

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.outputCatalog
static
Initial value:
= OutputDatasetField(
doc="Merged Detection catalog",
nameTemplate="{outputCoaddName}Coadd_mergeDet",
storageClass="SourceCatalog",
dimensions=("tract", "patch", "skymap"),
scalar=True
)

Definition at line 94 of file mergeDetections.py.

◆ outputPeakSchema

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.outputPeakSchema
static
Initial value:
= InitOutputDatasetField(
doc="Output schema of the Footprint peak catalog",
nameTemplate="{outputCoaddName}Coadd_peak_schema",
storageClass="PeakCatalog"
)

Definition at line 73 of file mergeDetections.py.

◆ outputSchema

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.outputSchema
static
Initial value:
= InitOutputDatasetField(
doc="Schema of the merged detection catalog",
nameTemplate="{outputCoaddName}Coadd_mergeDet_schema",
storageClass="SourceCatalog"
)

Definition at line 67 of file mergeDetections.py.

◆ priorityList

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.priorityList
static
Initial value:
= ListField(dtype=str, default=[],
doc="Priority-ordered list of bands for the merge.")

Definition at line 57 of file mergeDetections.py.

◆ schema

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.schema
static
Initial value:
= InitInputDatasetField(
doc="Schema of the input detection catalog",
nameTemplate="{inputCoaddName}Coadd_det_schema",
storageClass="SourceCatalog"
)

Definition at line 61 of file mergeDetections.py.

◆ skyFilterName

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.skyFilterName
static
Initial value:
= Field(dtype=str, default="sky",
doc="Name of `filter' used to label sky objects (e.g. flag merge_peak_sky is set)\n"
"(N.b. should be in MergeMeasurementsConfig.pseudoFilterList)")

Definition at line 53 of file mergeDetections.py.

◆ skyMap

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.skyMap
static
Initial value:
= InputDatasetField(
doc="SkyMap to be used in merging",
nameTemplate="{inputCoaddName}Coadd_skyMap",
storageClass="SkyMap",
dimensions=("skymap",),
scalar=True
)

Definition at line 86 of file mergeDetections.py.

◆ skyObjects

lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig.skyObjects = ConfigurableField(target=SkyObjectsTask, doc="Generate sky objects")
static

Definition at line 56 of file mergeDetections.py.


The documentation for this class was generated from the following file: