lsst.pipe.tasks  16.0-26-g0359d09d+1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.dcrMultiBand.MergeDcrDetectionsTask Class Reference
Inheritance diagram for lsst.pipe.tasks.dcrMultiBand.MergeDcrDetectionsTask:
lsst.pipe.tasks.multiBand.MergeDetectionsTask lsst.pipe.tasks.multiBand.MergeSourcesTask

Public Member Functions

def run (self, catalogs, patchRef)
 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 getInputSchema (self, butler=None, schema=None)
 Obtain the input schema either directly or froma butler reference. More...
 
def runDataRef (self, patchRefList)
 Merge coadd sources from multiple bands. More...
 
def readCatalog (self, patchRef)
 Read input catalog. 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

 RunnerClass = MergeDcrSourcesRunner
 
 ConfigClass = MergeDetectionsConfig
 
string inputDataset = "det"
 
string outputDataset = "mergeDet"
 
 makeIdFactory = _makeMakeIdFactory("MergedCoaddId")
 
 getSchemaCatalogs = None
 

Detailed Description

Merge dcrCoadd detections from multiple subfilters.

Definition at line 170 of file dcrMultiBand.py.

Member Function Documentation

◆ cullPeaks()

def lsst.pipe.tasks.multiBand.MergeDetectionsTask.cullPeaks (   self,
  catalog 
)
inherited

Attempt to remove garbage peaks (mostly on the outskirts of large blends).

Parameters
[in]catalogSource catalog

Definition at line 849 of file multiBand.py.

◆ getInputSchema()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.getInputSchema (   self,
  butler = None,
  schema = None 
)
inherited

Obtain the input schema either directly or froma butler reference.

Parameters
[in]butlerbutler reference to obtain the input schema from
[in]schemathe input schema

Definition at line 537 of file multiBand.py.

◆ getSchemaCatalogs()

def lsst.pipe.tasks.multiBand.MergeDetectionsTask.getSchemaCatalogs (   self)
inherited

Return a dict of empty catalogs for each catalog dataset produced by this task.

Parameters
[out]dictionaryof empty catalogs

Definition at line 877 of file multiBand.py.

◆ getSkySourceFootprints()

def lsst.pipe.tasks.multiBand.MergeDetectionsTask.getSkySourceFootprints (   self,
  mergedList,
  skyInfo,
  seed 
)
inherited

Return a list of Footprints of sky objects which don't overlap with anything in mergedList.

Parameters
mergedListThe merged Footprints from all the input bands
skyInfoA description of the patch
seedSeed for the random number generator

Definition at line 888 of file multiBand.py.

◆ readCatalog()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.readCatalog (   self,
  patchRef 
)
inherited

Read input catalog.

We read the input dataset provided by the 'inputDataset' class variable.

Parameters
[in]patchRefdata reference for patch
Returns
tuple consisting of the filter name and the catalog

Definition at line 574 of file multiBand.py.

◆ run()

def lsst.pipe.tasks.multiBand.MergeDetectionsTask.run (   self,
  catalogs,
  patchRef 
)
inherited

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.

Parameters
[in]catalogs
[in]patchRef
[out]mergedList

Definition at line 800 of file multiBand.py.

◆ runDataRef()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.runDataRef (   self,
  patchRefList 
)
inherited

Merge coadd sources from multiple bands.

Calls run which must be defined in subclasses that inherit from MergeSourcesTask.

Parameters
[in]patchRefListlist of data references for each filter

Definition at line 563 of file multiBand.py.

◆ write()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.write (   self,
  patchRef,
  catalog 
)
inherited

Write the output.

Parameters
[in]patchRefdata reference for patch
[in]catalogcatalog

We write as the dataset provided by the 'outputDataset' class variable.

Definition at line 600 of file multiBand.py.

◆ writeMetadata()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.writeMetadata (   self,
  dataRefList 
)
inherited

No metadata to write, and not sure how to write it for a list of dataRefs.

Definition at line 617 of file multiBand.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.multiBand.MergeDetectionsTask.ConfigClass = MergeDetectionsConfig
staticinherited

Definition at line 772 of file multiBand.py.

◆ getSchemaCatalogs

lsst.pipe.tasks.multiBand.MergeSourcesTask.getSchemaCatalogs = None
staticinherited

Definition at line 520 of file multiBand.py.

◆ inputDataset

string lsst.pipe.tasks.multiBand.MergeDetectionsTask.inputDataset = "det"
staticinherited

Definition at line 774 of file multiBand.py.

◆ makeIdFactory

lsst.pipe.tasks.multiBand.MergeDetectionsTask.makeIdFactory = _makeMakeIdFactory("MergedCoaddId")
staticinherited

Definition at line 776 of file multiBand.py.

◆ merged

lsst.pipe.tasks.multiBand.MergeDetectionsTask.merged
inherited

Definition at line 798 of file multiBand.py.

◆ outputDataset

string lsst.pipe.tasks.multiBand.MergeDetectionsTask.outputDataset = "mergeDet"
staticinherited

Definition at line 775 of file multiBand.py.

◆ RunnerClass

lsst.pipe.tasks.dcrMultiBand.MergeDcrDetectionsTask.RunnerClass = MergeDcrSourcesRunner
static

Definition at line 173 of file dcrMultiBand.py.

◆ schema

lsst.pipe.tasks.multiBand.MergeDetectionsTask.schema
inherited

Definition at line 794 of file multiBand.py.


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