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

Public Member Functions

def applyOverrides (cls, config)
 
def __init__ (self, *args, **kwargs)
 
def processResult (self, exposure)
 
def scale (self, ccdIdLists, data)
 
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 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 = FlatConfig
 
string calibName = "flat"
 
 RunnerClass = CalibTaskRunner
 
 filterName = None
 
float exposureTime = 1.0
 

Detailed Description

Flat construction

The principal change from the base class involves gathering the background
values from each image and using them to determine the scalings for the final
combination.

Definition at line 1018 of file constructCalibs.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.drivers.constructCalibs.FlatTask.__init__ (   self,
args,
**  kwargs 
)
Constructor

Reimplemented from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1035 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.FlatTask.applyOverrides (   cls,
  config 
)
Overrides for flat construction

Definition at line 1030 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.

Parameters
butlerData butler
calibCombined calib exposure.
dataIdListList of data identifiers for calibration inputs
outputIdData 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.

Parameters
cacheProcess pool cache
structParameters 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)
outputIdData identifier for combined image (exposure part only)
Returns
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.

Parameters
expRefListList of data references at exposure level
calibIdData identifier elements for the calib provided by the user
Returns
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.

Parameters
cameraCamera object
dataIdData identifier for output
calibsDict 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.

Parameters
cacheProcess pool cache
ccdIdData identifier for CCD
outputNameOutput dataset name for butler
Returns
result from 'processResult'

Definition at line 602 of file constructCalibs.py.

◆ processResult()

def lsst.pipe.drivers.constructCalibs.FlatTask.processResult (   self,
  exposure 
)
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 from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1039 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.

Parameters
dataRefData reference
exposureCCD exposure to write
outputNameOutput 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.

Parameters
butlerData butler
calibCombined calib exposure.
dataIdListList of data identifiers for calibration inputs
outputIdData 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.

Parameters
expRefListList of data references at the exposure level
butlerData butler
calibIdIdentifier dict for calib

Definition at line 422 of file constructCalibs.py.

◆ scale()

def lsst.pipe.drivers.constructCalibs.FlatTask.scale (   self,
  ccdIdLists,
  data 
)
Determine the scalings for the final combination

We have a matrix B_ij = C_i E_j, where C_i is the relative scaling
of one CCD to all the others in an exposure, and E_j is the scaling
of the exposure.  We convert everything to logarithms so we can work
with a linear system.  We determine the C_i and E_j from B_ij by iteration,
under the additional constraint that the average CCD scale is unity.

This algorithm comes from Eugene Magnier and Pan-STARRS.

Reimplemented from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1042 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.

Parameters
poolProcess pool
outputIdOutput identifier (exposure part only)
ccdIdListsDict of data identifier lists for each CCD name
scalesDict of structs with scales, for each CCD name
dictof 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.

Parameters
poolProcess pool
ccdIdListsDict of data identifier lists for each CCD name
Returns
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.

Parameters
calibImageThe image whose metadata is to be set
exposureTimeThe exposure time for the image
darkTimeThe 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

Parameters
butlerData butler
exposureCCD exposure to write
dataIdData identifier for output

Definition at line 862 of file constructCalibs.py.

Member Data Documentation

◆ calibName

string lsst.pipe.drivers.constructCalibs.FlatTask.calibName = "flat"
static

Definition at line 1027 of file constructCalibs.py.

◆ ConfigClass

lsst.pipe.drivers.constructCalibs.FlatTask.ConfigClass = FlatConfig
static

Definition at line 1025 of file constructCalibs.py.

◆ exposureTime

float lsst.pipe.drivers.constructCalibs.CalibTask.exposureTime = 1.0
staticinherited

Definition at line 401 of file constructCalibs.py.

◆ filterName

lsst.pipe.drivers.constructCalibs.CalibTask.filterName = None
staticinherited

Definition at line 399 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: