lsst.pipe.drivers  21.0.0-2-ga63a54e+1ed2fee5f8
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.drivers.constructCalibs.BiasTask Class Reference
Inheritance diagram for lsst.pipe.drivers.constructCalibs.BiasTask:
lsst.pipe.drivers.constructCalibs.CalibTask lsst::ctrl::pool::parallel::BatchPoolTask lsst::ctrl::pool::parallel::BatchCmdLineTask

Public Member Functions

def applyOverrides (cls, config)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 
def runDataRef (self, expRefList, butler, calibId)
 Construct a calib from a list of exposure references. More...
 
def getOutputId (self, expRefList, calibId)
 Generate the data identifier for the output calib. More...
 
def getMjd (self, butler, dataId, timescale=dafBase.DateTime.UTC)
 
def getFilter (self, butler, dataId)
 
def addMissingKeys (self, dataId, butler, missingKeys=None, calibName=None)
 
def updateMetadata (self, calibImage, exposureTime, darkTime=None, **kwargs)
 Update the metadata from the VisitInfo. More...
 
def scatterProcess (self, pool, ccdIdLists)
 Scatter the processing among the nodes. More...
 
def process (self, cache, ccdId, outputName="postISRCCD", **kwargs)
 Process a CCD, specified by a data identifier. More...
 
def processSingle (self, dataRef)
 
def processWrite (self, dataRef, exposure, outputName="postISRCCD")
 Write the processed CCD. More...
 
def processResult (self, exposure)
 
def scale (self, ccdIdLists, data)
 Determine scaling across CCDs and exposures. More...
 
def scatterCombine (self, pool, outputId, ccdIdLists, scales)
 Scatter the combination of exposures across multiple nodes. More...
 
def getFullyQualifiedOutputId (self, ccdName, butler, outputId)
 
def combine (self, cache, struct, outputId)
 Combine multiple exposures of a particular CCD and write the output. More...
 
def calculateOutputHeaderFromRaws (self, butler, calib, dataIdList, outputId)
 Calculate the output header from the raw headers. More...
 
def recordCalibInputs (self, butler, calib, dataIdList, outputId)
 Record metadata including the inputs and creation details. More...
 
def interpolateNans (self, image)
 
def write (self, butler, exposure, dataId)
 Write the final combined calib. More...
 
def makeCameraImage (self, camera, dataId, calibs)
 Create and write an image of the entire camera. More...
 
def checkCcdIdLists (self, ccdIdLists)
 
def parseAndRun (cls, *args, **kwargs)
 
def parseAndSubmit (cls, args=None, **kwargs)
 
def batchCommand (cls, args)
 
def logOperation (self, operation, catch=False, trace=True)
 

Static Public Attributes

 ConfigClass = BiasConfig
 
string calibName = "bias"
 
string filterName = "NONE"
 
float exposureTime = 0.0
 
 RunnerClass = CalibTaskRunner
 

Detailed Description

Bias construction

Definition at line 922 of file constructCalibs.py.

Member Function Documentation

◆ addMissingKeys()

def lsst.pipe.drivers.constructCalibs.CalibTask.addMissingKeys (   self,
  dataId,
  butler,
  missingKeys = None,
  calibName = None 
)
inherited

Definition at line 549 of file constructCalibs.py.

◆ applyOverrides()

def lsst.pipe.drivers.constructCalibs.BiasTask.applyOverrides (   cls,
  config 
)
Overrides to apply for bias construction

Definition at line 931 of file constructCalibs.py.

◆ batchWallTime()

def lsst.pipe.drivers.constructCalibs.CalibTask.batchWallTime (   cls,
  time,
  parsedCmd,
  numCores 
)
inherited

Definition at line 410 of file constructCalibs.py.

◆ calculateOutputHeaderFromRaws()

def lsst.pipe.drivers.constructCalibs.CalibTask.calculateOutputHeaderFromRaws (   self,
  butler,
  calib,
  dataIdList,
  outputId 
)
inherited

Calculate the output header from the raw headers.

    This metadata will go into the output FITS header. It will include all
    headers that are identical in all inputs.

    @param butler  Data butler
    @param calib  Combined calib exposure.
    @param dataIdList  List of data identifiers for calibration inputs
    @param outputId  Data identifier for output

Definition at line 766 of file constructCalibs.py.

◆ checkCcdIdLists()

def lsst.pipe.drivers.constructCalibs.CalibTask.checkCcdIdLists (   self,
  ccdIdLists 
)
inherited
Check that the list of CCD dataIds is consistent

@param ccdIdLists  Dict of data identifier lists for each CCD name
@return Number of exposures, number of CCDs

Definition at line 886 of file constructCalibs.py.

◆ combine()

def lsst.pipe.drivers.constructCalibs.CalibTask.combine (   self,
  cache,
  struct,
  outputId 
)
inherited

