PhotonTransferCurveSolveTask¶

class lsst.cp.pipe.PhotonTransferCurveSolveTask(*, config: Optional[PipelineTaskConfig] = None, log: Optional[Union[logging.Logger, LsstLogAdapter]] = None, initInputs: Optional[Dict[str, Any]] = None, **kwargs)¶

Bases: lsst.pipe.base.PipelineTask, lsst.pipe.base.CmdLineTask

Task to fit the PTC from flat covariances.

The first task of the PTC measurement pipeline, PhotonTransferCurveMeasureTask (and assumed to have been run before this task), produced a list of PhotonTransferCurveDataset objects. Each dataset contains the mean signal and covariances of the difference image of the flat-field images taken at the same exposure time. The list also contains dummy datasets (with no measurements), whose purpose is to have the input and output dimensions of PhotonTransferCurveMeasureTask match.

This task, PhotonTransferCurveSolveTask, assembles the list of individual PTC datasets produced by PhotonTransferCurveMeasureTask into one single final PTC dataset, discarding the dummy datset as appropiate. The task fits the measured (co)variances to one of three models: a polynomial model of a given order, or the models described in equations 16 and 20 of Astier+19. These options are referred to as POLYNOMIAL, EXPAPPROXIMATION, and FULLCOVARIANCE in the configuration options of the task, respectively). Parameters of interest such as the gain and noise are derived from the fits. The FULLCOVARIANCE model is fitted to the full covariance data (as oppossed to the other two models, which are fit to the variance vs mean measurements only).

Astier+19: “The Shape of the Photon Transfer Curve of CCD sensors”, arXiv:1905.08677

Attributes Summary

canMultiprocess

Methods Summary

