Inheritance diagram for lsst.pipe.drivers.constructCalibs.BiasTask:

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 926 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 553 of file constructCalibs.py.

◆ applyOverrides()

def lsst.pipe.drivers.constructCalibs.BiasTask.applyOverrides	(	cls,
		config
	)

Overrides to apply for bias construction

Definition at line 935 of file constructCalibs.py.

◆ batchWallTime()

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

inherited

Definition at line 414 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

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

Definition at line 770 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 890 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

cache	Process pool cache
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)
outputId	Data identifier for combined image (exposure part only)

Returns: binned calib image

Definition at line 730 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 548 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 714 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 535 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

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

Returns: data identifier

Definition at line 500 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 851 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

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

Definition at line 878 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

cache	Process pool cache
ccdId	Data identifier for CCD
outputName	Output dataset name for butler

Returns: result from 'processResult'

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

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

Definition at line 641 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

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

Definition at line 650 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

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

Definition at line 823 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

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

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

Parameters

ccdIdLists	Dict of data identifier lists for each CCD tuple
data	Dict of lists of returned data for each CCD tuple

Returns: dict of Struct(ccdScale: scaling for CCD, expScales: scaling for each exposure ) for each CCD tuple

Definition at line 675 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

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

Definition at line 694 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

pool	Process pool
ccdIdLists	Dict of data identifier lists for each CCD name

Returns: Dict of lists of returned data for each CCD name

Definition at line 590 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

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

Definition at line 574 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

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

Definition at line 866 of file constructCalibs.py.

Member Data Documentation

◆ calibName

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

static

Definition at line 930 of file constructCalibs.py.

◆ ConfigClass

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

static

Definition at line 928 of file constructCalibs.py.

◆ exposureTime

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

static

Definition at line 932 of file constructCalibs.py.

◆ filterName

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

static

Definition at line 931 of file constructCalibs.py.

◆ RunnerClass

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

staticinherited

Definition at line 402 of file constructCalibs.py.

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

python/lsst/pipe/drivers/constructCalibs.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ addMissingKeys()

◆ applyOverrides()

◆ batchWallTime()

◆ calculateOutputHeaderFromRaws()

◆ checkCcdIdLists()

◆ combine()

◆ getFilter()

◆ getFullyQualifiedOutputId()

◆ getMjd()

◆ getOutputId()

◆ interpolateNans()

◆ makeCameraImage()

◆ process()

◆ processResult()

◆ processSingle()

◆ processWrite()

◆ recordCalibInputs()

◆ runDataRef()

◆ scale()

◆ scatterCombine()

◆ scatterProcess()

◆ updateMetadata()

◆ write()

Member Data Documentation

◆ calibName

◆ ConfigClass

◆ exposureTime

◆ filterName

◆ RunnerClass