Combine multiple exposures of a particular CCD and write the output.

    Only the slave nodes execute this method.

    @param cache  Process pool cache
    @param struct  Parameters for the combination, which has the following components:
        * ccdName     Name tuple for CCD
        * ccdIdList   List of data identifiers for combination
        * scales      Scales to apply (expScales are scalings for each exposure,
                           ccdScale is final scale for combined image)
    @param outputId    Data identifier for combined image (exposure part only)
    @return binned calib image

Reimplemented in lsst.pipe.drivers.constructCalibs.SkyTask.

Definition at line 726 of file constructCalibs.py.

◆ getFilter()

def lsst.pipe.drivers.constructCalibs.CalibTask.getFilter (   self,
  butler,
  dataId 
)
inherited
Determine the filter from a data identifier

Definition at line 544 of file constructCalibs.py.

◆ getFullyQualifiedOutputId()

def lsst.pipe.drivers.constructCalibs.CalibTask.getFullyQualifiedOutputId (   self,
  ccdName,
  butler,
  outputId 
)
inherited
Get fully-qualified output data identifier

We may need to look up keys that aren't in the output dataId.

@param ccdName  Name tuple for CCD
@param butler  Data butler
@param outputId  Data identifier for combined image (exposure part only)
@return fully-qualified output dataId

Definition at line 710 of file constructCalibs.py.

◆ getMjd()

def lsst.pipe.drivers.constructCalibs.CalibTask.getMjd (   self,
  butler,
  dataId,
  timescale = dafBase.DateTime.UTC 
)
inherited
Determine the Modified Julian Date (MJD; in TAI) from a data identifier

Definition at line 531 of file constructCalibs.py.

◆ getOutputId()

def lsst.pipe.drivers.constructCalibs.CalibTask.getOutputId (   self,
  expRefList,
  calibId 
)
inherited

Generate the data identifier for the output calib.

    The mean date and the common filter are included, using keywords
    from the configuration.  The CCD-specific part is not included
    in the data identifier.

    @param expRefList  List of data references at exposure level
    @param calibId  Data identifier elements for the calib provided by the user
    @return data identifier

Definition at line 496 of file constructCalibs.py.

◆ interpolateNans()

def lsst.pipe.drivers.constructCalibs.CalibTask.interpolateNans (   self,
  image 
)
inherited
Interpolate over NANs in the combined image

NANs can result from masked areas on the CCD.  We don't want them getting
into our science images, so we replace them with the median of the image.

Definition at line 847 of file constructCalibs.py.

◆ makeCameraImage()

def lsst.pipe.drivers.constructCalibs.CalibTask.makeCameraImage (   self,
  camera,
  dataId,
  calibs 
)
inherited

Create and write an image of the entire camera.

    This is useful for judging the quality or getting an overview of
    the features of the calib.

    @param camera  Camera object
    @param dataId  Data identifier for output
    @param calibs  Dict mapping CCD detector ID to calib image

Definition at line 874 of file constructCalibs.py.

◆ process()

def lsst.pipe.drivers.constructCalibs.CalibTask.process (   self,
  cache,
  ccdId,
  outputName = "postISRCCD",
**  kwargs 
)
inherited

Process a CCD, specified by a data identifier.

    After processing, optionally returns a result (produced by
    the 'processResult' method) calculated from the processed
    exposure.  These results will be gathered by the master node,
    and is a means for coordinated scaling of all CCDs for flats,
    etc.

    Only slave nodes execute this method.

    @param cache  Process pool cache
    @param ccdId  Data identifier for CCD
    @param outputName  Output dataset name for butler
    @return result from 'processResult'

Definition at line 602 of file constructCalibs.py.

◆ processResult()

def lsst.pipe.drivers.constructCalibs.CalibTask.processResult (   self,
  exposure 
)
inherited
Extract processing results from a processed exposure

This method generates what is gathered by the master node.
This can be a background measurement or similar for scaling
flat-fields.  It must be picklable!

Only slave nodes execute this method.

Reimplemented in lsst.pipe.drivers.constructCalibs.FlatTask.

Definition at line 660 of file constructCalibs.py.

◆ processSingle()

def lsst.pipe.drivers.constructCalibs.CalibTask.processSingle (   self,
  dataRef 
)
inherited
Process a single CCD, specified by a data reference

Generally, this simply means doing ISR.

Only slave nodes execute this method.

Reimplemented in lsst.pipe.drivers.constructCalibs.FringeTask, and lsst.pipe.drivers.constructCalibs.DarkTask.

Definition at line 637 of file constructCalibs.py.

◆ processWrite()

def lsst.pipe.drivers.constructCalibs.CalibTask.processWrite (   self,
  dataRef,
  exposure,
  outputName = "postISRCCD" 
)
inherited

Write the processed CCD.

    We need to write these out because we can't hold them all in
    memory at once.

    Only slave nodes execute this method.

    @param dataRef     Data reference
    @param exposure    CCD exposure to write
    @param outputName  Output dataset name for butler.

