lsst.cp.pipe.ptc.photodiode Namespace Reference

Classes
class	PhotodiodeData

Functions
def	getBOTphotodiodeData (dataRef, dataPath='/project/shared/BOT/_parent/raw/photodiode_data/', logger=None)

Function Documentation

getBOTphotodiodeData()

def lsst.cp.pipe.ptc.photodiode.getBOTphotodiodeData	(		dataRef,
			dataPath = '/project/shared/BOT/_parent/raw/photodiode_data/',
			logger = None
	)

Get the photodiode data associated with a BOT dataRef.

This is a temporary Gen2-only interface to the photodiode readings from
the SLAC Run3 datasets onwards.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    dataRef of the of the detector/visit to load the data for.

dataPath : `str`, optional
    Path at which to find the corresponding photodiode data files.

logger : `lsst.log.Log`, optional
    Logger for logging warnings.


Returns
-------
photodiodeData : `lsst.cp.pipe.photodiode.PhotodiodeData` or `None`
    The full time-series of the photodiode readings, with methods to
    integrate the photocharge, or None if the expected file isn't found.

Definition at line 30 of file photodiode.py.

                         logger=None):
    """Get the photodiode data associated with a BOT dataRef.
 
    This is a temporary Gen2-only interface to the photodiode readings from
    the SLAC Run3 datasets onwards.
 
    Parameters
    ----------
    dataRef : `lsst.daf.persistence.ButlerDataRef`
        dataRef of the of the detector/visit to load the data for.
 
    dataPath : `str`, optional
        Path at which to find the corresponding photodiode data files.
 
    logger : `lsst.log.Log`, optional
        Logger for logging warnings.
 
 
    Returns
    -------
    photodiodeData : `lsst.cp.pipe.photodiode.PhotodiodeData` or `None`
        The full time-series of the photodiode readings, with methods to
        integrate the photocharge, or None if the expected file isn't found.
 
    """
    if logger is None:
        logger = lsstLog.Log.getDefaultLogger()
 
    def getKeyFromDataId(dataRef, key):
        if key in dataRef.dataId:
            return dataRef.dataId[key]
        else:
            result = dataRef.getButler().queryMetadata('raw', key, dataRef.dataId)
            assert len(result) == 1, f"Failed to find unique value for {key} with {dataRef.dataId}"
            return result[0]
 
    dayObs = getKeyFromDataId(dataRef, 'dayObs')
    seqNum = getKeyFromDataId(dataRef, 'seqNum')
 
    filePattern = 'Photodiode_Readings_%s_%06d.txt'
 
    dayObsAsNumber = dayObs.replace('-', '')
    diodeFilename = os.path.join(dataPath, filePattern % (dayObsAsNumber, seqNum))
 
    if not os.path.exists(diodeFilename):
        logger.warn(f"Failed to find the photodiode data at {diodeFilename}")
        return None
 
    try:
        photodiodeData = PhotodiodeData(diodeFilename)
        return photodiodeData
    except Exception:
        logger.warn(f"Photodiode data found at {diodeFilename} but failed to load.")
        return None