`applyOverrides`(config)	A hook to allow a task to change the values of its config after the camera-specific overrides are loaded but before any command-line overrides are applied.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`evalCovModel`(mu, aMatrix, cMatrix, …[, …])	Computes full covariances model (Eq.
`fillBadAmp`(dataset, ptcFitType, ampName)	Fill the dataset with NaNs if there are not enough good points.
`fitDataFullCovariance`(dataset)	Fit measured flat covariances to the full model in Astier+19 (Eq.
`fitMeasurementsToModel`(dataset)	Fit the measured covariances vs mean signal to a polynomial or one of the models in Astier+19 (Eq.
`fitPtc`(dataset)	Fit the photon transfer curve to a polynomial or to the Astier+19 approximation (Eq.
`funcFullCovarianceModel`(params, x)	Model to fit covariances from flat fields; Equation 20 of Astier+19.
`funcFullCovarianceModelNoB`(params, x)	Model to fit covariances from flat fields; Equation 20 of Astier+19, with b=0 (equivalent to c=a*b=0 in this code).
`getAllSchemaCatalogs`()	Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getName`()	Get the name of the task.
`getResourceConfig`()	Return resource configuration for this task.
`getSchemaCatalogs`()	Get the schemas generated by this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`initialFitFullCovariance`(mu, cov, sqrtW)	Performs a crude parabolic fit of the data in order to start the full fit close to the solution, setting b=0 (c=0) in Eq.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`parseAndRun`([args, config, log, doReturnResults])	Parse an argument list and run the command.
`run`(inputCovariances[, camera, inputExpList])	Fit measured covariances to different models.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Ensure that the input and output dimensions are passed along.
`timer`(name, logLevel)	Context manager to log performance data for an arbitrary block of code.
`writeConfig`(butler[, clobber, doBackup])	Write the configuration used for processing the data, or check that an existing one is equal to the new one if present.
`writeMetadata`(dataRef)	Write the metadata produced from processing the data.
`writePackageVersions`(butler[, clobber, …])	Compare and write package versions.
`writeSchemas`(butler[, clobber, doBackup])	Write the schemas returned by `lsst.pipe.base.Task.getAllSchemaCatalogs`.

Attributes Documentation

canMultiprocess = True¶

Methods Documentation

classmethod applyOverrides(config)¶

A hook to allow a task to change the values of its config after the camera-specific overrides are loaded but before any command-line overrides are applied.

Parameters:	config : instance of task’s `ConfigClass` Task configuration.

Notes

This is necessary in some cases because the camera-specific overrides may retarget subtasks, wiping out changes made in ConfigClass.setDefaults. See LSST Trac ticket #2282 for more discussion.

Warning

This is called by CmdLineTask.parseAndRun; other ways of constructing a config will not apply these overrides.

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

evalCovModel(mu, aMatrix, cMatrix, noiseMatrix, gain, setBtoZero=False)¶

Computes full covariances model (Eq. 20 of Astier+19).

Parameters:

mu : numpy.array, (N,): List of mean signals.
aMatrix : numpy.array, (M, M): “a” parameter per flux in Eq. 20 of Astier+19.
cMatrix : numpy.array, (M, M): “c”=”ab” parameter per flux in Eq. 20 of Astier+19.
noiseMatrix : numpy.array, (M, M): “noise” parameter per flux in Eq. 20 of Astier+19.
gain : float: Amplifier gain (e/ADU)
setBtoZero=False : bool, optional: Set “b” parameter in full model (see Astier+19) to zero.

Returns:

covModel : numpy.array, (N, M, M): Covariances model.

Notes

By default, computes the covModel for the mu’s stored(self.mu). Returns cov[Nmu, M, M]. The variance for the PTC is cov[:, 0, 0]. mu and cov are in ADUs and ADUs squared. To use electrons for both, the gain should be set to 1. This routine implements the model in Astier+19 (1905.08677). The parameters of the full model for C_ij(mu) (“C_ij” and “mu” in ADU^2 and ADU, respectively) in Astier+19 (Eq. 20) are: “a” coefficients (M by M matrix), units: 1/e “b” coefficients (M by M matrix), units: 1/e noise matrix (M by M matrix), units: e^2 gain, units: e/ADU “b” appears in Eq. 20 only through the “ab” combination, which is defined in this code as “c=ab”.

fillBadAmp(dataset, ptcFitType, ampName)¶

Fill the dataset with NaNs if there are not enough good points.

Parameters:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` The dataset containing the means, variances and exposure times. ptcFitType : {‘POLYNOMIAL’, ‘EXPAPPROXIMATION’} Fit a ‘POLYNOMIAL’ (degree: ‘polynomialFitDegree’) or ‘EXPAPPROXIMATION’ (Eq. 16 of Astier+19) to the PTC. ampName : `str` Amplifier name.

fitDataFullCovariance(dataset)¶

Fit measured flat covariances to the full model in Astier+19 (Eq. 20).

Parameters:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` The dataset containing information such as the means, (co)variances, and exposure times.
Returns:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` This is the same dataset as the input parameter, however, it has been modified to include information such as the fit vectors and the fit parameters. See the class `PhotonTransferCurveDatase`.

Notes

The parameters of the full model for C_ij(mu) (“C_ij” and “mu” in ADU^2 and ADU, respectively) in Astier+19 (Eq. 20) are:

“a” coefficients (r by r matrix), units: 1/e “b” coefficients (r by r matrix), units: 1/e noise matrix (r by r matrix), units: e^2 gain, units: e/ADU

“b” appears in Eq. 20 only through the “ab” combination, which is defined in this code as “c=ab”.

Total number of parameters: #entries(a) + #entries(c) + #entries(noise) + 1. This is equivalent to r^2 + r^2 + r^2 + 1, where “r” is the maximum lag considered for the covariances calculation, and the extra “1” is the gain. If “b” is 0, then “c” is 0, and len(pInit) will have r^2 fewer entries.

fitMeasurementsToModel(dataset)¶

Fit the measured covariances vs mean signal to a polynomial or one of the models in Astier+19 (Eq. 16 or Eq.20).

Parameters:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` The dataset containing information such as the means, (co)variances, and exposure times.
Returns:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` This is the same dataset as the input parameter, however, it has been modified to include information such as the fit vectors and the fit parameters. See the class `PhotonTransferCurveDatase`.

fitPtc(dataset)¶

Fit the photon transfer curve to a polynomial or to the Astier+19 approximation (Eq. 16).

Fit the photon transfer curve with either a polynomial of the order specified in the task config, or using the exponential approximation in Astier+19 (Eq. 16).

Sigma clipping is performed iteratively for the fit, as well as an initial clipping of data points that are more than config.initialNonLinearityExclusionThreshold away from lying on a straight line. This other step is necessary because the photon transfer curve turns over catastrophically at very high flux (because saturation drops the variance to ~0) and these far outliers cause the initial fit to fail, meaning the sigma cannot be calculated to perform the sigma-clipping.

Parameters:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` The dataset containing the means, variances and exposure times.
Returns:	dataset : `lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset` This is the same dataset as the input parameter, however, it has been modified to include information such as the fit vectors and the fit parameters. See the class `PhotonTransferCurveDatase`.
Raises:	RuntimeError: Raises if dataset.ptcFitType is None or empty.

funcFullCovarianceModel(params, x)¶

Model to fit covariances from flat fields; Equation 20 of Astier+19.

Parameters:	params : `list` Parameters of the model: aMatrix, CMatrix, noiseMatrix, gain (e/ADU). x : `numpy.array`, (N,) Signal `mu` (ADU)
Returns:	y : `numpy.array`, (N,) Covariance matrix.

funcFullCovarianceModelNoB(params, x)¶

Model to fit covariances from flat fields; Equation 20 of Astier+19, with b=0 (equivalent to c=a*b=0 in this code).

Parameters:	params : `list` Parameters of the model: aMatrix, CMatrix, noiseMatrix, gain (e/ADU). x : `numpy.array`, (N,) Signal mu (ADU)
Returns:	y : `numpy.array`, (N,) Covariance matrix.

getAllSchemaCatalogs() → Dict[str, Any]¶

Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.

Returns:	schemacatalogs : `dict` Keys are butler dataset type, values are a empty catalog (an instance of the appropriate `lsst.afw.table` Catalog type) for all tasks in the hierarchy, from the top-level task down through all subtasks.

Notes

This method may be called on any task in the hierarchy; it will return the same answer, regardless.

The default implementation should always suffice. If your subtask uses schemas the override Task.getSchemaCatalogs, not this method.

getFullMetadata() → lsst.pipe.base._task_metadata.TaskMetadata¶

Get metadata for all tasks.

Returns:	metadata : `TaskMetadata` The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() → str¶

Get the task name as a hierarchical name including parent task names.

Returns:	fullName : `str` The full name consists of the name of the parent task and each subtask separated by periods. For example: The full name of top-level task “top” is simply “top”. The full name of subtask “sub” of top-level task “top” is “top.sub”. The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName() → str¶

Get the name of the task.

Returns:	taskName : `str` Name of the task.

See also

Task.getAllSchemaCatalogs

Notes

Warning

Subclasses that use schemas must override this method. The default implementation returns an empty dict.

This method may be called at any time after the Task is constructed, which means that all task schemas should be computed at construction time, not when data is actually processed. This reflects the philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.

getTaskDict() → Dict[str, weakref.ReferenceType[Task]]¶

Get a dictionary of all tasks as a shallow copy.

Returns:	taskDict : `dict` Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

initialFitFullCovariance(mu, cov, sqrtW)¶

Performs a crude parabolic fit of the data in order to start the full fit close to the solution, setting b=0 (c=0) in Eq. 20 of Astier+19.

Parameters:	mu : `numpy.array`, (N,) Signal `mu` (ADU) cov : `numpy.array`, (N, M, M) Covariance arrays of size `(M, M)` (with `M = config.maximumRangeCovariancesAstier`), indexed by mean signal `mu`. sqrtW : `numpy.array`, (N,) Covariance weights, defined as 1./sqrt(Variances)
Returns:	a : `numpy.array`, (M, M) “a” parameter per flux in Eq. 20 of Astier+19. c : `numpy.array`, (M, M) “c”=”ab” parameter per flux in Eq. 20 of Astier+19. noise : `numpy.array`, (M, M) “noise” parameter per flux in Eq. 20 of Astier+19. gain : `float` Amplifier gain (e/ADU)

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.pex.config.ConfigurableField` A `ConfigurableField` for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")

makeSubtask(name: str, **keyArgs) → None¶

Create a subtask as a new instance as the name attribute of this task.

Parameters:	name : `str` Brief name of the subtask. keyArgs Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden: “config”. “parentTask”.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

classmethod parseAndRun(args=None, config=None, log=None, doReturnResults=False)¶

Parse an argument list and run the command.

Parameters:

args : list, optional: List of command-line arguments; if None use sys.argv.
config : lsst.pex.config.Config-type, optional: Config for task. If None use Task.ConfigClass.
log : logging.Logger-type, optional: Log. If None use the default log.
doReturnResults : bool, optional: If True, return the results of this task. Default is False. This is only intended for unit tests and similar use. It can easily exhaust memory (if the task returns enough data and you call it enough times) and it will fail when using multiprocessing if the returned data cannot be pickled.

Returns:

struct : lsst.pipe.base.Struct

Fields are:

argumentParser: the argument parser (lsst.pipe.base.ArgumentParser).
parsedCmd: the parsed command returned by the argument parser’s parse_args method (argparse.Namespace).
taskRunner: the task runner used to run the task (an instance of Task.RunnerClass).
resultList: results returned by the task runner’s run method, one entry per invocation (list). This will typically be a list of Struct, each containing at least an exitStatus integer (0 or 1); see Task.RunnerClass (TaskRunner by default) for more details.

Notes

Calling this method with no arguments specified is the standard way to run a command-line task from the command-line. For an example see pipe_tasks bin/makeSkyMap.py or almost any other file in that directory.

If one or more of the dataIds fails then this routine will exit (with a status giving the number of failed dataIds) rather than returning this struct; this behaviour can be overridden by specifying the --noExit command-line option.

run(inputCovariances, camera=None, inputExpList=None)¶

Fit measured covariances to different models.

Parameters:	inputCovariances : `list` [`lsst.ip.isr.PhotonTransferCurveDataset`] List of lsst.ip.isr.PhotonTransferCurveDataset datasets. camera : `lsst.afw.cameraGeom.Camera`, optional Input camera. inputExpList : `list` [`ExposureF`], optional List of exposures.
Returns:	results : `lsst.pipe.base.Struct` The results struct containing: `outputPtcDatset` Final PTC dataset, containing information such as the means, variances, and exposure times (`lsst.ip.isr.PhotonTransferCurveDataset`).

runQuantum(butlerQC, inputRefs, outputRefs)¶

Ensure that the input and output dimensions are passed along.

Parameters:	butlerQC : `ButlerQuantumContext` Butler to operate on. inputRefs : `InputQuantizedConnection` Input data refs to load. ouptutRefs : `OutputQuantizedConnection` Output data refs to persist.

timer(name: str, logLevel: int = 10) → Iterator[None]¶

Context manager to log performance data for an arbitrary block of code.

Parameters:	name : `str` Name of code being timed; data will be logged using item name: `Start` and `End`. logLevel A `logging` level constant.

Navigation

PhotonTransferCurveSolveTask¶