lsst.coadd.utils g169eefeba3+d41cea541d
Functions
lsst.coadd.utils.getGen3CoaddExposureId Namespace Reference

Functions

def getGen3CoaddExposureId (dataRef, coaddName="deep", includeBand=True, log=None)
 

Function Documentation

◆ getGen3CoaddExposureId()

def lsst.coadd.utils.getGen3CoaddExposureId.getGen3CoaddExposureId (   dataRef,
  coaddName = "deep",
  includeBand = True,
  log = None 
)
Return the coadd expId consistent with Gen3 implementation.

This is a temporary interface intended to aid with the migration from
Gen2 to Gen3 middleware.  It will be removed with the Gen2 middleware.

Parameters
----------
dataRef : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
    The data reference for the patch.
coaddName : `str`, optional
    The prefix for the coadd name, e.g. "deep" for "deepCoadd"
includeBand : `bool`, optional
    Whether to include band as part of the dataId packing.
log : `lsst.log.Log` or `None`, optional
    Logger object for logging messages.

Returns
-------
expId : `int`
    The integer id associated with `patchRef` that mimics that of Gen3.

Definition at line 27 of file getGen3CoaddExposureId.py.