lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
lsst.pipe.tasks.repositoryIterator.RepositoryIterator Class Reference

Public Member Functions

def __init__ (self, formatStr, **dataDict)
 
def __iter__ (self)
 
def __len__ (self)
 
def format (self, valDict)
 
def getKeyTuple (self)
 

Protected Member Functions

def _getDTypeList (self)
 

Protected Attributes

 _formatStr
 
 _keyTuple
 
 _valListOfLists
 
 _dtype
 

Detailed Description

Iterate over a set of data repositories that use a naming convention based on parameter values

Definition at line 229 of file repositoryIterator.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator.__init__ (   self,
  formatStr,
**  dataDict 
)
Construct a repository iterator from a dict of name: valueList

@param[in] formatStr: format string using dictionary notation, e.g.: "%(foo)s_%(bar)d"
@param[in] **dataDict: name=valueList pairs

Definition at line 233 of file repositoryIterator.py.

Member Function Documentation

◆ __iter__()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator.__iter__ (   self)
Retrieve next RepositoryInfo object

Definition at line 245 of file repositoryIterator.py.

◆ __len__()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator.__len__ (   self)
Return the number of items in the iterator

Definition at line 253 of file repositoryIterator.py.

◆ _getDTypeList()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator._getDTypeList (   self)
protected
Get a dtype for a structured array of repository keys

Definition at line 272 of file repositoryIterator.py.

◆ format()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator.format (   self,
  valDict 
)
Return formatted string for a specified value dictionary

@param[in] valDict: a dict of key: value pairs that identify a repository

Definition at line 260 of file repositoryIterator.py.

◆ getKeyTuple()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator.getKeyTuple (   self)
Return the a tuple of keys in the same order as items in value tuples

Definition at line 267 of file repositoryIterator.py.

Member Data Documentation

◆ _dtype

lsst.pipe.tasks.repositoryIterator.RepositoryIterator._dtype
protected

Definition at line 242 of file repositoryIterator.py.

◆ _formatStr

lsst.pipe.tasks.repositoryIterator.RepositoryIterator._formatStr
protected

Definition at line 239 of file repositoryIterator.py.

◆ _keyTuple

lsst.pipe.tasks.repositoryIterator.RepositoryIterator._keyTuple
protected

Definition at line 240 of file repositoryIterator.py.

◆ _valListOfLists

lsst.pipe.tasks.repositoryIterator.RepositoryIterator._valListOfLists
protected

Definition at line 241 of file repositoryIterator.py.


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