lsst.cp.pipe#

Using lsst.cp.pipe#

Contributing#

lsst.cp.pipe is developed at lsst/cp_pipe. You can find Jira issues for this module under the cp_pipe component.

Task reference#

Pipeline tasks#

Tasks#

Python API reference#

lsst.cp.pipe Package#

Functions#

configureIsrTaskLSSTForCalibrations(config)

Apply configuration overrides for a baseline of building calibrations.

Classes#

BrighterFatterKernelSolveConfig(*args, **kw)

BrighterFatterKernelSolveTask(*[, config, ...])

Measure appropriate Brighter-Fatter Kernel from the PTC dataset.

CalibCombineByFilterConfig(*args, **kw)

CalibCombineByFilterConnections(*[, config])

CalibCombineByFilterTask(**kwargs)

Task to combine calib exposures.

CalibCombineConfig(*args, **kw)

Configuration for combining calib exposures.

CalibCombineConnections(*[, config])

CalibCombineTask(**kwargs)

Task to combine calib exposures.

CalibCombineTwoFlatsByFilterConfig(*args, **kw)

CalibCombineTwoFlatsByFilterTask(**kwargs)

Task to combine two flats (weighted).

CalibStatsConfig(*args, **kw)

Parameters controlling the measurement of background statistics.

CalibStatsTask([config, name, parentTask, log])

Measure statistics on the background

CpCtiSolveConfig(*args, **kw)

Configuration for the CTI combination.

CpCtiSolveConnections(*[, config])

CpCtiSolveTask(**kwargs)

Combine CTI measurements to a final calibration.

CpDarkTask(**kwargs)

Combine pre-processed dark frames into a proposed master calibration.

CpDarkTaskConfig(*args, **kw)

CpEfdClient([efdInstance, dieOnSearch, log])

An EFD client to retrieve calibration results.

CpFilterScanTask(**kwargs)

Create filter scan from appropriate data.

CpFilterScanTaskConfig(*args, **kw)

CpFlatApplyGradientsConfig(*args, **kw)

CpFlatApplyGradientsTask(*[, config, log, ...])

Task to apply/remove gradients for dome flats.

CpFlatFitGradientsConfig(*args, **kw)

CpFlatFitGradientsTask(*[, config, log, ...])

Task to measure gradients on sky/dome flats.

CpFlatMeasureTask(*[, config, log, initInputs])

Apply extra masking and measure image statistics.

CpFlatMeasureTaskConfig(*args, **kw)

CpFlatNormalizationTask(*[, config, log, ...])

Rescale merged flat frames to remove unequal screen illumination.

CpFlatNormalizationTaskConfig(*args, **kw)

CpFringeTask(**kwargs)

Combine pre-processed fringe frames into a proposed master calibration.

CpFringeTaskConfig(*args, **kw)

CpMeasureGainCorrectionConfig(*args, **kw)

CpMeasureGainCorrectionTask(*[, config, ...])

Task to measure gain corrections.

CpMonochromatorScanConfig(*args, **kw)

CpMonochromatorScanTask(*[, config, log, ...])

Compare EFD monochromator results to fiber spectrograph spectra.

CpSkyCombineConfig(*args, **kw)

CpSkyCombineTask(**kwargs)

Merge per-exposure measurements into a detector level calibration.

CpSkyImageConfig(*args, **kw)

CpSkyImageTask(**kwargs)

Mask the detections on the postISRCCD.

CpSkyScaleMeasureConfig(*args, **kw)

CpSkyScaleMeasureTask(*[, config, log, ...])

Measure per-exposure scale factors and merge focal plane backgrounds.

CpSkySubtractBackgroundConfig(*args, **kw)

CpSkySubtractBackgroundTask(**kwargs)

Subtract per-exposure background from individual detector masked images.

CpSpectroFlatTask(*[, config, log, initInputs])

Construct a spectro-flat from a white-band flat.

CpSpectroFlatTaskConfig(*args, **kw)

Configuration parameters for constructing spectroFlat from a white-band flat.

CrosstalkExtractConfig(*args, **kw)

Configuration for the measurement of pixel ratios.

CrosstalkExtractTask(**kwargs)

Task to measure pixel ratios to find crosstalk.

CrosstalkSolveConfig(*args, **kw)

Configuration for the solving of crosstalk from pixel ratios.

CrosstalkSolveTask(*[, config, log, initInputs])

Task to solve crosstalk from pixel ratios.

ElectrostaticBrighterFatterSolveConfig(...)

ElectrostaticBrighterFatterSolveTask(*[, ...])

Find the complete electrostatic solution to the given PTC.

FloatingOutputAmplifier(*args, **kwargs)

LinearityDoubleSplineSolveConfig(*args, **kw)

