makeBrighterFatterKernel.py

Go to the documentation of this file.

# This file is part of cp_pipe.
#
# Developed for the LSST Data Management System.
# This product includes software developed by the LSST Project
# (https://www.lsst.org).
# See the COPYRIGHT file at the top-level directory of this distribution
# for details of code ownership.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Calculation of brighter-fatter effect correlations and kernels."""
 
__all__ = ['MakeBrighterFatterKernelTaskConfig',
           'MakeBrighterFatterKernelTask',
           'calcBiasCorr']
 
import os
import copy
from scipy import stats
import numpy as np
import matplotlib.pyplot as plt
# the following import is required for 3d projection
from mpl_toolkits.mplot3d import axes3d  # noqa: F401
from matplotlib.backends.backend_pdf import PdfPages
from dataclasses import dataclass
 
import lsstDebug
import lsst.afw.image as afwImage
import lsst.afw.math as afwMath
import lsst.afw.display as afwDisp
from lsst.ip.isr import IsrTask
import lsst.log as lsstLog
import lsst.pex.config as pexConfig
import lsst.pipe.base as pipeBase
from .utils import PairedVisitListTaskRunner, checkExpLengthEqual
import lsst.daf.persistence.butlerExceptions as butlerExceptions
from lsst.cp.pipe.ptc import (MeasurePhotonTransferCurveTaskConfig, MeasurePhotonTransferCurveTask,
                              PhotonTransferCurveDataset)
 
 
class MakeBrighterFatterKernelTaskConfig(pexConfig.Config):
    """Config class for bright-fatter effect coefficient calculation."""
 
    isr = pexConfig.ConfigurableField(
        target=IsrTask,
        doc="""Task to perform instrumental signature removal""",
    )
    isrMandatorySteps = pexConfig.ListField(
        dtype=str,
        doc="isr operations that must be performed for valid results. Raises if any of these are False",
        default=['doAssembleCcd']
    )
    isrForbiddenSteps = 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']
    )
    isrDesirableSteps = 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', 'doLinearize']
    )
    doCalcGains = pexConfig.Field(
        dtype=bool,
        doc="Measure the per-amplifier gains (using the photon transfer curve method)?",
        default=True,
    )
    doPlotPtcs = pexConfig.Field(
        dtype=bool,
        doc="Plot the PTCs and butler.put() them as defined by the plotBrighterFatterPtc template",
        default=False,
    )
    forceZeroSum = pexConfig.Field(
        dtype=bool,
        doc="Force the correlation matrix to have zero sum by adjusting the (0,0) value?",
        default=False,
    )
    correlationQuadraticFit = pexConfig.Field(
        dtype=bool,
        doc="Use a quadratic fit to find the correlations instead of simple averaging?",
        default=False,
    )
    correlationModelRadius = pexConfig.Field(
        dtype=int,
        doc="Build a model of the correlation coefficients for radii larger than this value in pixels?",
        default=100,
    )
    correlationModelSlope = pexConfig.Field(
        dtype=float,
        doc="Slope of the correlation model for radii larger than correlationModelRadius",
        default=-1.35,
    )
    ccdKey = pexConfig.Field(
        dtype=str,
        doc="The key by which to pull a detector from a dataId, e.g. 'ccd' or 'detector'",
        default='ccd',
    )
    minMeanSignal = 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},
    )
    maxMeanSignal = 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},
    )
    maxIterRegression = pexConfig.Field(
        dtype=int,
        doc="Maximum number of iterations for the regression fitter",
        default=2
    )
    nSigmaClipGainCalc = pexConfig.Field(
        dtype=int,
        doc="Number of sigma to clip the pixel value distribution to during gain calculation",
        default=5
    )
    nSigmaClipRegression = pexConfig.Field(
        dtype=int,
        doc="Number of sigma to clip outliers from the line of best fit to during iterative regression",
        default=4
    )
    xcorrCheckRejectLevel = pexConfig.Field(
        dtype=float,
        doc="Sanity check level for the sum of the input cross-correlations. Arrays which " +
        "sum to greater than this are discarded before the clipped mean is calculated.",
        default=2.0
    )
    maxIterSuccessiveOverRelaxation = pexConfig.Field(
        dtype=int,
        doc="The maximum number of iterations allowed for the successive over-relaxation method",
        default=10000
    )
    eLevelSuccessiveOverRelaxation = pexConfig.Field(
        dtype=float,
        doc="The target residual error for the successive over-relaxation method",
        default=5.0e-14
    )
    nSigmaClipKernelGen = pexConfig.Field(
        dtype=float,
        doc="Number of sigma to clip to during pixel-wise clipping when generating the kernel. See " +
        "the generateKernel docstring for more info.",
        default=4
    )
    nSigmaClipXCorr = pexConfig.Field(
        dtype=float,
        doc="Number of sigma to clip when calculating means for the cross-correlation",
        default=5
    )
    maxLag = pexConfig.Field(
        dtype=int,
        doc="The maximum lag (in pixels) to use when calculating the cross-correlation/kernel",
        default=8
    )
    nPixBorderGainCalc = pexConfig.Field(
        dtype=int,
        doc="The number of border pixels to exclude when calculating the gain",
        default=10
    )
    nPixBorderXCorr = pexConfig.Field(
        dtype=int,
        doc="The number of border pixels to exclude when calculating the cross-correlation and kernel",
        default=10
    )
    biasCorr = pexConfig.Field(
        dtype=float,
        doc="An empirically determined correction factor, used to correct for the sigma-clipping of" +
        " a non-Gaussian distribution. Post DM-15277, code will exist here to calculate appropriate values",
        default=0.9241
    )
    backgroundBinSize = pexConfig.Field(
        dtype=int,
        doc="Size of the background bins",
        default=128
    )
    fixPtcThroughOrigin = pexConfig.Field(
        dtype=bool,
        doc="Constrain the fit of the photon transfer curve to go through the origin when measuring" +
        "the gain?",
        default=True
    )
    level = pexConfig.ChoiceField(
        doc="The level at which to calculate the brighter-fatter kernels",
        dtype=str,
        default="DETECTOR",
        allowed={
            "AMP": "Every amplifier treated separately",
            "DETECTOR": "One kernel per detector",
        }
    )
    ignoreAmpsForAveraging = pexConfig.ListField(
        dtype=str,
        doc="List of amp names to ignore when averaging the amplifier kernels into the detector" +
        " kernel. Only relevant for level = AMP",
        default=[]
    )
    backgroundWarnLevel = pexConfig.Field(
        dtype=float,
        doc="Log warnings if the mean of the fitted background is found to be above this level after " +
        "differencing image pair.",
        default=0.1
    )
 
 
class BrighterFatterKernelTaskDataIdContainer(pipeBase.DataIdContainer):
    """A DataIdContainer for the MakeBrighterFatterKernelTask."""
 
    def makeDataRefList(self, namespace):
        """Compute refList based on idList.
 
        This method must be defined as the dataset does not exist before this
        task is run.
 
        Parameters
        ----------
        namespace
            Results of parsing the command-line.
 
        Notes
        -----
        Not called if ``add_id_argument`` called
        with ``doMakeDataRefList=False``.
        Note that this is almost a copy-and-paste of the vanilla implementation,
        but without checking if the datasets already exist,
        as this task exists to make them.
        """
        if self.datasetType is None:
            raise RuntimeError("Must call setDatasetType first")
        butler = namespace.butler
        for dataId in self.idList:
            refList = list(butler.subset(datasetType=self.datasetType, level=self.level, dataId=dataId))
            # exclude nonexistent data
            # this is a recursive test, e.g. for the sake of "raw" data
            if not refList:
                namespace.log.warn("No data found for dataId=%s", dataId)
                continue
            self.refList += refList
 
 
