Inheritance diagram for lsst.cp.pipe.cpCertify.CertifyCalibration:

Public Member Functions
def	__init__ (self, registry, inputCollection, outputCollection, lastRunOnly=True, *kwargs)

def	run (self, datasetTypeName, timespan)

Public Attributes
	registry

	inputCollection

	outputCollection

Static Public Attributes
	ConfigClass = pexConfig.Config

Detailed Description

Create a way to bless existing calibration products.

The inputs are assumed to have been constructed via cp_pipe, and
already exist in the butler.

Parameters
----------
registry : `lsst.daf.butler.Registry`
    Registry pointing at the butler repository to operate on.
inputCollection : `str`
    Data collection to pull calibrations from.  Usually an existing
    `~CollectionType.RUN` or `~CollectionType.CHAINED` collection, and may
    _not_ be a `~CollectionType.CALIBRATION` collection or a nonexistent
    collection.
outputCollection : `str`
    Data collection to store final calibrations.  If it already exists, it
    must be a `~CollectionType.CALIBRATION` collection.  If not, a new
    `~CollectionType.CALIBRATION` collection with this name will be
    registered.
lastRunOnly : `bool`, optional
    If `True` (default) and ``inputCollection`` is a
    `~CollectionType.CHAINED` collection, only search its first child
    collection (which usually corresponds to the last processing run),
    instead of all child collections in the chain.  This behavior ensures
    that datasets in a collection used as input to that processing run
    are never included in the certification.
**kwargs :
    Additional arguments forwarded to `lsst.pipe.base.Task.__init__`.

Definition at line 27 of file cpCertify.py.

Constructor & Destructor Documentation

◆ init()

def lsst.cp.pipe.cpCertify.CertifyCalibration.__init__	(		self,
		*	registry,
			inputCollection,
			outputCollection,
			lastRunOnly = `True`,
		**	kwargs
	)

Definition at line 60 of file cpCertify.py.

     def __init__(self, *, registry, inputCollection, outputCollection, lastRunOnly=True, **kwargs):
         super().__init__(**kwargs)
         self.registry = registry
         if lastRunOnly:
             try:
                 inputCollection, _ = next(iter(self.registry.getCollectionChain(inputCollection)))
             except TypeError:
                 # Not a CHAINED collection; do nothing.
                 pass
         self.inputCollection = inputCollection
         self.outputCollection = outputCollection
  

Member Function Documentation

◆ run()

def lsst.cp.pipe.cpCertify.CertifyCalibration.run	(	self,
		datasetTypeName,
		timespan
	)

Certify all of the datasets of the given type in the input
collection.

Parameters
----------
datasetTypeName : `str`
    Name of the dataset type to certify.
timespan : `lsst.daf.butler.Timespan`
    Timespan for the validity range.

Definition at line 72 of file cpCertify.py.

     def run(self, datasetTypeName, timespan):
         """Certify all of the datasets of the given type in the input
         collection.
  
         Parameters
         ----------
         datasetTypeName : `str`
             Name of the dataset type to certify.
         timespan : `lsst.daf.butler.Timespan`
             Timespan for the validity range.
         """
         refs = set(self.registry.queryDatasets(datasetTypeName, collections=[self.inputCollection]))
         if not refs:
             raise RuntimeError(f"No inputs found for dataset {datasetTypeName} in {self.inputCollection}.")
         self.registry.registerCollection(self.outputCollection, type=CollectionType.CALIBRATION)
         self.registry.certify(self.outputCollection, refs, timespan)

Member Data Documentation

◆ ConfigClass

lsst.cp.pipe.cpCertify.CertifyCalibration.ConfigClass = pexConfig.Config

static

Definition at line 58 of file cpCertify.py.

◆ inputCollection

lsst.cp.pipe.cpCertify.CertifyCalibration.inputCollection

Definition at line 69 of file cpCertify.py.

◆ outputCollection

lsst.cp.pipe.cpCertify.CertifyCalibration.outputCollection

Definition at line 70 of file cpCertify.py.

◆ registry

lsst.cp.pipe.cpCertify.CertifyCalibration.registry

Definition at line 62 of file cpCertify.py.

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

/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/cp_pipe/20.0.0-22-gc512666+9eba1c4719/python/lsst/cp/pipe/cpCertify.py

Public Member Functions

Public Attributes

Static Public Attributes