Definition at line 646 of file constructCalibs.py.

◆ recordCalibInputs()

def lsst.pipe.drivers.constructCalibs.CalibTask.recordCalibInputs (   self,
  butler,
  calib,
  dataIdList,
  outputId 
)
inherited

Record metadata including the inputs and creation details.

    This metadata will go into the FITS header.

    @param butler  Data butler
    @param calib  Combined calib exposure.
    @param dataIdList  List of data identifiers for calibration inputs
    @param outputId  Data identifier for output

Definition at line 819 of file constructCalibs.py.

◆ runDataRef()

def lsst.pipe.drivers.constructCalibs.CalibTask.runDataRef (   self,
  expRefList,
  butler,
  calibId 
)
inherited

Construct a calib from a list of exposure references.

    This is the entry point, called by the TaskRunner.__call__

    Only the master node executes this method.

    @param expRefList  List of data references at the exposure level
    @param butler      Data butler
    @param calibId   Identifier dict for calib

Definition at line 422 of file constructCalibs.py.

◆ scale()

def lsst.pipe.drivers.constructCalibs.CalibTask.scale (   self,
  ccdIdLists,
  data 
)
inherited

Determine scaling across CCDs and exposures.

    This is necessary mainly for flats, so as to determine a
    consistent scaling across the entire focal plane.  This
    implementation is simply a placeholder.

    Only the master node executes this method.

    @param ccdIdLists  Dict of data identifier lists for each CCD tuple
    @param data        Dict of lists of returned data for each CCD tuple
    @return dict of Struct(ccdScale: scaling for CCD,
                           expScales: scaling for each exposure
                           ) for each CCD tuple

Reimplemented in lsst.pipe.drivers.constructCalibs.FlatTask.

Definition at line 671 of file constructCalibs.py.

◆ scatterCombine()

def lsst.pipe.drivers.constructCalibs.CalibTask.scatterCombine (   self,
  pool,
  outputId,
  ccdIdLists,
  scales 
)
inherited

Scatter the combination of exposures across multiple nodes.

    In this case, we can only scatter across as many nodes as
    there are CCDs.

    Only the master node executes this method.

    @param pool  Process pool
    @param outputId  Output identifier (exposure part only)
    @param ccdIdLists  Dict of data identifier lists for each CCD name
    @param scales  Dict of structs with scales, for each CCD name
    @param dict of binned images

Definition at line 690 of file constructCalibs.py.

◆ scatterProcess()

def lsst.pipe.drivers.constructCalibs.CalibTask.scatterProcess (   self,
  pool,
  ccdIdLists 
)
inherited

Scatter the processing among the nodes.

    We scatter each CCD independently (exposures aren't grouped together),
    to make full use of all available processors. This necessitates piecing
    everything back together in the same format as ccdIdLists afterwards.

    Only the master node executes this method.

    @param pool  Process pool
    @param ccdIdLists  Dict of data identifier lists for each CCD name
    @return Dict of lists of returned data for each CCD name

Reimplemented in lsst.pipe.drivers.constructCalibs.SkyTask.

Definition at line 586 of file constructCalibs.py.

◆ updateMetadata()

def lsst.pipe.drivers.constructCalibs.CalibTask.updateMetadata (   self,
  calibImage,
  exposureTime,
  darkTime = None,
**  kwargs 
)
inherited

Update the metadata from the VisitInfo.

    @param calibImage       The image whose metadata is to be set
    @param exposureTime     The exposure time for the image
    @param darkTime         The time since the last read (default: exposureTime)

Definition at line 570 of file constructCalibs.py.

◆ write()

def lsst.pipe.drivers.constructCalibs.CalibTask.write (   self,
  butler,
  exposure,
  dataId 
)
inherited

Write the final combined calib.

    Only the slave nodes execute this method

    @param butler  Data butler
    @param exposure  CCD exposure to write
    @param dataId  Data identifier for output

Definition at line 862 of file constructCalibs.py.

Member Data Documentation

◆ calibName

string lsst.pipe.drivers.constructCalibs.BiasTask.calibName = "bias"
static

Definition at line 926 of file constructCalibs.py.

◆ ConfigClass

lsst.pipe.drivers.constructCalibs.BiasTask.ConfigClass = BiasConfig
static

Definition at line 924 of file constructCalibs.py.

◆ exposureTime

float lsst.pipe.drivers.constructCalibs.BiasTask.exposureTime = 0.0
static

Definition at line 928 of file constructCalibs.py.

◆ filterName

string lsst.pipe.drivers.constructCalibs.BiasTask.filterName = "NONE"
static

Definition at line 927 of file constructCalibs.py.

◆ RunnerClass

lsst.pipe.drivers.constructCalibs.CalibTask.RunnerClass = CalibTaskRunner
staticinherited

Definition at line 398 of file constructCalibs.py.


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