lsst.cp.pipe  19.0.0-19-g32a200e+6
Static Public Attributes | List of all members
lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig Class Reference
Inheritance diagram for lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig:

Static Public Attributes

 isr
 
 isrMandatorySteps
 
 isrForbiddenSteps
 
 isrDesirableSteps
 
 isrUndesirableSteps
 
 ccdKey
 
 makePlots
 
 ptcFitType
 
 polynomialFitDegree
 
 polynomialFitDegreeNonLinearity
 
 binSize
 
 minMeanSignal
 
 maxMeanSignal
 
 initialNonLinearityExclusionThresholdPositive
 
 initialNonLinearityExclusionThresholdNegative
 
 sigmaCutPtcOutliers
 
 nSigmaClipPtc
 
 nIterSigmaClipPtc
 
 maxIterationsPtcOutliers
 
 doFitBootstrap
 
 linResidualTimeIndex
 
 maxAduForLookupTableLinearizer
 
 instrumentName
 

Detailed Description

Config class for photon transfer curve measurement task

Definition at line 48 of file ptc.py.

Member Data Documentation

◆ binSize

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.binSize
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Bin the image by this factor in both dimensions.",
default=1,
)

Definition at line 108 of file ptc.py.

◆ ccdKey

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.ccdKey
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="The key by which to pull a detector from a dataId, e.g. 'ccd' or 'detector'.",
default='ccd',
)

Definition at line 78 of file ptc.py.

◆ doFitBootstrap

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.doFitBootstrap
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use bootstrap for the PTC fit parameters and errors?.",
default=False,
)

Definition at line 163 of file ptc.py.

◆ initialNonLinearityExclusionThresholdNegative

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.initialNonLinearityExclusionThresholdNegative
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Initially exclude data points with a variance that are more than a factor of this from being"
" linear in the negative direction, from the PTC fit. Note that these points will also be"
" excluded from the non-linearity fit. This is done before the iterative outlier rejection,"
" to allow an accurate determination of the sigmas for said iterative fit.",
default=0.25,
min=0.0,
max=1.0,
)

Definition at line 133 of file ptc.py.

◆ initialNonLinearityExclusionThresholdPositive

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.initialNonLinearityExclusionThresholdPositive
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Initially exclude data points with a variance that are more than a factor of this from being"
" linear in the positive direction, from the PTC fit. Note that these points will also be"
" excluded from the non-linearity fit. This is done before the iterative outlier rejection,"
" to allow an accurate determination of the sigmas for said iterative fit.",
default=0.12,
min=0.0,
max=1.0,
)

Definition at line 123 of file ptc.py.

◆ instrumentName

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.instrumentName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Instrument name.",
default='',
)

Definition at line 178 of file ptc.py.

◆ isr

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.isr
static
Initial value:
= pexConfig.ConfigurableField(
target=IsrTask,
doc=,
)

Definition at line 50 of file ptc.py.

◆ isrDesirableSteps

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.isrDesirableSteps
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="isr operations that it is advisable to perform, but are not mission-critical." +
" WARNs are logged for any of these found to be False.",
default=['doBias', 'doDark', 'doCrosstalk', 'doDefect']
)

Definition at line 65 of file ptc.py.

◆ isrForbiddenSteps

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.isrForbiddenSteps
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="isr operations that must NOT be performed for valid results. Raises if any of these are True",
default=['doFlat', 'doFringe', 'doBrighterFatter', 'doUseOpticsTransmission',
'doUseFilterTransmission', 'doUseSensorTransmission', 'doUseAtmosphereTransmission']
)

Definition at line 59 of file ptc.py.

◆ isrMandatorySteps

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.isrMandatorySteps
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="isr operations that must be performed for valid results. Raises if any of these are False.",
default=['doAssembleCcd']
)

Definition at line 54 of file ptc.py.

◆ isrUndesirableSteps

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.isrUndesirableSteps
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="isr operations that it is *not* advisable to perform in the general case, but are not" +
" forbidden as some use-cases might warrant them." +
" WARNs are logged for any of these found to be True.",
default=['doLinearize']
)

Definition at line 71 of file ptc.py.

◆ linResidualTimeIndex

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.linResidualTimeIndex
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Index position in time array for reference time in linearity residual calculation.",
default=2,
)

Definition at line 168 of file ptc.py.

◆ makePlots

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.makePlots
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Plot the PTC curves?",
default=False,
)

Definition at line 83 of file ptc.py.

◆ maxAduForLookupTableLinearizer

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxAduForLookupTableLinearizer
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum DN value for the LookupTable linearizer.",
default=2**18,
)

Definition at line 173 of file ptc.py.

◆ maxIterationsPtcOutliers

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxIterationsPtcOutliers
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations for outlier rejection in PTC.",
default=2,
)

Definition at line 158 of file ptc.py.

◆ maxMeanSignal

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxMeanSignal
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum value (inclusive) of mean signal (in DN) below which to consider.",
default=9e6,
)

Definition at line 118 of file ptc.py.

◆ minMeanSignal

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.minMeanSignal
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Minimum value (inclusive) of mean signal (in DN) above which to consider.",
default=0,
)

Definition at line 113 of file ptc.py.

◆ nIterSigmaClipPtc

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.nIterSigmaClipPtc
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of sigma-clipping iterations for afwMath.StatisticsControl()",
default=1,
)

Definition at line 153 of file ptc.py.

◆ nSigmaClipPtc

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.nSigmaClipPtc
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma cut for afwMath.StatisticsControl()",
default=5.5,
)

Definition at line 148 of file ptc.py.

◆ polynomialFitDegree

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.polynomialFitDegree
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Degree of polynomial to fit the PTC, when 'ptcFitType'=POLYNOMIAL.",
default=2,
)

Definition at line 97 of file ptc.py.

◆ polynomialFitDegreeNonLinearity

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.polynomialFitDegreeNonLinearity
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Degree of polynomial to fit the meanSignal vs exposureTime curve to produce" +
" the table for LinearizeLookupTable.",
default=3,
)

Definition at line 102 of file ptc.py.

◆ ptcFitType

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.ptcFitType
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Fit PTC to approximation in Astier+19 (Equation 16) or to a polynomial.",
default="POLYNOMIAL",
allowed={
"POLYNOMIAL": "n-degree polynomial (use 'polynomialFitDegree' to set 'n').",
"ASTIERAPPROXIMATION": "Approximation in Astier+19 (Eq. 16)."
}
)

Definition at line 88 of file ptc.py.

◆ sigmaCutPtcOutliers

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.sigmaCutPtcOutliers
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma cut for outlier rejection in PTC.",
default=5.0,
)

Definition at line 143 of file ptc.py.


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