lsst.cp.pipe  20.0.0-8-gea2affd+8a26795657
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.cp.pipe.cpCertify.BlessCalibration Class Reference
Inheritance diagram for lsst.cp.pipe.cpCertify.BlessCalibration:

Public Member Functions

def __init__ (self, *butler, inputCollection, outputCollection, **kwargs)
 
def findInputs (self, datasetTypeName, inputDatasetTypeName=None)
 
def registerCalibrations (self, datasetTypeName)
 
def convertStorageClass (self, data, datasetTypeName)
 
def registerDatasetType (self, datasetTypeName, dataId)
 
def addCalibrationLabel (self, name=None, instrument=None, beginDate="1970-01-01", endDate="2038-12-31")
 

Public Attributes

 butler
 
 registry
 
 inputCollection
 
 outputCollection
 
 calibrationLabel
 
 instrument
 
 inputValues
 
 newDataIds
 
 objects
 

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
----------
butler : `lsst.daf.butler.Butler`
    Butler repository to use.
inputCollection : `str`
    Data collection to pull calibrations from.
outputCollection : `str`
    Data collection to store final calibrations.
**kwargs :
    Additional arguments forwarded to `lsst.pipe.base.Task.__init__`.

Definition at line 29 of file cpCertify.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.cp.pipe.cpCertify.BlessCalibration.__init__ (   self,
butler,
  inputCollection,
  outputCollection,
**  kwargs 
)

Definition at line 49 of file cpCertify.py.

Member Function Documentation

◆ addCalibrationLabel()

def lsst.cp.pipe.cpCertify.BlessCalibration.addCalibrationLabel (   self,
  name = None,
  instrument = None,
  beginDate = "1970-01-01",
  endDate = "2038-12-31" 
)
Method to allow tasks to add calibration_label for master calibrations.

Parameters
----------
name : `str`, optional
    A unique string for the calibration_label key.
instrument : `str`, optional
    Instrument this calibration is for.
beginDate : `str`, optional
    An ISO 8601 date string for the beginning of the valid date range.
endDate : `str`, optional
    An ISO 8601 date string for the end of the valid date range.

Raises
------
RuntimeError :
    Raised if the instrument or calibration_label name are not set.

Definition at line 171 of file cpCertify.py.

◆ convertStorageClass()

def lsst.cp.pipe.cpCertify.BlessCalibration.convertStorageClass (   self,
  data,
  datasetTypeName 
)
Switch from an exposure to the image type expected.

Parameters
----------
data : `lsst.afw.image.Exposure`
    Input exposure data to convert.
datasetTypeName : `str`
    Dataset type that will be registered

Returns
-------
data : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage`
    Converted image data to register.

Definition at line 125 of file cpCertify.py.

◆ findInputs()

def lsst.cp.pipe.cpCertify.BlessCalibration.findInputs (   self,
  datasetTypeName,
  inputDatasetTypeName = None 
)
Find and prepare inputs for blessing.

Parameters
----------
datasetTypeName : `str`
    Dataset that will be blessed.
inputDatasetTypeName : `str`, optional
    Dataset name for the input datasets.  Default to
    datasetTypeName + "Proposal".

Raises
------
RuntimeError
    Raised if no input datasets found or if the calibration
    label exists and is not empty.

Definition at line 60 of file cpCertify.py.

◆ registerCalibrations()

def lsst.cp.pipe.cpCertify.BlessCalibration.registerCalibrations (   self,
  datasetTypeName 
)
Add blessed inputs to the output collection.

Parameters
----------
datasetTypeName : `str`
    Dataset type these calibrations will be registered for.

Definition at line 99 of file cpCertify.py.

◆ registerDatasetType()

def lsst.cp.pipe.cpCertify.BlessCalibration.registerDatasetType (   self,
  datasetTypeName,
  dataId 
)
Ensure registry can handle this dataset type.

Parameters
----------
datasetTypeName : `str`
    Name of the dataset that will be registered.
dataId : `lsst.daf.butler.dataId`
    Data ID providing the list of dimensions for the new
    datasetType.

Definition at line 147 of file cpCertify.py.

Member Data Documentation

◆ butler

lsst.cp.pipe.cpCertify.BlessCalibration.butler

Definition at line 51 of file cpCertify.py.

◆ calibrationLabel

lsst.cp.pipe.cpCertify.BlessCalibration.calibrationLabel

Definition at line 56 of file cpCertify.py.

◆ ConfigClass

lsst.cp.pipe.cpCertify.BlessCalibration.ConfigClass = pexConfig.Config
static

Definition at line 47 of file cpCertify.py.

◆ inputCollection

lsst.cp.pipe.cpCertify.BlessCalibration.inputCollection

Definition at line 53 of file cpCertify.py.

◆ inputValues

lsst.cp.pipe.cpCertify.BlessCalibration.inputValues

Definition at line 80 of file cpCertify.py.

◆ instrument

lsst.cp.pipe.cpCertify.BlessCalibration.instrument

Definition at line 57 of file cpCertify.py.

◆ newDataIds

lsst.cp.pipe.cpCertify.BlessCalibration.newDataIds

Definition at line 95 of file cpCertify.py.

◆ objects

lsst.cp.pipe.cpCertify.BlessCalibration.objects

Definition at line 97 of file cpCertify.py.

◆ outputCollection

lsst.cp.pipe.cpCertify.BlessCalibration.outputCollection

Definition at line 54 of file cpCertify.py.

◆ registry

lsst.cp.pipe.cpCertify.BlessCalibration.registry

Definition at line 52 of file cpCertify.py.


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