class BrighterFatterKernel:
    """A simple class to hold the kernel(s) generated and the intermediate
    data products.
 
    kernel.ampwiseKernels are the kernels for each amplifier in the detector,
    as generated by having LEVEL == 'AMP'
 
    kernel.detectorKernel is the kernel generated for the detector as a whole,
    as generated by having LEVEL == 'DETECTOR'
 
    kernel.detectorKernelFromAmpKernels is the kernel for the detector,
    generated by averaging together the amps in the detector
 
    The originalLevel is the level for which the kernel(s) were generated,
    i.e. the level at which the task was originally run.
    """
 
    def __init__(self, originalLevel, **kwargs):
        self.__dict__["originalLevel"] = originalLevel
        self.__dict__["ampwiseKernels"] = {}
        self.__dict__["detectorKernel"] = {}
        self.__dict__["detectorKernelFromAmpKernels"] = {}
        self.__dict__["means"] = []
        self.__dict__["rawMeans"] = []
        self.__dict__["rawXcorrs"] = []
        self.__dict__["xCorrs"] = []
        self.__dict__["meanXcorrs"] = []
        self.__dict__["gain"] = None  # will be a dict keyed by amp if set
        self.__dict__["gainErr"] = None  # will be a dict keyed by amp if set
        self.__dict__["noise"] = None  # will be a dict keyed by amp if set
        self.__dict__["noiseErr"] = None  # will be a dict keyed by amp if set
 
        for key, value in kwargs.items():
            if hasattr(self, key):
                setattr(self, key, value)
 
    def __setattr__(self, attribute, value):
        """Protect class attributes"""
        if attribute not in self.__dict__:
            print(f"Cannot set {attribute}")
        else:
            self.__dict__[attribute] = value
 
    def replaceDetectorKernelWithAmpKernel(self, ampName, detectorName):
        self.detectorKernel[detectorName] = self.ampwiseKernels[ampName]
 
    def makeDetectorKernelFromAmpwiseKernels(self, detectorName, ampsToExclude=[], overwrite=False):
        if detectorName not in self.detectorKernelFromAmpKernels.keys():
            self.detectorKernelFromAmpKernels[detectorName] = {}
 
        if self.detectorKernelFromAmpKernels[detectorName] != {} and overwrite is False:
            raise RuntimeError('Was told to replace existing detector kernel with overwrite==False')
 
        ampNames = self.ampwiseKernels.keys()
        ampsToAverage = [amp for amp in ampNames if amp not in ampsToExclude]
        avgKernel = np.zeros_like(self.ampwiseKernels[ampsToAverage[0]])
        for ampName in ampsToAverage:
            avgKernel += self.ampwiseKernels[ampName]
        avgKernel /= len(ampsToAverage)
 
        self.detectorKernelFromAmpKernels[detectorName] = avgKernel
 
 
@dataclass
class BrighterFatterGain:
    """The gains and the results of the PTC fits."""
    gains: dict
    ptcResults: dict
 
 
