lsst.pipe.tasks.matchBackgrounds.DataRefMatcher Class Reference

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

Protected Member Functions
	_makeKey (self, ref)

Protected Attributes
	_datasetType
	_keyNames

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.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler to search for maches in.
datasetType : `str`
    Dataset type to match.

Definition at line 631 of file matchBackgrounds.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 645 of file matchBackgrounds.py.

    def __init__(self, butler, datasetType):
        self._datasetType = datasetType  # for diagnostics
        self._keyNames = butler.getKeys(datasetType)
 

Member Function Documentation

_makeKey()

lsst.pipe.tasks.matchBackgrounds.DataRefMatcher._makeKey ( self, ref )

protected

Return a tuple of values for the specified keyNames.

Parameters
----------
ref : `Unknown`
    Data reference.

Raises
------
KeyError
    Raised if ref.dataId is missing a key in keyNames.

Definition at line 649 of file matchBackgrounds.py.

    def _makeKey(self, ref):
        """Return a tuple of values for the specified keyNames.
 
        Parameters
        ----------
        ref : `Unknown`
            Data reference.
 
        Raises
        ------
        KeyError
            Raised if ref.dataId is missing a key in keyNames.
        """
        return tuple(ref.dataId[key] for key in self._keyNames)
 

isMatch()

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

Return True if ref0 == ref1.

Parameters
----------
ref0 : `Unknown`
    Data for ref 0.
ref1 : `Unknown`
    Data for ref 1.

Raises
------
KeyError
    Raised if either ID is missing a key in keyNames.

Definition at line 664 of file matchBackgrounds.py.

    def isMatch(self, ref0, ref1):
        """Return True if ref0 == ref1.
 
        Parameters
        ----------
        ref0 : `Unknown`
            Data for ref 0.
        ref1 : `Unknown`
            Data for ref 1.
 
        Raises
        ------
        KeyError
            Raised if either ID is missing a key in keyNames.
        """
        return self._makeKey(ref0) == self._makeKey(ref1)
 

matchList()

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

Return a list of indices of matches.

Parameters
----------
ref0 : `Unknown`
    Data for ref 0.
`refList` : `list`

Returns
-------
matches : `tuple`
    Tuple of indices of matches.

Raises
------
KeyError
    Raised if any ID is missing a key in keyNames.

Definition at line 681 of file matchBackgrounds.py.

    def matchList(self, ref0, refList):
        """Return a list of indices of matches.
 
        Parameters
        ----------
        ref0 : `Unknown`
            Data for ref 0.
        `refList` : `list`
 
        Returns
        -------
        matches : `tuple`
            Tuple of indices of matches.
 
        Raises
        ------
        KeyError
            Raised 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)

Member Data Documentation

_datasetType

lsst.pipe.tasks.matchBackgrounds.DataRefMatcher._datasetType

protected

Definition at line 646 of file matchBackgrounds.py.

_keyNames

lsst.pipe.tasks.matchBackgrounds.DataRefMatcher._keyNames

protected

Definition at line 647 of file matchBackgrounds.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+f6e5778202/python/lsst/pipe/tasks/matchBackgrounds.py