lsst.pipe.tasks geee7ff78d7+12f2c8fe79
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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.

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__()

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

Definition at line 645 of file matchBackgrounds.py.

Member Function Documentation

◆ isMatch()

def 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.

◆ matchList()

def 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.


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