lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig Class Reference

Inheritance diagram for lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig:

Static Public Attributes
	ccdKey
	ptcFitType
	maximumRangeCovariancesAstier
	covAstierRealSpace
	polynomialFitDegree
	linearity
	doCreateLinearizer
	binSize
	minMeanSignal
	maxMeanSignal
	initialNonLinearityExclusionThresholdPositive
	initialNonLinearityExclusionThresholdNegative
	minMeanRatioTest
	minVarPivotSearch
	sigmaCutPtcOutliers
	maskNameList
	nSigmaClipPtc
	nIterSigmaClipPtc
	minNumberGoodPixelsForFft
	maxIterationsPtcOutliers
	doFitBootstrap
	doPhotodiode
	photodiodeDataPath
	instrumentName

Detailed Description

Config class for photon transfer curve measurement task

Definition at line 47 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 90 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 49 of file ptc.py.

covAstierRealSpace

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.covAstierRealSpace

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Calculate covariances in real space or via FFT? (see appendix A of Astier+19).",
        default=False,
    )

Definition at line 69 of file ptc.py.

doCreateLinearizer

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.doCreateLinearizer

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Calculate non-linearity and persist linearizer?",
        default=False,
    )

Definition at line 84 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 176 of file ptc.py.

doPhotodiode

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.doPhotodiode

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        doc="Apply a correction based on the photodiode readings if available?",
        default=True,
    )

Definition at line 181 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 121 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.05,
        min=0.0,
        max=1.0,
    )

Definition at line 111 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 191 of file ptc.py.

linearity

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.linearity

static

Initial value:

=  pexConfig.ConfigurableField(
        target=LinearitySolveTask,
        doc="Task to solve the linearity."
    )

Definition at line 79 of file ptc.py.

maskNameList

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maskNameList

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc="Mask list to exclude from statistics calculations.",
        default=['SUSPECT', 'BAD', 'NO_DATA'],
    )

Definition at line 151 of file ptc.py.

maximumRangeCovariancesAstier

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maximumRangeCovariancesAstier

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Maximum range of covariances as in Astier+19",
        default=8,
    )

Definition at line 64 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 171 of file ptc.py.

maxMeanSignal

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxMeanSignal

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        doc="Maximum values (inclusive) of mean signal (in ADU) below which to consider, per amp."
            " The same cut is applied to all amps if this dictionary is of the form"
            " {'ALL_AMPS': value}",
        default={'ALL_AMPS': 1e6},
    )

Definition at line 103 of file ptc.py.

minMeanRatioTest

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.minMeanRatioTest

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="In the initial test to screen out bad points with a ratio test, points with low"
            " flux can get inadvertantly screened.  This test only screens out points with flux"
            " above this value.",
        default=20000,
    )

Definition at line 131 of file ptc.py.

minMeanSignal

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.minMeanSignal

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        doc="Minimum values (inclusive) of mean signal (in ADU) above which to consider, per amp."
            " The same cut is applied to all amps if this dictionary is of the form"
            " {'ALL_AMPS': value}",
        default={'ALL_AMPS': 0.0},
    )

Definition at line 95 of file ptc.py.

minNumberGoodPixelsForFft

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.minNumberGoodPixelsForFft

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Minimum number of acceptable good pixels per amp to calculate the covariances via FFT.",
        default=10000,
    )

Definition at line 166 of file ptc.py.

minVarPivotSearch

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.minVarPivotSearch

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="The code looks for a pivot signal point after which the variance starts decreasing at high-flux"
            " to exclude then form the PTC model fit. However, sometimes at low fluxes, the variance"
            " decreases slightly. Set this variable for the variance value, in ADU^2, after which the pivot "
            " should be sought.",
        default=10000,
    )

Definition at line 138 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 161 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 156 of file ptc.py.

photodiodeDataPath

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.photodiodeDataPath

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        doc="Gen2 only: path to locate the data photodiode data files.",
        default=""
    )

Definition at line 186 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=3,
    )

Definition at line 74 of file ptc.py.

ptcFitType

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.ptcFitType

static

Initial value:

=  pexConfig.ChoiceField(
        dtype=str,
        doc="Fit PTC to Eq. 16, Eq. 20 in Astier+19, or to a polynomial.",
        default="POLYNOMIAL",
        allowed={
            "POLYNOMIAL": "n-degree polynomial (use 'polynomialFitDegree' to set 'n').",
            "EXPAPPROXIMATION": "Approximation in Astier+19 (Eq. 16).",
            "FULLCOVARIANCE": "Full covariances model in Astier+19 (Eq. 20)"
        }
    )

Definition at line 54 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 146 of file ptc.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.1.5/Linux64/cp_pipe/21.0.0-5-gb7080ec+8658c79ec4/python/lsst/cp/pipe/ptc.py