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)

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.

    def __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
        """
        self._formatStr = formatStr
        self._keyTuple = tuple(sorted(dataDict.keys()))
        self._valListOfLists = [numpy.array(dataDict[key]) for key in self._keyTuple]
        self._dtype = [(key, self._valListOfLists[i].dtype)
                       for i, key in enumerate(self._keyTuple)]
 

Member Function Documentation

__iter__()

def lsst.pipe.tasks.repositoryIterator.RepositoryIterator.__iter__

(

self

)

Retrieve next RepositoryInfo object

Definition at line 245 of file repositoryIterator.py.

    def __iter__(self):
        """Retrieve next RepositoryInfo object
        """
        for valTuple in itertools.product(*self._valListOfLists):
            valDict = dict(zip(self._keyTuple, valTuple))
            name = self.format(valDict)
            yield RepositoryInfo(keyTuple=self._keyTuple, valTuple=valTuple, dtype=self._dtype, name=name)
 

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

    def __len__(self):
        """Return the number of items in the iterator"""
        n = 1
        for valTuple in self._valListOfLists:
            n *= len(valTuple)
        return n
 

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.

    def format(self, valDict):
        """Return formatted string for a specified value dictionary
 
        @param[in] valDict: a dict of key: value pairs that identify a repository
        """
        return self._formatStr % valDict
 

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.

    def getKeyTuple(self):
        """Return the a tuple of keys in the same order as items in value tuples
        """
        return self._keyTuple
 

---

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/repositoryIterator.py