lsst.afw.detection._footprintMerge.FootprintMergeList Class Reference

Public Member Functions
	getMergedSourceCatalog (self, catalogs, filters, peakDist, schema, idFactory, samePeakDist)

Detailed Description

Definition at line 29 of file _footprintMerge.py.

Member Function Documentation

getMergedSourceCatalog()

lsst.afw.detection._footprintMerge.FootprintMergeList.getMergedSourceCatalog	(		self,
			catalogs,
			filters,
			peakDist,
			schema,
			idFactory,
			samePeakDist )

Add multiple catalogs and get the SourceCatalog with merged Footprints

Parameters
----------
catalogs : `list` [`lsst.afw.table.SourceCatalog`]
    list of catalogs
filters : `list` [`str`]
    list of filters
peakDist : `float` or `list` [`float`]
    distance between source peaks
schema : `lsst.afw.table.Schema`
idFactory : `lsst.afw.table.IdFactory`
samePeakDist : `float` or `list [`float`]
    distance between source peaks (check)

Returns
-------
mergedList : `lsst.afw.table.SourceCatalog`
    merged list of sources

See also
--------
lsst.afw.table.SourceTable

Definition at line 30 of file _footprintMerge.py.

                               peakDist, schema, idFactory, samePeakDist):
        """Add multiple catalogs and get the SourceCatalog with merged Footprints
 
        Parameters
        ----------
        catalogs : `list` [`lsst.afw.table.SourceCatalog`]
            list of catalogs
        filters : `list` [`str`]
            list of filters
        peakDist : `float` or `list` [`float`]
            distance between source peaks
        schema : `lsst.afw.table.Schema`
        idFactory : `lsst.afw.table.IdFactory`
        samePeakDist : `float` or `list [`float`]
            distance between source peaks (check)
 
        Returns
        -------
        mergedList : `lsst.afw.table.SourceCatalog`
            merged list of sources
 
        See also
        --------
        lsst.afw.table.SourceTable
 
        """
 
        import lsst.afw.table as afwTable
 
        table = afwTable.SourceTable.make(schema, idFactory)
        mergedList = afwTable.SourceCatalog(table)
 
        # if peak is not an array, create an array the size of catalogs
        try:
            len(samePeakDist)
        except TypeError:
            samePeakDist = [samePeakDist] * len(catalogs)
 
        try:
            len(peakDist)
        except TypeError:
            peakDist = [peakDist] * len(catalogs)
 
        if len(peakDist) != len(catalogs):
            raise ValueError("Number of catalogs (%d) does not match length of peakDist (%d)"
                             % (len(catalogs), len(peakDist)))
 
        if len(samePeakDist) != len(catalogs):
            raise ValueError("Number of catalogs (%d) does not match length of samePeakDist (%d)"
                             % (len(catalogs), len(samePeakDist)))
 
        if len(filters) != len(catalogs):
            raise ValueError("Number of catalogs (%d) does not match number of filters (%d)"
                             % (len(catalogs), len(filters)))
 
        self.clearCatalog()
        for cat, filter, dist, sameDist in zip(catalogs, filters, peakDist, samePeakDist):
            self.addCatalog(table, cat, filter, dist, True, sameDist)
 
        self.getFinalSources(mergedList)
        return mergedList

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/ge3d4d395c2+224150c836/python/lsst/afw/detection/_footprintMerge.py