LinearityDoubleSplineSolveConfig#

class lsst.cp.pipe.LinearityDoubleSplineSolveConfig(*args, **kw)#

Bases: PipelineTaskConfig

Attributes Summary

`absoluteNSigmaClipLinear`	Sigma-clipping for absolute spline solution.
`absoluteSplineFitMaxIter`	Maximum number of iterations for absolute spline fit.
`absoluteSplineFitMaxRejectionPerIteration`	Maximum number of rejections per iteration for absolute spline fit.
`absoluteSplineFitMinIter`	Minimum number of iterations for absolute spline fit.
`absoluteSplineFitTemperatureColumn`	Name of the temperature column to use when fitting temperature coefficients in spline fit; this must not be None if doSplineFitTemperature is True.
`absoluteSplineFitWeightParsStart`	Starting parameters for weight fit, if doSplineFitWeights=True.
`absoluteSplineLowNodeSize`	Minimum size for low-level linearity nodes for absolute spline (adu).
`absoluteSplineLowThreshold`	Threshold for the low-level linearity nodes for absolute spline (adu).
`absoluteSplineMinimumSignalNode`	Smallest node (above 0) for absolute spline (adu).
`absoluteSplineNodeSize`	Minimum size for linearity nodes for absolute spline above absoluteSplineLowThreshold e(adu); note that there will always be a node at the reference PTC turnoff.
`autoGroupingMaxSignalFraction`	Only do auto-grouping when the signal is this fraction of the maximum signal.
`autoGroupingThreshold`	Minimum relative jump from sorted conversion values to determine a group.
`autoGroupingUseExptime`	Use exposure time to determine automatic grouping.
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`doAbsoluteSplineFitOffset`	Fit a scattered light offset in the spline fit.
`doAbsoluteSplineFitTemperature`	Fit temperature coefficient in spline fit? (`bool`, default `False`)
`doAbsoluteSplineFitTemporal`	Fit a linear temporal parameter coefficient in spline fit? (`bool`, default `False`)
`doAbsoluteSplineFitWeights`	Fit linearity weight parameters in the spline fit.
`doAutoGrouping`	Do automatic group detection? Cannot be True if splineGroupingColumn is also set.
`groupingColumn`	Column to use for grouping together points, to allow for different proportionality constants.
`maxFracLinearityDeviation`	Maximum fraction deviation from raw linearity to compute linearityTurnoff and linearityMaxSignal.
`maxNoiseReference`	Maximum read noise (e-) in the PTC for an amp to be considered as a reference.
`minPhotodiodeCurrent`	Minimum value to trust photodiode signals.
`minSignalFitLinearityTurnoff`	Minimum signal to compute raw linearity slope for linearityTurnoff.
`relativeNSigmaClipLinear`	Sigma-clipping for relative spline solution.
`relativeSplineFitMaxIter`	Maximum number of iterations for relative spline fit.
`relativeSplineFitMaxRejectionPerIteration`	Maximum number of rejections per iteration for relative spline fit.
`relativeSplineFitMinIter`	Minimum number of iterations for relative spline fit.
`relativeSplineHighNodeSize`	Minimum size for high-level linearity nodes for relative spline (adu); this applies to counts between the PTC and linearity turnoffs.
`relativeSplineLowNodeSize`	Minimum size for low-level linearity nodes for relative spline (adu).
`relativeSplineLowThreshold`	Threshold for the low-level linearity nodes for relative spline (adu).If this is below `relativeSplineMinimumSignalNode` then the low level checks will be skipped.
`relativeSplineMidNodeSize`	Minimum size for mid-level linearity nodes for relative spline (adu); this applies to counts between relativeSplineLowThreshold and the PTC turnoff.
`relativeSplineMinimumSignalNode`	Smallest node (above 0) for relative spline (adu).
`relativeSplineReferenceCounts`	Number of target counts (adu) to select a reference image for relative spline solution.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`useFocalPlaneNormalization`	Use focal-plane normalization in addition to/instead of photodiode? (Only used with for absolute spline fitting).
`usePhotodiode`	Use the photodiode info instead of the raw expTimes? (`bool`, default `False`)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

absoluteNSigmaClipLinear#: Sigma-clipping for absolute spline solution. (float, default 5.0)

absoluteSplineFitMaxIter#: Maximum number of iterations for absolute spline fit. (int, default 20)

absoluteSplineFitMaxRejectionPerIteration#: Maximum number of rejections per iteration for absolute spline fit. (int, default 5)

absoluteSplineFitMinIter#: Minimum number of iterations for absolute spline fit. (int, default 3)