LinearityDoubleSplineSolveTask(*[, config, ...])

LinearityNormalizeConfig(*args, **kw)

LinearityNormalizeTask(*[, config, log, ...])

Class to use data to normalize linearity inputs.

LinearitySolveConfig(*args, **kw)

Configuration for solving the linearity from PTC dataset.

LinearitySolveTask(*[, config, log, initInputs])

Fit the linearity from the PTC dataset.

MeasureDefectsCombinedTask(*[, config, log, ...])

Task to measure defects in combined images.

MeasureDefectsCombinedTaskConfig(*args, **kw)

Configuration for measuring defects from combined exposures.

MeasureDefectsCombinedWithFilterTask(*[, ...])

Task to measure defects in combined images.

MeasureDefectsCombinedWithFilterTaskConfig(...)

Configuration for measuring defects from combined exposures.

MeasureDefectsTask(*[, config, log, initInputs])

Measure the defects from one exposure.

MeasureDefectsTaskConfig(*args, **kw)

Configuration for measuring defects from a list of exposures

MergeDefectsCombinedTask(*[, config, log, ...])

Task to measure defects in combined images.

MergeDefectsCombinedTaskConfig(*args, **kw)

Configuration for merging defects from combined exposure.

MergeDefectsTask(*[, config, log, initInputs])

Merge the defects from multiple exposures.

MergeDefectsTaskConfig(*args, **kw)

Configuration for merging single exposure defects.

OverscanModel(*args, **kwargs)

PhotodiodeCorrectionConfig(*args, **kw)

Configuration for calculating the photodiode corrections.

PhotodiodeCorrectionTask(*[, config, log, ...])

Calculate the photodiode corrections.

PhotonTransferCurveAdjustGainRatiosConfig(...)

PhotonTransferCurveAdjustGainRatiosTask(*[, ...])

Task to remove gradients to fit amp ratio gain adjustments.

PhotonTransferCurveExtractConfig(*args, **kw)

PhotonTransferCurveExtractPairConfig(*args, **kw)

PhotonTransferCurveExtractPairTask(*[, ...])

PhotonTransferCurveExtractTask(*[, config, ...])

PhotonTransferCurveFixupGainRatiosConfig(...)

PhotonTransferCurveFixupGainRatiosTask(...)

Task to use on-sky amp ratios to fix up gain ratios in a PTC.

PhotonTransferCurveRenameConfig(*args, **kwargs)

PhotonTransferCurveRenameTask(*args, **kwargs)

Task to rename a ptcFixed into a ptc.

PhotonTransferCurveSolveConfig(*args, **kw)

Configuration for fitting measured covariances.

PhotonTransferCurveSolveTask(*[, config, ...])

Task to fit the PTC from flat covariances.

PlotPhotonTransferCurveConfig(*args, **kw)

Configuration for the measurement of covariances from flats.

PlotPhotonTransferCurveTask(*[, config, ...])

A class to plot the dataset from MeasurePhotonTransferCurveTask.

SegmentSimulator(*args, **kwargs)

SimpleModel(*args, **kwargs)

SimulatedModel(*args, **kwargs)

lsst.cp.pipe.cpFlatMeasure Module#

Classes#

CpFlatMeasureTask(*[, config, log, initInputs])

Apply extra masking and measure image statistics.

CpFlatMeasureTaskConfig(*args, **kw)

CpFlatNormalizationTask(*[, config, log, ...])

Rescale merged flat frames to remove unequal screen illumination.

CpFlatNormalizationTaskConfig(*args, **kw)

lsst.cp.pipe.cpDark Module#

Classes#

CpDarkTask(**kwargs)

Combine pre-processed dark frames into a proposed master calibration.

CpDarkTaskConfig(*args, **kw)

lsst.cp.pipe.cpFringe Module#

Classes#

CpFringeTask(**kwargs)

Combine pre-processed fringe frames into a proposed master calibration.

CpFringeTaskConfig(*args, **kw)

lsst.cp.pipe.utils Module#

Functions#

ddict2dict(d)

Convert nested default dictionaries to regular dictionaries.

getReadNoise(exposure, ampName[, ...])

Gets readout noise for an amp from ISR metadata.

ampOffsetGainRatioFixup(ptc, minAdu, maxAdu)

Apply gain ratio fixup using amp offsets.

Classes#

CovFastFourierTransform(diff, w, fftShape, ...)

A class to compute (via FFT) the nearby pixels correlation function.

ElectrostaticFit(initialParams, fitMethod, ...)

Class to handle the electrostatic fit of area coefficients.

BoundaryShifts(electrostaticFit, zf)

Class to compute and store boundary shift values for CCD pixels based on electrostatic field models.

ElectrostaticCcdGeom(paramDict)