lsst.daf.persistence.butlerSubset.ButlerSubset Class Reference

Public Member Functions
def	__init__ (self, butler, datasetType, level, dataId)
def	__repr__ (self)
def	__len__ (self)
def	__iter__ (self)

Public Attributes
	butler
	datasetType
	dataId
	cache
	level

Static Public Attributes
int	GENERATION = 2

Detailed Description

ButlerSubset is a container for ButlerDataRefs.  It represents a
collection of data ids that can be used to obtain datasets of the type
used when creating the collection or a compatible dataset type.  It can be
thought of as the result of a query for datasets matching a partial data
id.

The ButlerDataRefs are generated at a specified level of the data id
hierarchy.  If that is not the level at which datasets are specified, the
ButlerDataRef.subItems() method may be used to dive further into the
ButlerDataRefs.

ButlerSubsets should generally be created using Butler.subset().

This mechanism replaces the creation of butlers using partial dataIds.

Public methods:

__init__(self, butler, datasetType, level, dataId)

__len__(self)

__iter__(self)

Definition at line 33 of file butlerSubset.py.

Constructor & Destructor Documentation

__init__()

def lsst.daf.persistence.butlerSubset.ButlerSubset.__init__	(		self,
			butler,
			datasetType,
			level,
			dataId
	)

Create a ButlerSubset by querying a butler for data ids matching a
given partial data id for a given dataset type at a given hierarchy
level.

@param butler (Butler)    butler that is being queried.
@param datasetType (str)  the type of dataset to query.
@param level (str)        the hierarchy level to descend to. if empty string will look up the default
                          level.
@param dataId (dict)      the (partial or complete) data id.

Definition at line 64 of file butlerSubset.py.

    def __init__(self, butler, datasetType, level, dataId):
        """
        Create a ButlerSubset by querying a butler for data ids matching a
        given partial data id for a given dataset type at a given hierarchy
        level.
 
        @param butler (Butler)    butler that is being queried.
        @param datasetType (str)  the type of dataset to query.
        @param level (str)        the hierarchy level to descend to. if empty string will look up the default
                                  level.
        @param dataId (dict)      the (partial or complete) data id.
        """
        self.butler = butler
        self.datasetType = datasetType
        self.dataId = DataId(dataId)
        self.cache = []
        self.level = level
 
        keys = self.butler.getKeys(datasetType, level, tag=dataId.tag)
        if keys is None:
            return
        fmt = list(keys.keys())
 
        # Don't query if we already have a complete dataId
        completeId = True
        for key in fmt:
            if key not in dataId:
                completeId = False
                break
        if completeId:
            self.cache.append(dataId)
            return
 
        idTuples = butler.queryMetadata(self.datasetType, fmt, self.dataId)
        for idTuple in idTuples:
            tempId = dict(self.dataId)
            if len(fmt) == 1:
                tempId[fmt[0]] = idTuple
            else:
                for i in range(len(fmt)):
                    tempId[fmt[i]] = idTuple[i]
            self.cache.append(tempId)
 

Member Function Documentation

__iter__()

def lsst.daf.persistence.butlerSubset.ButlerSubset.__iter__

(

self

)

Iterator over the ButlerDataRefs in the ButlerSubset.

@returns (ButlerIterator)

Definition at line 120 of file butlerSubset.py.

    def __iter__(self):
        """
        Iterator over the ButlerDataRefs in the ButlerSubset.
 
        @returns (ButlerIterator)
        """
 
        return ButlerSubsetIterator(self)
 
 

__len__()

def lsst.daf.persistence.butlerSubset.ButlerSubset.__len__

(

self

)

Number of ButlerDataRefs in the ButlerSubset.

@returns (int)

Definition at line 111 of file butlerSubset.py.

    def __len__(self):
        """
        Number of ButlerDataRefs in the ButlerSubset.
 
        @returns (int)
        """
 
        return len(self.cache)
 

__repr__()

def lsst.daf.persistence.butlerSubset.ButlerSubset.__repr__

(

self

)

Definition at line 107 of file butlerSubset.py.

    def __repr__(self):
        return "ButlerSubset(butler=%s, datasetType=%s, dataId=%s, cache=%s, level=%s)" % (
            self.butler, self.datasetType, self.dataId, self.cache, self.level)
 

Member Data Documentation

butler

lsst.daf.persistence.butlerSubset.ButlerSubset.butler

Definition at line 76 of file butlerSubset.py.

cache

lsst.daf.persistence.butlerSubset.ButlerSubset.cache

Definition at line 79 of file butlerSubset.py.

dataId

lsst.daf.persistence.butlerSubset.ButlerSubset.dataId

Definition at line 78 of file butlerSubset.py.

datasetType

lsst.daf.persistence.butlerSubset.ButlerSubset.datasetType

Definition at line 77 of file butlerSubset.py.

GENERATION

int lsst.daf.persistence.butlerSubset.ButlerSubset.GENERATION = 2

static

Definition at line 60 of file butlerSubset.py.

level

lsst.daf.persistence.butlerSubset.ButlerSubset.level

Definition at line 80 of file butlerSubset.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/daf_persistence/22.0.1-4-g243d05b+871c1b8305/python/lsst/daf/persistence/butlerSubset.py