lsst.daf.persistence.butlerLocation.ButlerComposite Class Reference

Classes
class	ComponentInfo

Public Member Functions
def	__repr__ (self)
def	__init__ (self, assembler, disassembler, python, dataId, mapper)
def	add (self, id, datasetType, setter, getter, subset, inputOnly)
def	setRepository (self, repository)
def	getRepository (self)
def	getPythonType (self)

Public Attributes
	assembler
	disassembler
	python
	dataId
	mapper
	componentInfo
	repository

Detailed Description

Initializer

Parameters
----------
assembler : function object
    Function object or importable string to a function object that can be called with the assembler
    signature: (dataId, componentDict, cls).
disassembler : function object
    Function object or importable string to a function object that can be called with the disassembler
    signature: (object, dataId, componentDict).
python : class object
    A python class object or importable string to a class object that can be used by the assembler to
    instantiate an object to be returned.
dataId : dict or DataId
    The dataId that is used to look up components.
mapper : Mapper instance
    A reference to the mapper that created this ButlerComposite object.

Definition at line 36 of file butlerLocation.py.

Constructor & Destructor Documentation

__init__()

def lsst.daf.persistence.butlerLocation.ButlerComposite.__init__	(		self,
			assembler,
			disassembler,
			python,
			dataId,
			mapper
	)

Definition at line 102 of file butlerLocation.py.

    def __init__(self, assembler, disassembler, python, dataId, mapper):
        self.assembler = doImport(assembler) if isinstance(assembler, str) else assembler
        self.disassembler = doImport(disassembler) if isinstance(disassembler, str) else disassembler
        self.python = doImport(python) if isinstance(python, str) else python
        self.dataId = dataId
        self.mapper = mapper
        self.componentInfo = {}
        self.repository = None
 

Member Function Documentation

__repr__()

def lsst.daf.persistence.butlerLocation.ButlerComposite.__repr__

(

self

)

Definition at line 91 of file butlerLocation.py.

    def __repr__(self):
        return 'ButlerComposite(assembler:%s, disassembler:%s, python:%s, dataId:%s, mapper:%s, ' \
            'componentInfo:%s, repository:%s)' % \
            (self.assembler,
             self.disassembler,
             self.python,
             self.dataId,
             self.mapper,
             self.componentInfo,
             self.repository)
 

add()

def lsst.daf.persistence.butlerLocation.ButlerComposite.add	(		self,
			id,
			datasetType,
			setter,
			getter,
			subset,
			inputOnly
	)

Add a description of a component needed to fetch the composite dataset.

Parameters
----------
id : string
    The name of the component in the policy definition.
datasetType : string
    The name of the datasetType of the component.
setter : string or None
    The name of the function used to set this component into the python type that contains it.
    Specifying a setter is optional, use None if the setter won't be specified or used.
getter : string or None
    The name of the function used to get this component from the python type that contains it.
    Specifying a setter is optional, use None if the setter won't be specified or used.
subset : bool
    If true, indicates that the obj should be a list of objects found via butlerSubset.
inputOnly : bool
    If true, indicates that the obj should not be serialized when performing a butler.put.

Definition at line 111 of file butlerLocation.py.

    def add(self, id, datasetType, setter, getter, subset, inputOnly):
        """Add a description of a component needed to fetch the composite dataset.
 
        Parameters
        ----------
        id : string
            The name of the component in the policy definition.
        datasetType : string
            The name of the datasetType of the component.
        setter : string or None
            The name of the function used to set this component into the python type that contains it.
            Specifying a setter is optional, use None if the setter won't be specified or used.
        getter : string or None
            The name of the function used to get this component from the python type that contains it.
            Specifying a setter is optional, use None if the setter won't be specified or used.
        subset : bool
            If true, indicates that the obj should be a list of objects found via butlerSubset.
        inputOnly : bool
            If true, indicates that the obj should not be serialized when performing a butler.put.
        """
        self.componentInfo[id] = ButlerComposite.ComponentInfo(datasetType=datasetType,
                                                               obj=None,
                                                               setter=setter,
                                                               getter=getter,
                                                               subset=subset,
                                                               inputOnly=inputOnly)
 

getPythonType()

def lsst.daf.persistence.butlerLocation.ButlerComposite.getPythonType

(

self

)

Definition at line 144 of file butlerLocation.py.

    def getPythonType(self):
        return self.python
 
 

getRepository()

def lsst.daf.persistence.butlerLocation.ButlerComposite.getRepository

(

self

)

Definition at line 141 of file butlerLocation.py.

    def getRepository(self):
        return self.repository
 

setRepository()

def lsst.daf.persistence.butlerLocation.ButlerComposite.setRepository	(		self,
			repository
	)

Definition at line 138 of file butlerLocation.py.

    def setRepository(self, repository):
        self.repository = repository
 

Member Data Documentation

assembler

lsst.daf.persistence.butlerLocation.ButlerComposite.assembler

Definition at line 103 of file butlerLocation.py.

componentInfo

lsst.daf.persistence.butlerLocation.ButlerComposite.componentInfo

Definition at line 108 of file butlerLocation.py.

dataId

lsst.daf.persistence.butlerLocation.ButlerComposite.dataId

Definition at line 106 of file butlerLocation.py.

disassembler

lsst.daf.persistence.butlerLocation.ButlerComposite.disassembler

Definition at line 104 of file butlerLocation.py.

mapper

lsst.daf.persistence.butlerLocation.ButlerComposite.mapper

Definition at line 107 of file butlerLocation.py.

python

lsst.daf.persistence.butlerLocation.ButlerComposite.python

Definition at line 105 of file butlerLocation.py.

repository

lsst.daf.persistence.butlerLocation.ButlerComposite.repository

Definition at line 109 of file butlerLocation.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/butlerLocation.py