lsst.pipe.base.connectionTypes.Output Class Reference

Inheritance diagram for lsst.pipe.base.connectionTypes.Output:

Public Member Functions
def	__post_init__ (self)
def	makeDatasetType (self, DimensionUniverse universe, Optional[StorageClass] parentStorageClass=None)
def	__get__ (self, inst, klass)

Static Public Attributes
	bool
	str

Detailed Description

Definition at line 259 of file connectionTypes.py.

Member Function Documentation

__get__()

def lsst.pipe.base.connectionTypes.BaseConnection.__get__ (   self,   inst,   klass  )

inherited

Descriptor method

This is a method used to turn a connection into a descriptor.
When a connection is added to a connection class, it is a class level
variable. This method makes accessing this connection, on the
instance of the connection class owning this connection, return a
result specialized for that instance. In the case of connections
this specifically means names specified in a config instance will
be visible instead of the default names for the connection.

Definition at line 63 of file connectionTypes.py.

    def __get__(self, inst, klass):
        """Descriptor method
 
        This is a method used to turn a connection into a descriptor.
        When a connection is added to a connection class, it is a class level
        variable. This method makes accessing this connection, on the
        instance of the connection class owning this connection, return a
        result specialized for that instance. In the case of connections
        this specifically means names specified in a config instance will
        be visible instead of the default names for the connection.
        """
        # If inst is None, this is being accessed by the class and not an
        # instance, return this connection itself
        if inst is None:
            return self
        # If no object cache exists, create one to track the instances this
        # connection has been accessed by
        if not hasattr(inst, '_connectionCache'):
            object.__setattr__(inst, '_connectionCache', {})
        # Look up an existing cached instance
        idSelf = id(self)
        if idSelf in inst._connectionCache:
            return inst._connectionCache[idSelf]
        # Accumulate the parameters that define this connection
        params = {}
        for field in dataclasses.fields(self):
            params[field.name] = getattr(self, field.name)
        # Get the name override defined by the instance of the connection class
        params['name'] = inst._nameOverrides[self.varName]
        # Return a new instance of this connection specialized with the
        # information provided by the connection class instance
        return inst._connectionCache.setdefault(idSelf, self.__class__(**params))
 

__post_init__()

def lsst.pipe.base.connectionTypes.DimensionedConnection.__post_init__ (   self )

inherited

Definition at line 144 of file connectionTypes.py.

    def __post_init__(self):
        if isinstance(self.dimensions, str):
            raise TypeError("Dimensions must be iterable of dimensions, got str,"
                            "possibly omitted trailing comma")
        if not isinstance(self.dimensions, typing.Iterable):
            raise TypeError("Dimensions must be iterable of dimensions")
 

makeDatasetType()

def lsst.pipe.base.connectionTypes.DimensionedConnection.makeDatasetType (   self, DimensionUniverse  universe, Optional[StorageClass]   parentStorageClass = None  )

inherited

Construct a true `DatasetType` instance with normalized dimensions.

Parameters
----------
universe : `lsst.daf.butler.DimensionUniverse`
    Set of all known dimensions to be used to normalize the dimension
    names specified in config.
parentStorageClass : `lsst.daf.butler.StorageClass`, optional
    Parent storage class for component datasets; `None` otherwise.

Returns
-------
datasetType : `DatasetType`
    The `DatasetType` defined by this connection.

Reimplemented from lsst.pipe.base.connectionTypes.BaseConnection.

Definition at line 151 of file connectionTypes.py.

                        parentStorageClass: Optional[StorageClass] = None):
        """Construct a true `DatasetType` instance with normalized dimensions.
 
        Parameters
        ----------
        universe : `lsst.daf.butler.DimensionUniverse`
            Set of all known dimensions to be used to normalize the dimension
            names specified in config.
        parentStorageClass : `lsst.daf.butler.StorageClass`, optional
            Parent storage class for component datasets; `None` otherwise.
 
        Returns
        -------
        datasetType : `DatasetType`
            The `DatasetType` defined by this connection.
        """
        return DatasetType(self.name,
                           universe.extract(self.dimensions),
                           self.storageClass, isCalibration=self.isCalibration,
                           parentStorageClass=parentStorageClass)
 
 
@dataclasses.dataclass(frozen=True)

Member Data Documentation

bool

lsst.pipe.base.connectionTypes.DimensionedConnection.bool

staticinherited

Definition at line 142 of file connectionTypes.py.

str

lsst.pipe.base.connectionTypes.BaseConnection.str

staticinherited

Definition at line 60 of file connectionTypes.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/pipe_base/21.0.0-16-g0fb55c1+b60e2d390c/python/lsst/pipe/base/connectionTypes.py