absoluteSplineFitTemperatureColumn#: Name of the temperature column to use when fitting temperature coefficients in spline fit; this must not be None if doSplineFitTemperature is True. (str, default None)

absoluteSplineFitWeightParsStart#: Starting parameters for weight fit, if doSplineFitWeights=True. Parameters are such that sigma = sqrt(par[0]**2. + par[1]**2./mu).If doSplineFitWeights=False then these are used as-is; otherwise they are used as the initial values for fitting these parameters. (List, default [1.0, 0.0])

absoluteSplineLowNodeSize#: Minimum size for low-level linearity nodes for absolute spline (adu). (float, default 2000.0)

absoluteSplineLowThreshold#: Threshold for the low-level linearity nodes for absolute spline (adu). If this is below absoluteSplineMinimumSignalNode then the low level checks will be skipped. (float, default 0.0)

absoluteSplineMinimumSignalNode#: Smallest node (above 0) for absolute spline (adu). (float, default 0.0)

absoluteSplineNodeSize#: Minimum size for linearity nodes for absolute spline above absoluteSplineLowThreshold e(adu); note that there will always be a node at the reference PTC turnoff. (float, default 3000.0)

autoGroupingMaxSignalFraction#: Only do auto-grouping when the signal is this fraction of the maximum signal. All exposures with signal higher than this threshold will be put into the largest signal group. This config is needed if the input PTC goes beyond the linearity turnoff. (float, default 0.9)

autoGroupingThreshold#: Minimum relative jump from sorted conversion values to determine a group. (float, default 0.1)

autoGroupingUseExptime#: Use exposure time to determine automatic grouping. Used if doAutoGrouping=True. (bool, default True)

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

doAbsoluteSplineFitOffset#: Fit a scattered light offset in the spline fit. (bool, default True)

doAbsoluteSplineFitTemperature#: Fit temperature coefficient in spline fit? (bool, default False)

doAbsoluteSplineFitTemporal#: Fit a linear temporal parameter coefficient in spline fit? (bool, default False)

doAbsoluteSplineFitWeights#: Fit linearity weight parameters in the spline fit. (bool, default False)

doAutoGrouping#: Do automatic group detection? Cannot be True if splineGroupingColumn is also set. The automatic group detection will use the ratio of signal to exposure time (if autoGroupingUseExptime is True) or photodiode (if False) to determine which flat pairs were taken with different illumination settings. (bool, default False)

groupingColumn#: Column to use for grouping together points, to allow for different proportionality constants. If None, then grouping will only be done if doAutoGrouping is True. (str, default None)

maxFracLinearityDeviation#: Maximum fraction deviation from raw linearity to compute linearityTurnoff and linearityMaxSignal. (float, default 0.01)

maxNoiseReference#: Maximum read noise (e-) in the PTC for an amp to be considered as a reference. (float, default 12.0)

minPhotodiodeCurrent#: Minimum value to trust photodiode signals. (float, default 0.0)

minSignalFitLinearityTurnoff#: Minimum signal to compute raw linearity slope for linearityTurnoff. (float, default 1000.0)

relativeNSigmaClipLinear#: Sigma-clipping for relative spline solution. (float, default 5.0)

relativeSplineFitMaxIter#: Maximum number of iterations for relative spline fit. (int, default 20)

relativeSplineFitMaxRejectionPerIteration#: Maximum number of rejections per iteration for relative spline fit. (int, default 5)

relativeSplineFitMinIter#: Minimum number of iterations for relative spline fit. (int, default 3)

relativeSplineHighNodeSize#: Minimum size for high-level linearity nodes for relative spline (adu); this applies to counts between the PTC and linearity turnoffs. (float, default 2000.0)

relativeSplineLowNodeSize#: Minimum size for low-level linearity nodes for relative spline (adu). (float, default 750.0)

relativeSplineLowThreshold#: Threshold for the low-level linearity nodes for relative spline (adu).If this is below relativeSplineMinimumSignalNode then the low level checks will be skipped. (float, default 5000.0)

relativeSplineMidNodeSize#: Minimum size for mid-level linearity nodes for relative spline (adu); this applies to counts between relativeSplineLowThreshold and the PTC turnoff. (float, default 5000.0)

relativeSplineMinimumSignalNode#: Smallest node (above 0) for relative spline (adu). (float, default 100.0)

relativeSplineReferenceCounts#: Number of target counts (adu) to select a reference image for relative spline solution. (float, default 10000.0)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

useFocalPlaneNormalization#: Use focal-plane normalization in addition to/instead of photodiode? (Only used with for absolute spline fitting). (bool, default False)

usePhotodiode#: Use the photodiode info instead of the raw expTimes? (bool, default False)

Methods Documentation

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.