lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | 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)
 

Protected Member Functions

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

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.

Member Function Documentation

◆ _makeKey()

def lsst.pipe.tasks.matchBackgrounds.DataRefMatcher._makeKey (   self,
  ref 
)
protected
Return a tuple of values for the specified keyNames

@param[in] ref: data reference

@raise KeyError if ref.dataId is missing a key in keyNames

Definition at line 594 of file matchBackgrounds.py.

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

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

Member Data Documentation

◆ _datasetType

lsst.pipe.tasks.matchBackgrounds.DataRefMatcher._datasetType
protected

Definition at line 591 of file matchBackgrounds.py.

◆ _keyNames

lsst.pipe.tasks.matchBackgrounds.DataRefMatcher._keyNames
protected

Definition at line 592 of file matchBackgrounds.py.


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