lsst.pipe.tasks.multiBand.MergeSourcesTask Class Reference

A base class for merging source catalogs. More...

Inheritance diagram for lsst.pipe.tasks.multiBand.MergeSourcesTask:

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

Static Public Attributes
	ConfigClass = MergeSourcesConfig
	RunnerClass = MergeSourcesRunner
	inputDataset = None
	outputDataset = None
	getSchemaCatalogs = None

Detailed Description

A base class for merging source catalogs.

Merging detections (MergeDetectionsTask) and merging measurements (MergeMeasurementsTask) are so similar that it makes sense to re-use the code, in the form of this abstract base class.

NB: Do not use this class directly. Instead use one of the child classes that inherit from MergeSourcesTask such as MergeDetectionsTask or MergeMeasurementsTask

Sub-classes should set the following class variables:

• _DefaultName: name of Task
• inputDataset: name of dataset to read
• outputDataset: name of dataset to write
• getSchemaCatalogs to the result of _makeGetSchemaCatalogs(outputDataset)

In addition, sub-classes must implement the run method.

Definition at line 494 of file multiBand.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.__init__	(		self,
			butler = None,
			schema = None,
			kwargs
	)

Initialize the task.

Keyword arguments (in addition to those forwarded to CmdLineTask.__init__):

Parameters

[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

Derived classes should use the getInputSchema() method to handle the additional arguments and retreive the actual input schema.

Definition at line 550 of file multiBand.py.

    def __init__(self, butler=None, schema=None, **kwargs):
        """!
        @brief Initialize the task.

        Keyword arguments (in addition to those forwarded to CmdLineTask.__init__):
        @param[in]  schema   the schema of the detection catalogs used as input to this one
        @param[in]  butler   a butler used to read the input schema from disk, if schema is None

        Derived classes should use the getInputSchema() method to handle the additional
        arguments and retreive the actual input schema.
        """
        CmdLineTask.__init__(self, **kwargs)

Member Function Documentation

getInputSchema()

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

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

    def getInputSchema(self, butler=None, schema=None):
        """!
        @brief Obtain the input schema either directly or froma  butler reference.

        @param[in]  butler   butler reference to obtain the input schema from
        @param[in]  schema   the input schema
        """
        if schema is None:
            assert butler is not None, "Neither butler nor schema specified"
            schema = butler.get(self.config.coaddName + "Coadd_" + self.inputDataset + "_schema",
                                immediate=True).schema
        return schema

readCatalog()

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

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

    def readCatalog(self, patchRef):
        """!
        @brief Read input catalog.

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

        @param[in]  patchRef   data reference for patch
        @return tuple consisting of the filter name and the catalog
        """
        filterName = patchRef.dataId["filter"]
        catalog = patchRef.get(self.config.coaddName + "Coadd_" + self.inputDataset, immediate=True)
        self.log.info("Read %d sources for filter %s: %s" % (len(catalog), filterName, patchRef.dataId))
        return filterName, catalog

run()

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

Merge multiple catalogs.

This function must be defined in all subclasses that inherit from MergeSourcesTask.

Parameters

[in]

catalogs

dict mapping filter name to source catalog

Returns

merged catalog

Definition at line 589 of file multiBand.py.

    def run(self, catalogs, patchRef):
        """!
        @brief Merge multiple catalogs. This function must be defined in all subclasses that inherit from
        MergeSourcesTask.

        @param[in] catalogs dict mapping filter name to source catalog

        @return merged catalog
        """
        raise NotImplementedError()

runDataRef()

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

Merge coadd sources from multiple bands.

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

Parameters

[in]

patchRefList

list of data references for each filter

Definition at line 563 of file multiBand.py.

    def runDataRef(self, patchRefList):
        """!
        @brief Merge coadd sources from multiple bands. Calls @ref `run` which must be defined in
        subclasses that inherit from MergeSourcesTask.

        @param[in] patchRefList list of data references for each filter
        """
        catalogs = dict(self.readCatalog(patchRef) for patchRef in patchRefList)
        mergedCatalog = self.run(catalogs, patchRefList[0])
        self.write(patchRefList[0], mergedCatalog)

write()

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

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

    def write(self, patchRef, catalog):
        """!
        @brief Write the output.

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

        We write as the dataset provided by the 'outputDataset'
        class variable.
        """
        patchRef.put(catalog, self.config.coaddName + "Coadd_" + self.outputDataset)
        # since the filter isn't actually part of the data ID for the dataset we're saving,
        # it's confusing to see it in the log message, even if the butler simply ignores it.
        mergeDataId = patchRef.dataId.copy()
        del mergeDataId["filter"]
        self.log.info("Wrote merged catalog: %s" % (mergeDataId,))

writeMetadata()

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

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

Definition at line 617 of file multiBand.py.

    def writeMetadata(self, dataRefList):
        """!
        @brief No metadata to write, and not sure how to write it for a list of dataRefs.
        """
        pass

Member Data Documentation

ConfigClass

lsst.pipe.tasks.multiBand.MergeSourcesTask.ConfigClass = MergeSourcesConfig

static

Definition at line 516 of file multiBand.py.

getSchemaCatalogs

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

static

Definition at line 520 of file multiBand.py.

inputDataset

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

static

Definition at line 518 of file multiBand.py.

outputDataset

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

static

Definition at line 519 of file multiBand.py.

RunnerClass

lsst.pipe.tasks.multiBand.MergeSourcesTask.RunnerClass = MergeSourcesRunner

static

Definition at line 517 of file multiBand.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pipe_tasks/16.0-27-g78173a71+3/python/lsst/pipe/tasks/multiBand.py