lsst.pipe.tasks.matchBackgrounds.DataRefMatcher Class Reference

Public Member Functions
def	__init__ (self, butler, datasetType)
def	isMatch (self, ref0, ref1)
def	matchList (self, ref0, refList)

Detailed Description

Match data references for a specified dataset type

Note that this is not exact, but should suffice for this task
until there is better support for this kind of thing in the butler.

Definition at line 578 of file matchBackgrounds.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.matchBackgrounds.DataRefMatcher.__init__	(		self,
			butler,
			datasetType
	)

Construct a DataRefMatcher

@param[in] butler
@param[in] datasetType: dataset type to match

Definition at line 585 of file matchBackgrounds.py.

    def __init__(self, butler, datasetType):
        """Construct a DataRefMatcher
 
        @param[in] butler
        @param[in] datasetType: dataset type to match
        """
        self._datasetType = datasetType  # for diagnostics
        self._keyNames = butler.getKeys(datasetType)
 

Member Function Documentation

isMatch()

def lsst.pipe.tasks.matchBackgrounds.DataRefMatcher.isMatch	(		self,
			ref0,
			ref1
	)

Return True if ref0 == ref1

@param[in] ref0: data ref 0
@param[in] ref1: data ref 1

@raise KeyError if either ID is missing a key in keyNames

Definition at line 603 of file matchBackgrounds.py.

    def isMatch(self, ref0, ref1):
        """Return True if ref0 == ref1
 
        @param[in] ref0: data ref 0
        @param[in] ref1: data ref 1
 
        @raise KeyError if either ID is missing a key in keyNames
        """
        return self._makeKey(ref0) == self._makeKey(ref1)
 

matchList()

def lsst.pipe.tasks.matchBackgrounds.DataRefMatcher.matchList	(		self,
			ref0,
			refList
	)

Return a list of indices of matches

@return tuple of indices of matches

@raise KeyError if any ID is missing a key in keyNames

Definition at line 613 of file matchBackgrounds.py.

    def matchList(self, ref0, refList):
        """Return a list of indices of matches
 
        @return tuple of indices of matches
 
        @raise KeyError if any ID is missing a key in keyNames
        """
        key0 = self._makeKey(ref0)
        return tuple(ind for ind, ref in enumerate(refList) if self._makeKey(ref) == key0)

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/matchBackgrounds.py