lsst.pipe.tasks.dcrMultiBand.MergeDcrDetectionsTask Class Reference

Inheritance diagram for lsst.pipe.tasks.dcrMultiBand.MergeDcrDetectionsTask:

Public Member Functions
def	mergeCatalogs (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	run (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 103 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]

catalog

Source catalog

Definition at line 750 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]	butler	butler reference to obtain the input schema from
[in]	schema	the input schema

Definition at line 438 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]

dictionary

of empty catalogs

Definition at line 778 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

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 789 of file multiBand.py.

mergeCatalogs()

def lsst.pipe.tasks.multiBand.MergeDetectionsTask.mergeCatalogs (   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 701 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]

patchRef

data reference for patch

Returns

tuple consisting of the filter name and the catalog

Definition at line 475 of file multiBand.py.

run()

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

inherited

Merge coadd sources from multiple bands.

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

Parameters

[in]

patchRefList

list of data references for each filter

Definition at line 464 of file multiBand.py.

write()

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

inherited

Write the output.

Parameters

[in]	patchRef	data reference for patch
[in]	catalog	catalog

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

Definition at line 501 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 518 of file multiBand.py.

Member Data Documentation

ConfigClass

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

staticinherited

Definition at line 673 of file multiBand.py.

getSchemaCatalogs

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

staticinherited

Definition at line 421 of file multiBand.py.

inputDataset

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

staticinherited

Definition at line 675 of file multiBand.py.

makeIdFactory

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

staticinherited

Definition at line 677 of file multiBand.py.

merged

lsst.pipe.tasks.multiBand.MergeDetectionsTask.merged

inherited

Definition at line 699 of file multiBand.py.

outputDataset

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

staticinherited

Definition at line 676 of file multiBand.py.

RunnerClass

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

static

Definition at line 106 of file dcrMultiBand.py.

schema

lsst.pipe.tasks.multiBand.MergeDetectionsTask.schema

inherited

Definition at line 695 of file multiBand.py.

---

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

• python/lsst/pipe/tasks/dcrMultiBand.py