class MakeBrighterFatterKernelTask(pipeBase.CmdLineTask):
    """Brighter-fatter effect correction-kernel calculation task.
 
    A command line task for calculating the brighter-fatter correction
    kernel from pairs of flat-field images (with the same exposure length).
 
    The following operations are performed:
 
    - The configurable isr task is called, which unpersists and assembles the
      raw images, and performs the selected instrument signature removal tasks.
      For the purpose of brighter-fatter coefficient calculation is it
      essential that certain components of isr are *not* performed, and
      recommended that certain others are. The task checks the selected isr
      configuration before it is run, and if forbidden components have been
      selected task will raise, and if recommended ones have not been selected,
      warnings are logged.
 
    - The gain of the each amplifier in the detector is calculated using
      the photon transfer curve (PTC) method and used to correct the images
      so that all calculations are done in units of electrons, and so that the
      level across amplifier boundaries is continuous.
      Outliers in the PTC are iteratively rejected
      before fitting, with the nSigma rejection level set by
      config.nSigmaClipRegression. Individual pixels are ignored in the input
      images the image based on config.nSigmaClipGainCalc.
 
    - Each image is then cross-correlated with the one it's paired with
      (with the pairing defined by the --visit-pairs command line argument),
      which is done either the whole-image to whole-image,
      or amplifier-by-amplifier, depending on config.level.
 
    - Once the cross-correlations have been calculated for each visit pair,
      these are used to generate the correction kernel.
      The maximum lag used, in pixels, and hence the size of the half-size
      of the kernel generated, is given by config.maxLag,
      i.e. a value of 10 will result in a kernel of size 2n-1 = 19x19 pixels.
      Outlier values in these cross-correlations are rejected by using a
      pixel-wise sigma-clipped thresholding to each cross-correlation in
      the visit-pairs-length stack of cross-correlations.
      The number of sigma clipped to is set by config.nSigmaClipKernelGen.
 
    - Once DM-15277 has been completed, a method will exist to calculate the
      empirical correction factor, config.biasCorr.
      TODO: DM-15277 update this part of the docstring once the ticket is done.
    """
 
    RunnerClass = PairedVisitListTaskRunner
    ConfigClass = MakeBrighterFatterKernelTaskConfig
    _DefaultName = "makeBrighterFatterKernel"
 
    def __init__(self, *args, **kwargs):
        pipeBase.CmdLineTask.__init__(self, *args, **kwargs)
        self.makeSubtask("isr")
 
        self.debug = lsstDebug.Info(__name__)
        if self.debug.enabled:
            self.log.info("Running with debug enabled...")
            # If we're displaying, test it works and save displays for later.
            # It's worth testing here as displays are flaky and sometimes
            # can't be contacted, and given processing takes a while,
            # it's a shame to fail late due to display issues.
            if self.debug.display:
                try:
                    afwDisp.setDefaultBackend(self.debug.displayBackend)
                    afwDisp.Display.delAllDisplays()
                    self.disp1 = afwDisp.Display(0, open=True)
                    self.disp2 = afwDisp.Display(1, open=True)
 
                    im = afwImage.ImageF(1, 1)
                    im.array[:] = [[1]]
                    self.disp1.mtv(im)
                    self.disp1.erase()
                except NameError:
                    self.debug.display = False
                    self.log.warn('Failed to setup/connect to display! Debug display has been disabled')
 
        plt.interactive(False)  # stop windows popping up when plotting. When headless, use 'agg' backend too
        self.validateIsrConfig()
        self.config.validate()
        self.config.freeze()
 
    @classmethod
    def _makeArgumentParser(cls):
        """Augment argument parser for the MakeBrighterFatterKernelTask."""
        parser = pipeBase.ArgumentParser(name=cls._DefaultName)
        parser.add_argument("--visit-pairs", dest="visitPairs", nargs="*",
                            help="Visit pairs to use. Each pair must be of the form INT,INT e.g. 123,456")
        parser.add_id_argument("--id", datasetType="brighterFatterKernel",
                               ContainerClass=BrighterFatterKernelTaskDataIdContainer,
                               help="The ccds to use, e.g. --id ccd=0..100")
        return parser
 
    def validateIsrConfig(self):
        """Check that appropriate ISR settings are being used
        for brighter-fatter kernel calculation."""
 
        # How should we handle saturation/bad regions?
        # 'doSaturationInterpolation': True
        # 'doNanInterpAfterFlat': False
        # 'doSaturation': True
        # 'doSuspect': True
        # 'doWidenSaturationTrails': True
        # 'doSetBadRegions': True
 
        configDict = self.config.isr.toDict()
 
        for configParam in self.config.isrMandatorySteps:
            if configDict[configParam] is False:
                raise RuntimeError('Must set config.isr.%s to True '
                                   'for brighter-fatter kernel calculation' % configParam)
 
        for configParam in self.config.isrForbiddenSteps:
            if configDict[configParam] is True:
                raise RuntimeError('Must set config.isr.%s to False '
                                   'for brighter-fatter kernel calculation' % configParam)
 
        for configParam in self.config.isrDesirableSteps:
            if configParam not in configDict:
                self.log.info('Failed to find key %s in the isr config dict. You probably want ' +
                              'to set the equivalent for your obs_package to True.' % configParam)
                continue
            if configDict[configParam] is False:
                self.log.warn('Found config.isr.%s set to False for brighter-fatter kernel calculation. '
                              'It is probably desirable to have this set to True' % configParam)
 
        # subtask settings
        if not self.config.isr.assembleCcd.doTrim:
            raise RuntimeError('Must trim when assembling CCDs. Set config.isr.assembleCcd.doTrim to True')
 
    @pipeBase.timeMethod
    def runDataRef(self, dataRef, visitPairs):
        """Run the brighter-fatter measurement task.
 
        For a dataRef (which is each detector here),
        and given a list of visit pairs, calculate the
        brighter-fatter kernel for the detector.
 
        Parameters
        ----------
        dataRef : `list` of `lsst.daf.persistence.ButlerDataRef`
            dataRef for the detector for the visits to be fit.
        visitPairs : `iterable` of `tuple` of `int`
            Pairs of visit numbers to be processed together
        """
        np.random.seed(0)  # used in the PTC fit bootstrap
 
        # setup necessary objects
        # NB: don't use dataRef.get('raw_detector')
        # this currently doesn't work for composites because of the way
        # composite objects (i.e. LSST images) are handled/constructed
        # these need to be retrieved from the camera and dereferenced
        # rather than accessed directly
        detNum = dataRef.dataId[self.config.ccdKey]
        detector = dataRef.get('camera')[dataRef.dataId[self.config.ccdKey]]
        amps = detector.getAmplifiers()
        ampNames = [amp.getName() for amp in amps]
 
        if self.config.level == 'DETECTOR':
            kernels = {detNum: []}
            means = {detNum: []}
            xcorrs = {detNum: []}
            meanXcorrs = {detNum: []}
        elif self.config.level == 'AMP':
            kernels = {key: [] for key in ampNames}
            means = {key: [] for key in ampNames}
            xcorrs = {key: [] for key in ampNames}
            meanXcorrs = {key: [] for key in ampNames}
        else:
            raise RuntimeError("Unsupported level: {}".format(self.config.level))
 
        # we must be able to get the gains one way or the other, so check early
        if not self.config.doCalcGains:
            deleteMe = None
            try:
                deleteMe = dataRef.get('photonTransferCurveDataset')
            except butlerExceptions.NoResults:
                try:
                    deleteMe = dataRef.get('brighterFatterGain')
                except butlerExceptions.NoResults:
                    pass
            if not deleteMe:
                raise RuntimeError("doCalcGains == False and gains could not be got from butler") from None
            else:
                del deleteMe
 
        # if the level is DETECTOR we need to have the gains first so that each
        # amp can be gain corrected in order to treat the detector as a single
        # imaging area. However, if the level is AMP we can wait, calculate
        # the correlations and correct for the gains afterwards
        if self.config.level == 'DETECTOR':
            if self.config.doCalcGains:
                self.log.info('Computing gains for detector %s' % detNum)
                gains, nomGains = self.estimateGains(dataRef, visitPairs)
                dataRef.put(gains, datasetType='brighterFatterGain')
                self.log.debug('Finished gain estimation for detector %s' % detNum)
            else:
                gains = dataRef.get('brighterFatterGain')
                if not gains:
                    raise RuntimeError('Failed to retrieved gains for detector %s' % detNum)
                self.log.info('Retrieved stored gain for detector %s' % detNum)
            self.log.debug('Detector %s has gains %s' % (detNum, gains))
        else:  # we fake the gains as 1 for now, and correct later
            gains = BrighterFatterGain({}, {})
            for ampName in ampNames:
                gains.gains[ampName] = 1.0
            # We'll use the ptc.py code to calculate the gains, so we set this up
            ptcConfig = MeasurePhotonTransferCurveTaskConfig()
            ptcConfig.isrForbiddenSteps = []
            ptcConfig.doFitBootstrap = True
            ptcConfig.ptcFitType = 'POLYNOMIAL'  # default Astier doesn't work for gain correction
            ptcConfig.polynomialFitDegree = 3
            ptcConfig.minMeanSignal = self.config.minMeanSignal
            ptcConfig.maxMeanSignal = self.config.maxMeanSignal
            ptcTask = MeasurePhotonTransferCurveTask(config=ptcConfig)
            ptcDataset = PhotonTransferCurveDataset(ampNames)
 
        # Loop over pairs of visits
        # calculating the cross-correlations at the required level
        for (v1, v2) in visitPairs:
            dataRef.dataId['expId'] = v1
            exp1 = self.isr.runDataRef(dataRef).exposure
            dataRef.dataId['expId'] = v2
            exp2 = self.isr.runDataRef(dataRef).exposure
            del dataRef.dataId['expId']
            checkExpLengthEqual(exp1, exp2, v1, v2, raiseWithMessage=True)
 
            self.log.info('Preparing images for cross-correlation calculation for detector %s' % detNum)
            # note the shape of these returns depends on level
            _scaledMaskedIms1, _means1 = self._makeCroppedExposures(exp1, gains, self.config.level)
            _scaledMaskedIms2, _means2 = self._makeCroppedExposures(exp2, gains, self.config.level)
 
            # Compute the cross-correlation and means
            # at the appropriate config.level:
            # - "DETECTOR": one key, so compare the two visits to each other
            # - "AMP": n_amp keys, comparing each amplifier of one visit
            #          to the same amplifier in the visit its paired with
            for det_object in _scaledMaskedIms1.keys():  # det_object is ampName or detName depending on level
                self.log.debug("Calculating correlations for %s" % det_object)
                _xcorr, _mean = self._crossCorrelate(_scaledMaskedIms1[det_object],
                                                     _scaledMaskedIms2[det_object])
                xcorrs[det_object].append(_xcorr)
                means[det_object].append([_means1[det_object], _means2[det_object]])
                if self.config.level != 'DETECTOR':
                    # Populate the ptcDataset for running fitting in the PTC task
                    expTime = exp1.getInfo().getVisitInfo().getExposureTime()
                    ptcDataset.rawExpTimes[det_object].append(expTime)
                    ptcDataset.rawMeans[det_object].append((_means1[det_object] + _means2[det_object]) / 2.0)
                    ptcDataset.rawVars[det_object].append(_xcorr[0, 0] / 2.0)
 
                # TODO: DM-15305 improve debug functionality here.
                # This is position 1 for the removed code.
 
        # Save the raw means and xcorrs so we can look at them before any modifications
        rawMeans = copy.deepcopy(means)
        rawXcorrs = copy.deepcopy(xcorrs)
 
        # gains are always and only pre-applied for DETECTOR
        # so for all other levels we now calculate them from the correlations
        # and apply them
        if self.config.level != 'DETECTOR':
            if self.config.doCalcGains:  # Run the PTC task for calculating the gains, put results
                self.log.info('Calculating gains for detector %s using PTC task' % detNum)
                ptcDataset = ptcTask.fitPtc(ptcDataset, ptcConfig.ptcFitType)
                dataRef.put(ptcDataset, datasetType='photonTransferCurveDataset')
                self.log.debug('Finished gain estimation for detector %s' % detNum)
            else:  # load results  - confirmed to work much earlier on, so can be relied upon here
                ptcDataset = dataRef.get('photonTransferCurveDataset')
 
            self._applyGains(means, xcorrs, ptcDataset)
 
            if self.config.doPlotPtcs:
                dirname = dataRef.getUri(datasetType='cpPipePlotRoot', write=True)
                if not os.path.exists(dirname):
                    os.makedirs(dirname)
                detNum = dataRef.dataId[self.config.ccdKey]
                filename = f"PTC_det{detNum}.pdf"
                filenameFull = os.path.join(dirname, filename)
                with PdfPages(filenameFull) as pdfPages:
                    ptcTask._plotPtc(ptcDataset, ptcConfig.ptcFitType, pdfPages)
 
        # having calculated and applied the gains for all code-paths we can now
        # generate the kernel(s)
        self.log.info('Generating kernel(s) for %s' % detNum)
        for det_object in xcorrs.keys():  # looping over either detectors or amps
            if self.config.level == 'DETECTOR':
                objId = 'detector %s' % det_object
            elif self.config.level == 'AMP':
                objId = 'detector %s AMP %s' % (detNum, det_object)
 
            try:
                meanXcorr, kernel = self.generateKernel(xcorrs[det_object], means[det_object], objId)
                kernels[det_object] = kernel
                meanXcorrs[det_object] = meanXcorr
            except RuntimeError:
                # bad amps will cause failures here which we want to ignore
                self.log.warn('RuntimeError during kernel generation for %s' % objId)
                continue
 
        bfKernel = BrighterFatterKernel(self.config.level)
        bfKernel.means = means
        bfKernel.rawMeans = rawMeans
        bfKernel.rawXcorrs = rawXcorrs
        bfKernel.xCorrs = xcorrs
        bfKernel.meanXcorrs = meanXcorrs
        bfKernel.originalLevel = self.config.level
        try:
            bfKernel.gain = ptcDataset.gain
            bfKernel.gainErr = ptcDataset.gainErr
            bfKernel.noise = ptcDataset.noise
            bfKernel.noiseErr = ptcDataset.noiseErr
        except NameError:  # we don't have a ptcDataset to store results from
            pass
 
        if self.config.level == 'AMP':
            bfKernel.ampwiseKernels = kernels
            ex = self.config.ignoreAmpsForAveraging
            bfKernel.detectorKernel = bfKernel.makeDetectorKernelFromAmpwiseKernels(detNum, ampsToExclude=ex)
 
        elif self.config.level == 'DETECTOR':
            bfKernel.detectorKernel = kernels
        else:
            raise RuntimeError('Invalid level for kernel calculation; this should not be possible.')
 
        dataRef.put(bfKernel)
 
        self.log.info('Finished generating kernel(s) for %s' % detNum)
        return pipeBase.Struct(exitStatus=0)
 
    def _applyGains(self, means, xcorrs, ptcData):
        """Apply the gains calculated by the PtcTask.
 
        It also removes datapoints that were thrown out in the PTC algorithm.
 
        Parameters
        ----------
        means : `dict` [`str`, `list` of `tuple`]
            Dictionary, keyed by ampName, containing a list of the means for
        each visit pair.
 
        xcorrs : `dict` [`str`, `list` of `np.array`]
            Dictionary, keyed by ampName, containing a list of the
        cross-correlations for each visit pair.
 
        ptcDataset : `lsst.cp.pipe.ptc.PhotonTransferCurveDataset`
            The results of running the ptcTask.
        """
        ampNames = means.keys()
        assert set(xcorrs.keys()) == set(ampNames) == set(ptcData.ampNames)
 
        for ampName in ampNames:
            mask = ptcData.expIdMask[ampName]
            gain = ptcData.gain[ampName]
 
            fitType = ptcData.ptcFitType[ampName]
            if fitType != 'POLYNOMIAL':
                raise RuntimeError(f"Only polynomial fit types supported currently, found {fitType}")
            ptcFitPars = ptcData.ptcFitPars[ampName]
            # polynomial params go in ascending order, so this is safe w.r.t.
            # the polynomial order, as the constant term is always first,
            # the linear term second etc
 
            # Adjust xcorrs[0,0] to remove the linear gain part, leaving just the second order part
            for i in range(len(means[ampName])):
                ampMean = np.mean(means[ampName][i])
                xcorrs[ampName][i][0, 0] -= 2.0 * (ampMean * ptcFitPars[1] + ptcFitPars[0])
 
            # Now adjust the means and xcorrs for the calculated gain and remove the bad indices
            means[ampName] = [[value*gain for value in pair] for pair in np.array(means[ampName])[mask]]
            xcorrs[ampName] = [arr*gain*gain for arr in np.array(xcorrs[ampName])[mask]]
        return
 
    def _makeCroppedExposures(self, exp, gains, level):
        """Prepare exposure for cross-correlation calculation.
 
        For each amp, crop by the border amount, specified by
        config.nPixBorderXCorr, then rescale by the gain
        and subtract the sigma-clipped mean.
        If the level is 'DETECTOR' then this is done
        to the whole image so that it can be cross-correlated, with a copy
        being returned.
        If the level is 'AMP' then this is done per-amplifier,
        and a copy of each prepared amp-image returned.
 
        Parameters:
        -----------
        exp : `lsst.afw.image.exposure.ExposureF`
            The exposure to prepare
        gains : `lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterGain`
            The object holding the amplifier gains, essentially a
            dictionary of the amplifier gain values, keyed by amplifier name
        level : `str`
            Either `AMP` or `DETECTOR`
 
        Returns:
        --------
        scaledMaskedIms : `dict` [`str`, `lsst.afw.image.maskedImage.MaskedImageF`]
            Depending on level, this is either one item, or n_amp items,
            keyed by detectorId or ampName
 
        Notes:
        ------
        This function is controlled by the following config parameters:
        nPixBorderXCorr : `int`
            The number of border pixels to exclude
        nSigmaClipXCorr : `float`
            The number of sigma to be clipped to
        """
        assert(isinstance(exp, afwImage.ExposureF))
 
        local_exp = exp.clone()  # we don't want to modify the image passed in
        del exp  # ensure we don't make mistakes!
 
        border = self.config.nPixBorderXCorr
        sigma = self.config.nSigmaClipXCorr
 
        sctrl = afwMath.StatisticsControl()
        sctrl.setNumSigmaClip(sigma)
 
        means = {}
        returnAreas = {}
 
        detector = local_exp.getDetector()
        amps = detector.getAmplifiers()
 
        mi = local_exp.getMaskedImage()  # makeStatistics does not seem to take exposures
        temp = mi.clone()
 
        # Rescale each amp by the appropriate gain and subtract the mean.
        # NB these are views modifying the image in-place
        for amp in amps:
            ampName = amp.getName()
            rescaleIm = mi[amp.getBBox()]  # the soon-to-be scaled, mean subtracted, amp image
            rescaleTemp = temp[amp.getBBox()]
            mean = afwMath.makeStatistics(rescaleIm, afwMath.MEANCLIP, sctrl).getValue()
            gain = gains.gains[ampName]
            rescaleIm *= gain
            rescaleTemp *= gain
            self.log.debug("mean*gain = %s, clipped mean = %s" %
                           (mean*gain, afwMath.makeStatistics(rescaleIm, afwMath.MEANCLIP,
                                                              sctrl).getValue()))
            rescaleIm -= mean*gain
 
            if level == 'AMP':  # build the dicts if doing amp-wise
                means[ampName] = afwMath.makeStatistics(rescaleTemp[border: -border, border: -border,
                                                        afwImage.LOCAL], afwMath.MEANCLIP, sctrl).getValue()
                returnAreas[ampName] = rescaleIm
 
        if level == 'DETECTOR':  # else just average the whole detector
            detName = local_exp.getDetector().getId()
            means[detName] = afwMath.makeStatistics(temp[border: -border, border: -border, afwImage.LOCAL],
                                                    afwMath.MEANCLIP, sctrl).getValue()
            returnAreas[detName] = rescaleIm
 
        return returnAreas, means
 
    def _crossCorrelate(self, maskedIm0, maskedIm1, runningBiasCorrSim=False, frameId=None, detId=None):
        """Calculate the cross-correlation of an area.
 
        If the area in question contains multiple amplifiers then they must
        have been gain corrected.
 
        Parameters:
        -----------
        maskedIm0 : `lsst.afw.image.MaskedImageF`
            The first image area
        maskedIm1 : `lsst.afw.image.MaskedImageF`
            The first image area
        frameId : `str`, optional
            The frame identifier for use in the filename
            if writing debug outputs.
        detId : `str`, optional
            The detector identifier (detector, or detector+amp,
            depending on config.level) for use in the filename
            if writing debug outputs.
        runningBiasCorrSim : `bool`
            Set to true when using this function to calculate the amount of bias
            introduced by the sigma clipping. If False, the biasCorr parameter
            is divided by to remove the bias, but this is, of course, not
            appropriate when this is the parameter being measured.
 
        Returns:
        --------
        xcorr : `np.ndarray`
            The quarter-image cross-correlation
        mean : `float`
            The sum of the means of the input images,
            sigma-clipped, and with borders applied.
            This is used when using this function with simulations to calculate
            the biasCorr parameter.
 
        Notes:
        ------
        This function is controlled by the following config parameters:
        maxLag : `int`
            The maximum lag to use in the cross-correlation calculation
        nPixBorderXCorr : `int`
            The number of border pixels to exclude
        nSigmaClipXCorr : `float`
            The number of sigma to be clipped to
        biasCorr : `float`
            Parameter used to correct from the bias introduced
            by the sigma cuts.
        """
        maxLag = self.config.maxLag
        border = self.config.nPixBorderXCorr
        sigma = self.config.nSigmaClipXCorr
        biasCorr = self.config.biasCorr
 
        sctrl = afwMath.StatisticsControl()
        sctrl.setNumSigmaClip(sigma)
 
        mean = afwMath.makeStatistics(maskedIm0.getImage()[border: -border, border: -border, afwImage.LOCAL],
                                      afwMath.MEANCLIP, sctrl).getValue()
        mean += afwMath.makeStatistics(maskedIm1.getImage()[border: -border, border: -border, afwImage.LOCAL],
                                       afwMath.MEANCLIP, sctrl).getValue()
 
        # Diff the images, and apply border
        diff = maskedIm0.clone()
        diff -= maskedIm1.getImage()
        diff = diff[border: -border, border: -border, afwImage.LOCAL]
 
        if self.debug.writeDiffImages:
            filename = '_'.join(['diff', 'detector', detId, frameId, '.fits'])
            diff.writeFits(os.path.join(self.debug.debugDataPath, filename))
 
        # Subtract background.  It should be a constant, but it isn't always
        binsize = self.config.backgroundBinSize
        nx = diff.getWidth()//binsize
        ny = diff.getHeight()//binsize
        bctrl = afwMath.BackgroundControl(nx, ny, sctrl, afwMath.MEANCLIP)
        bkgd = afwMath.makeBackground(diff, bctrl)
        bgImg = bkgd.getImageF(afwMath.Interpolate.CUBIC_SPLINE, afwMath.REDUCE_INTERP_ORDER)
        bgMean = np.mean(bgImg.getArray())
        if abs(bgMean) >= self.config.backgroundWarnLevel:
            self.log.warn('Mean of background = %s > config.maxBackground' % bgMean)
 
        diff -= bgImg
 
        if self.debug.writeDiffImages:
            filename = '_'.join(['bgSub', 'diff', 'detector', detId, frameId, '.fits'])
            diff.writeFits(os.path.join(self.debug.debugDataPath, filename))
        if self.debug.display:
            self.disp1.mtv(diff, title=frameId)
 
        self.log.debug("Median and variance of diff:")
        self.log.debug("%s" % afwMath.makeStatistics(diff, afwMath.MEDIAN, sctrl).getValue())
        self.log.debug("%s, %s" % (afwMath.makeStatistics(diff, afwMath.VARIANCECLIP, sctrl).getValue(),
                                   np.var(diff.getImage().getArray())))
 
        # Measure the correlations
        dim0 = diff[0: -maxLag, : -maxLag, afwImage.LOCAL]
        dim0 -= afwMath.makeStatistics(dim0, afwMath.MEANCLIP, sctrl).getValue()
        width, height = dim0.getDimensions()
        xcorr = np.zeros((maxLag + 1, maxLag + 1), dtype=np.float64)
 
        for xlag in range(maxLag + 1):
            for ylag in range(maxLag + 1):
                dim_xy = diff[xlag:xlag + width, ylag: ylag + height, afwImage.LOCAL].clone()
                dim_xy -= afwMath.makeStatistics(dim_xy, afwMath.MEANCLIP, sctrl).getValue()
                dim_xy *= dim0
                xcorr[xlag, ylag] = afwMath.makeStatistics(dim_xy, afwMath.MEANCLIP, sctrl).getValue()
                if not runningBiasCorrSim:
                    xcorr[xlag, ylag] /= biasCorr
 
        # TODO: DM-15305 improve debug functionality here.
        # This is position 2 for the removed code.
 
        return xcorr, mean
 
    def estimateGains(self, dataRef, visitPairs):
        """Estimate the amplifier gains using the specified visits.
 
        Given a dataRef and list of flats of varying intensity,
        calculate the gain for each amplifier in the detector
        using the photon transfer curve (PTC) method.
 
        The config.fixPtcThroughOrigin option determines whether the iterative
        fitting is forced to go through the origin or not.
        This defaults to True, fitting var=1/gain * mean.
        If set to False then var=1/g * mean + const is fitted.
 
        This is really a photo transfer curve (PTC) gain measurement task.
        See DM-14063 for results from of a comparison between
        this task's numbers and the gain values in the HSC camera model,
        and those measured by the PTC task in eotest.
 
        Parameters
        ----------
        dataRef : `lsst.daf.persistence.butler.Butler.dataRef`
            dataRef for the detector for the flats to be used
        visitPairs : `list` of `tuple`
            List of visit-pairs to use, as [(v1,v2), (v3,v4)...]
 
        Returns
        -------
        gains : `lsst.cp.pipe.makeBrighterFatterKernel.BrighterFatterGain`
            Object holding the per-amplifier gains, essentially a
            dict of the as-calculated amplifier gain values, keyed by amp name
        nominalGains : `dict` [`str`, `float`]
            Dict of the amplifier gains, as reported by the `detector` object,
            keyed by amplifier name
        """
        # NB: don't use dataRef.get('raw_detector') due to composites
        detector = dataRef.get('camera')[dataRef.dataId[self.config.ccdKey]]
        amps = detector.getAmplifiers()
        ampNames = [amp.getName() for amp in amps]
 
        ampMeans = {key: [] for key in ampNames}  # these get turned into np.arrays later
        ampCoVariances = {key: [] for key in ampNames}
        ampVariances = {key: [] for key in ampNames}
 
        # Loop over the amps in the detector,
        # calculating a PTC for each amplifier.
        # The amplifier iteration is performed in _calcMeansAndVars()
        # NB: no gain correction is applied
        for visPairNum, visPair in enumerate(visitPairs):
            _means, _vars, _covars = self._calcMeansAndVars(dataRef, visPair[0], visPair[1])
 
            # Do sanity checks; if these are failed more investigation is needed
            breaker = 0
            for amp in detector:
                ampName = amp.getName()
                if _means[ampName]*10 < _vars[ampName] or _means[ampName]*10 < _covars[ampName]:
                    msg = 'Sanity check failed; check visit pair %s amp %s' % (visPair, ampName)
                    self.log.warn(msg)
                    breaker += 1
            if breaker:
                continue
 
            # having made sanity checks
            # pull the values out into the respective dicts
            for k in _means.keys():  # keys are necessarily the same
                if _vars[k]*1.3 < _covars[k] or _vars[k]*0.7 > _covars[k]:
                    self.log.warn('Dropped a value')
                    continue
                ampMeans[k].append(_means[k])
                ampVariances[k].append(_vars[k])
                ampCoVariances[k].append(_covars[k])
 
        gains = {}
        nomGains = {}
        ptcResults = {}
        for amp in detector:
            ampName = amp.getName()
            if ampMeans[ampName] == []:  # all the data was dropped, amp is presumed bad
                gains[ampName] = 1.0
                ptcResults[ampName] = (0, 0, 1, 0)
                continue
 
            nomGains[ampName] = amp.getGain()
            slopeRaw, interceptRaw, rVal, pVal, stdErr = \
                stats.linregress(np.asarray(ampMeans[ampName]), np.asarray(ampCoVariances[ampName]))
            slopeFix, _ = self._iterativeRegression(np.asarray(ampMeans[ampName]),
                                                    np.asarray(ampCoVariances[ampName]),
                                                    fixThroughOrigin=True)
            slopeUnfix, intercept = self._iterativeRegression(np.asarray(ampMeans[ampName]),
                                                              np.asarray(ampCoVariances[ampName]),
                                                              fixThroughOrigin=False)
            self.log.info("Slope of     raw fit: %s, intercept: %s p value: %s" % (slopeRaw,
                                                                                   interceptRaw, pVal))
            self.log.info("slope of   fixed fit: %s, difference vs raw:%s" % (slopeFix,
                                                                              slopeFix - slopeRaw))
            self.log.info("slope of unfixed fit: %s, difference vs fix:%s" % (slopeUnfix,
                                                                              slopeFix - slopeUnfix))
            if self.config.fixPtcThroughOrigin:
                slopeToUse = slopeFix
            else:
                slopeToUse = slopeUnfix
 
            if self.debug.enabled:
                fig = plt.figure()
                ax = fig.add_subplot(111)
                ax.plot(np.asarray(ampMeans[ampName]),
                        np.asarray(ampCoVariances[ampName]), linestyle='None', marker='x', label='data')
                if self.config.fixPtcThroughOrigin:
                    ax.plot(np.asarray(ampMeans[ampName]),
                            np.asarray(ampMeans[ampName])*slopeToUse, label='Fit through origin')
                else:
                    ax.plot(np.asarray(ampMeans[ampName]),
                            np.asarray(ampMeans[ampName])*slopeToUse + intercept,
                            label='Fit (intercept unconstrained')
 
                dataRef.put(fig, "plotBrighterFatterPtc", amp=ampName)
                self.log.info('Saved PTC for detector %s amp %s' % (detector.getId(), ampName))
            gains[ampName] = 1.0/slopeToUse
            # change the fit to use a cubic and match parameters with Lage method
            # or better, use the PTC task here too
            ptcResults[ampName] = (0, 0, 1, 0)
 
        return BrighterFatterGain(gains, ptcResults), nomGains
 
    def _calcMeansAndVars(self, dataRef, v1, v2):
        """Calculate the means, vars, covars, and retrieve the nominal gains,
        for each amp in each detector.
 
        This code runs using two visit numbers, and for the detector specified.
        It calculates the correlations in the individual amps without
        rescaling any gains. This allows a photon transfer curve
        to be generated and the gains measured.
 
        Images are assembled with use the isrTask, and basic isr is performed.
 
        Parameters:
        -----------
        dataRef : `lsst.daf.persistence.butler.Butler.dataRef`
            dataRef for the detector for the repo containing the flats to be used
        v1 : `int`
            First visit of the visit pair
        v2 : `int`
            Second visit of the visit pair
 
        Returns
        -------
        means, vars, covars : `tuple` of `dict`
            Three dicts, keyed by ampName,
            containing the sum of the image-means,
            the variance, and the quarter-image of the xcorr.
        """
        sigma = self.config.nSigmaClipGainCalc
        maxLag = self.config.maxLag
        border = self.config.nPixBorderGainCalc
        biasCorr = self.config.biasCorr
 
        # NB: don't use dataRef.get('raw_detector') due to composites
        detector = dataRef.get('camera')[dataRef.dataId[self.config.ccdKey]]
 
        ampMeans = {}
 
        # manipulate the dataId to get a postISR exposure for each visit
        # from the detector obj, restoring its original state afterwards
        originalDataId = dataRef.dataId.copy()
        dataRef.dataId['expId'] = v1
        exp1 = self.isr.runDataRef(dataRef).exposure
        dataRef.dataId['expId'] = v2
        exp2 = self.isr.runDataRef(dataRef).exposure
        dataRef.dataId = originalDataId
        exps = [exp1, exp2]
        checkExpLengthEqual(exp1, exp2, v1, v2, raiseWithMessage=True)
 
        detector = exps[0].getDetector()
        ims = [self._convertImagelikeToFloatImage(exp) for exp in exps]
 
        if self.debug.display:
            self.disp1.mtv(ims[0], title=str(v1))
            self.disp2.mtv(ims[1], title=str(v2))
 
        sctrl = afwMath.StatisticsControl()
        sctrl.setNumSigmaClip(sigma)
        for imNum, im in enumerate(ims):
 
            # calculate the sigma-clipped mean, excluding the borders
            # safest to apply borders to all amps regardless of edges
            # easier, camera-agnostic, and mitigates potentially dodgy
            # overscan-biases around edges as well
            for amp in detector:
                ampName = amp.getName()
                ampIm = im[amp.getBBox()]
                mean = afwMath.makeStatistics(ampIm[border: -border, border: -border, afwImage.LOCAL],
                                              afwMath.MEANCLIP, sctrl).getValue()
                if ampName not in ampMeans.keys():
                    ampMeans[ampName] = []
                ampMeans[ampName].append(mean)
                ampIm -= mean
 
        diff = ims[0].clone()
        diff -= ims[1]
 
        temp = diff[border: -border, border: -border, afwImage.LOCAL]
 
        # Subtract background. It should be a constant,
        # but it isn't always (e.g. some SuprimeCam flats)
        # TODO: Check how this looks, and if this is the "right" way to do this
        binsize = self.config.backgroundBinSize
        nx = temp.getWidth()//binsize
        ny = temp.getHeight()//binsize
        bctrl = afwMath.BackgroundControl(nx, ny, sctrl, afwMath.MEANCLIP)
        bkgd = afwMath.makeBackground(temp, bctrl)
 
        box = diff.getBBox()
        box.grow(-border)
        diff[box, afwImage.LOCAL] -= bkgd.getImageF(afwMath.Interpolate.CUBIC_SPLINE,
                                                    afwMath.REDUCE_INTERP_ORDER)
 
        variances = {}
        coVars = {}
        for amp in detector:
            ampName = amp.getName()
            diffAmpIm = diff[amp.getBBox()].clone()
            diffAmpImCrop = diffAmpIm[border: -border - maxLag, border: -border - maxLag, afwImage.LOCAL]
            diffAmpImCrop -= afwMath.makeStatistics(diffAmpImCrop, afwMath.MEANCLIP, sctrl).getValue()
            w, h = diffAmpImCrop.getDimensions()
            xcorr = np.zeros((maxLag + 1, maxLag + 1), dtype=np.float64)
 
            # calculate the cross-correlation
            for xlag in range(maxLag + 1):
                for ylag in range(maxLag + 1):
                    dim_xy = diffAmpIm[border + xlag: border + xlag + w,
                                       border + ylag: border + ylag + h,
                                       afwImage.LOCAL].clone()
                    dim_xy -= afwMath.makeStatistics(dim_xy, afwMath.MEANCLIP, sctrl).getValue()
                    dim_xy *= diffAmpImCrop
                    xcorr[xlag, ylag] = afwMath.makeStatistics(dim_xy,
                                                               afwMath.MEANCLIP, sctrl).getValue()/(biasCorr)
 
            variances[ampName] = xcorr[0, 0]
            xcorr_full = self._tileArray(xcorr)
            coVars[ampName] = np.sum(xcorr_full)
 
            msg = "M1: " + str(ampMeans[ampName][0])
            msg += " M2 " + str(ampMeans[ampName][1])
            msg += " M_sum: " + str((ampMeans[ampName][0]) + ampMeans[ampName][1])
            msg += " Var " + str(variances[ampName])
            msg += " coVar: " + str(coVars[ampName])
            self.log.debug(msg)
 
            means = {}
            for amp in detector:
                ampName = amp.getName()
                means[ampName] = ampMeans[ampName][0] + ampMeans[ampName][1]
 
        return means, variances, coVars
 
    def _plotXcorr(self, xcorr, mean, zmax=0.05, title=None, fig=None, saveToFileName=None):
        """Plot the correlation functions."""
        try:
            xcorr = xcorr.getArray()
        except Exception:
            pass
 
        xcorr /= float(mean)
        # xcorr.getArray()[0,0]=abs(xcorr.getArray()[0,0]-1)
 
        if fig is None:
            fig = plt.figure()
        else:
            fig.clf()
 
        ax = fig.add_subplot(111, projection='3d')
        ax.azim = 30
        ax.elev = 20
 
        nx, ny = np.shape(xcorr)
 
        xpos, ypos = np.meshgrid(np.arange(nx), np.arange(ny))
        xpos = xpos.flatten()
        ypos = ypos.flatten()
        zpos = np.zeros(nx*ny)
        dz = xcorr.flatten()
        dz[dz > zmax] = zmax
 
        ax.bar3d(xpos, ypos, zpos, 1, 1, dz, color='b', zsort='max', sort_zpos=100)
        if xcorr[0, 0] > zmax:
            ax.bar3d([0], [0], [zmax], 1, 1, 1e-4, color='c')
 
        ax.set_xlabel("row")
        ax.set_ylabel("column")
        ax.set_zlabel(r"$\langle{(F_i - \bar{F})(F_i - \bar{F})}\rangle/\bar{F}$")
 
        if title:
            fig.suptitle(title)
        if saveToFileName:
            fig.savefig(saveToFileName)
 
    def _iterativeRegression(self, x, y, fixThroughOrigin=False, nSigmaClip=None, maxIter=None):
        """Use linear regression to fit a line, iteratively removing outliers.
 
        Useful when you have a sufficiently large numbers of points on your PTC.
        This function iterates until either there are no outliers of
        config.nSigmaClip magnitude, or until the specified maximum number
        of iterations has been performed.
 
        Parameters:
        -----------
        x : `numpy.array`
            The independent variable. Must be a numpy array, not a list.
        y : `numpy.array`
            The dependent variable. Must be a numpy array, not a list.
        fixThroughOrigin : `bool`, optional
            Whether to fix the PTC through the origin or allow an y-intercept.
        nSigmaClip : `float`, optional
            The number of sigma to clip to.
            Taken from the task config if not specified.
        maxIter : `int`, optional
            The maximum number of iterations allowed.
            Taken from the task config if not specified.
 
        Returns:
        --------
        slope : `float`
            The slope of the line of best fit
        intercept : `float`
            The y-intercept of the line of best fit
        """
        if not maxIter:
            maxIter = self.config.maxIterRegression
        if not nSigmaClip:
            nSigmaClip = self.config.nSigmaClipRegression
 
        nIter = 0
        sctrl = afwMath.StatisticsControl()
        sctrl.setNumSigmaClip(nSigmaClip)
 
        if fixThroughOrigin:
            while nIter < maxIter:
                nIter += 1
                self.log.debug("Origin fixed, iteration # %s using %s elements:" % (nIter, np.shape(x)[0]))
                TEST = x[:, np.newaxis]
                slope, _, _, _ = np.linalg.lstsq(TEST, y)
                slope = slope[0]
                res = (y - slope * x) / x
                resMean = afwMath.makeStatistics(res, afwMath.MEANCLIP, sctrl).getValue()
                resStd = np.sqrt(afwMath.makeStatistics(res, afwMath.VARIANCECLIP, sctrl).getValue())
                index = np.where((res > (resMean + nSigmaClip*resStd)) |
                                 (res < (resMean - nSigmaClip*resStd)))
                self.log.debug("%.3f %.3f %.3f %.3f" % (resMean, resStd, np.max(res), nSigmaClip))
                if np.shape(np.where(index))[1] == 0 or (nIter >= maxIter):  # run out of points or iters
                    break
                x = np.delete(x, index)
                y = np.delete(y, index)
 
            return slope, 0
 
        while nIter < maxIter:
            nIter += 1
            self.log.debug("Iteration # %s using %s elements:" % (nIter, np.shape(x)[0]))
            xx = np.vstack([x, np.ones(len(x))]).T
            ret, _, _, _ = np.linalg.lstsq(xx, y)
            slope, intercept = ret
            res = y - slope*x - intercept
            resMean = afwMath.makeStatistics(res, afwMath.MEANCLIP, sctrl).getValue()
            resStd = np.sqrt(afwMath.makeStatistics(res, afwMath.VARIANCECLIP, sctrl).getValue())
            index = np.where((res > (resMean + nSigmaClip * resStd)) | (res < resMean - nSigmaClip * resStd))
            self.log.debug("%.3f %.3f %.3f %.3f" % (resMean, resStd, np.max(res), nSigmaClip))
            if np.shape(np.where(index))[1] == 0 or (nIter >= maxIter):  # run out of points, or iterations
                break
            x = np.delete(x, index)
            y = np.delete(y, index)
 
        return slope, intercept
 
    def generateKernel(self, corrs, means, objId, rejectLevel=None):
        """Generate the full kernel from a list of cross-correlations and means.
 
        Taking a list of quarter-image, gain-corrected cross-correlations,
        do a pixel-wise sigma-clipped mean of each,
        and tile into the full-sized kernel image.
 
        Each corr in corrs is one quarter of the full cross-correlation,
        and has been gain-corrected. Each mean in means is a tuple of the means
        of the two individual images, corresponding to that corr.
 
        Parameters:
        -----------
        corrs : `list` of `numpy.ndarray`, (Ny, Nx)
            A list of the quarter-image cross-correlations
        means : `list` of `tuples` of `floats`
            The means of the input images for each corr in corrs
        rejectLevel : `float`, optional
            This is essentially is a sanity check parameter.
            If this condition is violated there is something unexpected
            going on in the image, and it is discarded from the stack before
            the clipped-mean is calculated.
            If not provided then config.xcorrCheckRejectLevel is used
 
        Returns:
        --------
        kernel : `numpy.ndarray`, (Ny, Nx)
            The output kernel
        """
        self.log.info('Calculating kernel for %s'%objId)
 
        if not rejectLevel:
            rejectLevel = self.config.xcorrCheckRejectLevel
 
        if self.config.correlationQuadraticFit:
            xcorrList = []
            fluxList = []
 
            for corrNum, ((mean1, mean2), corr) in enumerate(zip(means, corrs)):
                msg = 'For item %s, initial corr[0,0] = %g, corr[1,0] = %g'%(corrNum, corr[0, 0], corr[1, 0])
                self.log.info(msg)
                if self.config.level == 'DETECTOR':
                    #  This is now done in _applyGains() but only if level is not DETECTOR
                    corr[0, 0] -= (mean1 + mean2)
                fullCorr = self._tileArray(corr)
 
                # Craig Lage says he doesn't understand the negative sign, but it needs to be there
                xcorrList.append(-fullCorr / 2.0)
                flux = (mean1 + mean2) / 2.0
                fluxList.append(flux * flux)
                # We're using the linear fit algorithm to find a quadratic fit,
                # so we square the x-axis.
                # The step below does not need to be done, but is included
                # so that correlations can be compared
                # directly to existing code.  We might want to take it out.
                corr /= -1.0*(mean1**2 + mean2**2)
 
            if not xcorrList:
                raise RuntimeError("Cannot generate kernel because all inputs were discarded. "
                                   "Either the data is bad, or config.xcorrCheckRejectLevel is too low")
 
            # This method fits a quadratic vs flux and keeps only the quadratic term.
            meanXcorr = np.zeros_like(fullCorr)
            xcorrList = np.asarray(xcorrList)
 
            for i in range(np.shape(meanXcorr)[0]):
                for j in range(np.shape(meanXcorr)[1]):
                    # Note the i,j inversion.  This serves the same function as the transpose step in
                    # the base code.  I don't understand why it is there, but I put it in to be consistent.
                    slopeRaw, interceptRaw, rVal, pVal, stdErr = stats.linregress(np.asarray(fluxList),
                                                                                  xcorrList[:, j, i])
                    try:
                        slope, intercept = self._iterativeRegression(np.asarray(fluxList),
                                                                     xcorrList[:, j, i],
                                                                     fixThroughOrigin=True)
                        msg = "(%s,%s):Slope of raw fit: %s, intercept: %s p value: %s" % (i, j, slopeRaw,
                                                                                           interceptRaw, pVal)
                        self.log.debug(msg)
                        self.log.debug("(%s,%s):Slope of fixed fit: %s" % (i, j, slope))
 
                        meanXcorr[i, j] = slope
                    except ValueError:
                        meanXcorr[i, j] = slopeRaw
 
                    msg = f"i={i}, j={j}, slope = {slope:.6g}, slopeRaw = {slopeRaw:.6g}"
                    self.log.debug(msg)
            self.log.info('Quad Fit meanXcorr[0,0] = %g, meanXcorr[1,0] = %g'%(meanXcorr[8, 8],
                                                                               meanXcorr[9, 8]))
 
        else:
            # Try to average over a set of possible inputs.
            # This generates a simple function of the kernel that
            # should be constant across the images, and averages that.
            xcorrList = []
            sctrl = afwMath.StatisticsControl()
            sctrl.setNumSigmaClip(self.config.nSigmaClipKernelGen)
 
            for corrNum, ((mean1, mean2), corr) in enumerate(zip(means, corrs)):
                corr[0, 0] -= (mean1 + mean2)
                if corr[0, 0] > 0:
                    self.log.warn('Skipped item %s due to unexpected value of (variance-mean)' % corrNum)
                    continue
                corr /= -1.0*(mean1**2 + mean2**2)
 
                fullCorr = self._tileArray(corr)
 
                xcorrCheck = np.abs(np.sum(fullCorr))/np.sum(np.abs(fullCorr))
                if xcorrCheck > rejectLevel:
                    self.log.warn("Sum of the xcorr is unexpectedly high. Investigate item num %s for %s. \n"
                                  "value = %s" % (corrNum, objId, xcorrCheck))
                    continue
                xcorrList.append(fullCorr)
 
            if not xcorrList:
                raise RuntimeError("Cannot generate kernel because all inputs were discarded. "
                                   "Either the data is bad, or config.xcorrCheckRejectLevel is too low")
 
            # stack the individual xcorrs and apply a per-pixel clipped-mean
            meanXcorr = np.zeros_like(fullCorr)
            xcorrList = np.transpose(xcorrList)
            for i in range(np.shape(meanXcorr)[0]):
                for j in range(np.shape(meanXcorr)[1]):
                    meanXcorr[i, j] = afwMath.makeStatistics(xcorrList[i, j],
                                                             afwMath.MEANCLIP, sctrl).getValue()
 
        if self.config.correlationModelRadius < (meanXcorr.shape[0] - 1) / 2:
            sumToInfinity = self._buildCorrelationModel(meanXcorr, self.config.correlationModelRadius,
                                                        self.config.correlationModelSlope)
            self.log.info("SumToInfinity = %s" % sumToInfinity)
        else:
            sumToInfinity = 0.0
        if self.config.forceZeroSum:
            self.log.info("Forcing sum of correlation matrix to zero")
            meanXcorr = self._forceZeroSum(meanXcorr, sumToInfinity)
 
        return meanXcorr, self.successiveOverRelax(meanXcorr)
 
    def successiveOverRelax(self, source, maxIter=None, eLevel=None):
        """An implementation of the successive over relaxation (SOR) method.
 
        A numerical method for solving a system of linear equations
        with faster convergence than the Gauss-Seidel method.
 
        Parameters:
        -----------
        source : `numpy.ndarray`
            The input array.
        maxIter : `int`, optional
            Maximum number of iterations to attempt before aborting.
        eLevel : `float`, optional
            The target error level at which we deem convergence to have
        occurred.
 
        Returns:
        --------
        output : `numpy.ndarray`
            The solution.
        """
        if not maxIter:
            maxIter = self.config.maxIterSuccessiveOverRelaxation
        if not eLevel:
            eLevel = self.config.eLevelSuccessiveOverRelaxation
 
        assert source.shape[0] == source.shape[1], "Input array must be square"
        # initialize, and set boundary conditions
        func = np.zeros([source.shape[0] + 2, source.shape[1] + 2])
        resid = np.zeros([source.shape[0] + 2, source.shape[1] + 2])
        rhoSpe = np.cos(np.pi/source.shape[0])  # Here a square grid is assumed
 
        # Calculate the initial error
        for i in range(1, func.shape[0] - 1):
            for j in range(1, func.shape[1] - 1):
                resid[i, j] = (func[i, j - 1] + func[i, j + 1] + func[i - 1, j] +
                               func[i + 1, j] - 4*func[i, j] - source[i - 1, j - 1])
        inError = np.sum(np.abs(resid))
 
        # Iterate until convergence
        # We perform two sweeps per cycle,
        # updating 'odd' and 'even' points separately
        nIter = 0
        omega = 1.0
        dx = 1.0
        while nIter < maxIter*2:
            outError = 0
            if nIter%2 == 0:
                for i in range(1, func.shape[0] - 1, 2):
                    for j in range(1, func.shape[1] - 1, 2):
                        resid[i, j] = float(func[i, j-1] + func[i, j + 1] + func[i - 1, j] +
                                            func[i + 1, j] - 4.0*func[i, j] - dx*dx*source[i - 1, j - 1])
                        func[i, j] += omega*resid[i, j]*.25
                for i in range(2, func.shape[0] - 1, 2):
                    for j in range(2, func.shape[1] - 1, 2):
                        resid[i, j] = float(func[i, j - 1] + func[i, j + 1] + func[i - 1, j] +
                                            func[i + 1, j] - 4.0*func[i, j] - dx*dx*source[i - 1, j - 1])
                        func[i, j] += omega*resid[i, j]*.25
            else:
                for i in range(1, func.shape[0] - 1, 2):
                    for j in range(2, func.shape[1] - 1, 2):
                        resid[i, j] = float(func[i, j - 1] + func[i, j + 1] + func[i - 1, j] +
                                            func[i + 1, j] - 4.0*func[i, j] - dx*dx*source[i - 1, j - 1])
                        func[i, j] += omega*resid[i, j]*.25
                for i in range(2, func.shape[0] - 1, 2):
                    for j in range(1, func.shape[1] - 1, 2):
                        resid[i, j] = float(func[i, j - 1] + func[i, j + 1] + func[i - 1, j] +
                                            func[i + 1, j] - 4.0*func[i, j] - dx*dx*source[i - 1, j - 1])
                        func[i, j] += omega*resid[i, j]*.25
            outError = np.sum(np.abs(resid))
            if outError < inError*eLevel:
                break
            if nIter == 0:
                omega = 1.0/(1 - rhoSpe*rhoSpe/2.0)
            else:
                omega = 1.0/(1 - rhoSpe*rhoSpe*omega/4.0)
            nIter += 1
 
        if nIter >= maxIter*2:
            self.log.warn("Failure: SuccessiveOverRelaxation did not converge in %s iterations."
                          "\noutError: %s, inError: %s," % (nIter//2, outError, inError*eLevel))
        else:
            self.log.info("Success: SuccessiveOverRelaxation converged in %s iterations."
                          "\noutError: %s, inError: %s", nIter//2, outError, inError*eLevel)
        return func[1: -1, 1: -1]
 
    @staticmethod
    def _tileArray(in_array):
        """Given an input quarter-image, tile/mirror it and return full image.
 
        Given a square input of side-length n, of the form
 
        input = array([[1, 2, 3],
                       [4, 5, 6],
                       [7, 8, 9]])
 
        return an array of size 2n-1 as
 
        output = array([[ 9,  8,  7,  8,  9],
                        [ 6,  5,  4,  5,  6],
                        [ 3,  2,  1,  2,  3],
                        [ 6,  5,  4,  5,  6],
                        [ 9,  8,  7,  8,  9]])
 
        Parameters:
        -----------
        input : `np.array`
            The square input quarter-array
 
        Returns:
        --------
        output : `np.array`
            The full, tiled array
        """
        assert(in_array.shape[0] == in_array.shape[1])
        length = in_array.shape[0] - 1
        output = np.zeros((2*length + 1, 2*length + 1))
 
        for i in range(length + 1):
            for j in range(length + 1):
                output[i + length, j + length] = in_array[i, j]
                output[-i + length, j + length] = in_array[i, j]
                output[i + length, -j + length] = in_array[i, j]
                output[-i + length, -j + length] = in_array[i, j]
        return output
 
    @staticmethod
    def _forceZeroSum(inputArray, sumToInfinity):
        """Given an array of correlations, adjust the
        central value to force the sum of the array to be zero.
 
        Parameters:
        -----------
        input : `np.array`
            The square input array, assumed square and with
            shape (2n+1) x (2n+1)
 
        Returns:
        --------
        output : `np.array`
            The same array, with the value of the central value
            inputArray[n,n] adjusted to force the array sum to be zero.
        """
        assert(inputArray.shape[0] == inputArray.shape[1])
        assert(inputArray.shape[0] % 2 == 1)
        center = int((inputArray.shape[0] - 1) / 2)
        outputArray = np.copy(inputArray)
        outputArray[center, center] -= inputArray.sum() - sumToInfinity
        return outputArray
 
    @staticmethod
    def _buildCorrelationModel(array, replacementRadius, slope):
        """Given an array of correlations, build a model
        for correlations beyond replacementRadius pixels from the center
        and replace the measured values with the model.
 
        Parameters:
        -----------
        input : `np.array`
            The square input array, assumed square and with
            shape (2n+1) x (2n+1)
 
        Returns:
        --------
        output : `np.array`
            The same array, with the outer values
            replaced with a smoothed model.
        """
        assert(array.shape[0] == array.shape[1])
        assert(array.shape[0] % 2 == 1)
        assert(replacementRadius > 1)
        center = int((array.shape[0] - 1) / 2)
        # First we check if either the [0,1] or [1,0] correlation is positive.
        # If so, the data is seriously messed up. This has happened in some bad amplifiers.
        # In this case, we just return the input array unchanged.
        if (array[center, center + 1] >= 0.0) or (array[center + 1, center] >= 0.0):
            return 0.0
 
        intercept = (np.log10(-array[center, center + 1]) + np.log10(-array[center + 1, center])) / 2.0
        preFactor = 10**intercept
        slopeFactor = 2.0*abs(slope) - 2.0
        sumToInfinity = 2.0*np.pi*preFactor / (slopeFactor*(float(center)+0.5)**slopeFactor)
        # sum_to_ininity is the integral of the model beyond what is measured.
        # It is used to adjust C00 in the case of forcing zero sum
 
        # Now replace the pixels beyond replacementRadius with the model values
        for i in range(array.shape[0]):
            for j in range(array.shape[1]):
                r2 = float((i-center)*(i-center) + (j-center)*(j-center))
                if abs(i-center) < replacementRadius and abs(j-center) < replacementRadius:
                    continue
                else:
                    newCvalue = -preFactor * r2**slope
                    array[i, j] = newCvalue
        return sumToInfinity
 
    @staticmethod
    def _convertImagelikeToFloatImage(imagelikeObject):
        """Turn an exposure or masked image of any type into an ImageF."""
        for attr in ("getMaskedImage", "getImage"):
            if hasattr(imagelikeObject, attr):
                imagelikeObject = getattr(imagelikeObject, attr)()
        try:
            floatImage = imagelikeObject.convertF()
        except AttributeError:
            raise RuntimeError("Failed to convert image to float")
        return floatImage
 
 
def calcBiasCorr(fluxLevels, imageShape, repeats=1, seed=0, addCorrelations=False,
                 correlationStrength=0.1, maxLag=10, nSigmaClip=5, border=10, logger=None):
    """Calculate the bias induced when sigma-clipping non-Gaussian distributions.
 
    Fill image-pairs of the specified size with Poisson-distributed values,
    adding correlations as necessary. Then calculate the cross correlation,
    and calculate the bias induced using the cross-correlation image
    and the image means.
 
    Parameters:
    -----------
    fluxLevels : `list` of `int`
        The mean flux levels at which to simulate.
        Nominal values might be something like [70000, 90000, 110000]
    imageShape : `tuple` of `int`
        The shape of the image array to simulate, nx by ny pixels.
    repeats : `int`, optional
        Number of repeats to perform so that results
        can be averaged to improve SNR.
    seed : `int`, optional
        The random seed to use for the Poisson points.
    addCorrelations : `bool`, optional
        Whether to add brighter-fatter-like correlations to the simulated images
        If true, a correlation between x_{i,j} and x_{i+1,j+1} is introduced
        by adding a*x_{i,j} to x_{i+1,j+1}
    correlationStrength : `float`, optional
        The strength of the correlations.
        This is the value of the coefficient `a` in the above definition.
    maxLag : `int`, optional
        The maximum lag to work to in pixels
    nSigmaClip : `float`, optional
        Number of sigma to clip to when calculating the sigma-clipped mean.
    border : `int`, optional
        Number of border pixels to mask
    logger : `lsst.log.Log`, optional
        Logger to use. Instantiated anew if not provided.
 
    Returns:
    --------
    biases : `dict` [`float`, `list` of `float`]
        A dictionary, keyed by flux level, containing a list of the biases
        for each repeat at that flux level
    means : `dict` [`float`, `list` of `float`]
        A dictionary, keyed by flux level, containing a list of the average
        mean fluxes (average of the mean of the two images)
        for the image pairs at that flux level
    xcorrs : `dict` [`float`, `list` of `np.ndarray`]
        A dictionary, keyed by flux level, containing a list of the xcorr
        images for the image pairs at that flux level
    """
    if logger is None:
        logger = lsstLog.Log.getDefaultLogger()
 
    means = {f: [] for f in fluxLevels}
    xcorrs = {f: [] for f in fluxLevels}
    biases = {f: [] for f in fluxLevels}
 
    config = MakeBrighterFatterKernelTaskConfig()
    config.isrMandatorySteps = []  # no isr but the validation routine is still run
    config.isrForbiddenSteps = []
    config.nSigmaClipXCorr = nSigmaClip
    config.nPixBorderXCorr = border
    config.maxLag = maxLag
    task = MakeBrighterFatterKernelTask(config=config)
 
    im0 = afwImage.maskedImage.MaskedImageF(imageShape[1], imageShape[0])
    im1 = afwImage.maskedImage.MaskedImageF(imageShape[1], imageShape[0])
 
    random = np.random.RandomState(seed)
 
    for rep in range(repeats):
        for flux in fluxLevels:
            data0 = random.poisson(flux, (imageShape)).astype(float)
            data1 = random.poisson(flux, (imageShape)).astype(float)
            if addCorrelations:
                data0[1:, 1:] += correlationStrength*data0[: -1, : -1]
                data1[1:, 1:] += correlationStrength*data1[: -1, : -1]
            im0.image.array[:, :] = data0
            im1.image.array[:, :] = data1
 
            _xcorr, _means = task._crossCorrelate(im0, im1, runningBiasCorrSim=True)
 
            means[flux].append(_means)
            xcorrs[flux].append(_xcorr)
            if addCorrelations:
                bias = xcorrs[flux][-1][1, 1]/means[flux][-1]*(1 + correlationStrength)/correlationStrength
                msg = f"Simulated/expected avg. flux: {flux:.1f}, {(means[flux][-1]/2):.1f}"
                logger.info(msg)
                logger.info(f"Bias: {bias:.6f}")
            else:
                bias = xcorrs[flux][-1][0, 0]/means[flux][-1]
                msg = f"Simulated/expected avg. flux: {flux:.1f}, {(means[flux][-1]/2):.1f}"
                logger.info(msg)
                logger.info(f"Bias: {bias:.6f}")
            biases[flux].append(bias)
 
    return biases, means, xcorrs