KernelCandidate.cc

Go to the documentation of this file.

// -*- lsst-c++ -*-
#include "boost/timer.hpp"

#include "lsst/afw/math.h"
#include "lsst/afw/image.h"
#include "lsst/log/Log.h"
#include "lsst/pex/exceptions/Runtime.h"

#include "lsst/ip/diffim/KernelCandidate.h"
#include "lsst/ip/diffim/ImageSubtract.h"
#include "lsst/ip/diffim/ImageStatistics.h"
#include "lsst/ip/diffim/KernelSolution.h"

namespace afwMath = lsst::afw::math;
namespace afwImage = lsst::afw::image;
namespace pexExcept = lsst::pex::exceptions;

namespace lsst {
namespace ip {
namespace diffim {

template <typename PixelT>
KernelCandidate<PixelT>::KernelCandidate(float const xCenter, float const yCenter,
                                         MaskedImagePtr const& templateMaskedImage,
                                         MaskedImagePtr const& scienceMaskedImage,
                                         lsst::daf::base::PropertySet const& ps)
        : lsst::afw::math::SpatialCellImageCandidate(xCenter, yCenter),
          _templateMaskedImage(templateMaskedImage),
          _scienceMaskedImage(scienceMaskedImage),
          _varianceEstimate(),
          _ps(ps.deepCopy()),
          _source(),
          _coreFlux(),
          _isInitialized(false),
          _useRegularization(false),
          _fitForBackground(ps.getAsBool("fitForBackground")),
          _kernelSolutionOrig(),
          _kernelSolutionPca() {
    /* Rank by mean core S/N in science image */
    ImageStatistics<PixelT> imstats(ps);
    int candidateCoreRadius = _ps->getAsInt("candidateCoreRadius");
    try {
        imstats.apply(*_scienceMaskedImage, candidateCoreRadius);
    } catch (pexExcept::Exception& e) {
        LOGL_DEBUG("TRACE2.ip.diffim.KernelCandidate",
                   "Unable to calculate core imstats for ranking Candidate %d", this->getId());
        this->setStatus(afwMath::SpatialCellCandidate::BAD);
        return;
    }

    _coreFlux = imstats.getMean();
    LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate", "Candidate %d at %.2f %.2f with ranking %.2f",
               this->getId(), this->getXCenter(), this->getYCenter(), _coreFlux);
}

template <typename PixelT>
KernelCandidate<PixelT>::KernelCandidate(SourcePtr const& source, MaskedImagePtr const& templateMaskedImage,
                                         MaskedImagePtr const& scienceMaskedImage,
                                         lsst::daf::base::PropertySet const& ps)
        : lsst::afw::math::SpatialCellImageCandidate(source->getX(), source->getY()),
          _templateMaskedImage(templateMaskedImage),
          _scienceMaskedImage(scienceMaskedImage),
          _varianceEstimate(),
          _ps(ps.deepCopy()),
          _source(source),
          _coreFlux(source->getPsfInstFlux()),
          _isInitialized(false),
          _useRegularization(false),
          _fitForBackground(ps.getAsBool("fitForBackground")),
          _kernelSolutionOrig(),
          _kernelSolutionPca() {
    LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate", "Candidate %d at %.2f %.2f with ranking %.2f",
               this->getId(), this->getXCenter(), this->getYCenter(), _coreFlux);
}

template <typename PixelT>
void KernelCandidate<PixelT>::build(lsst::afw::math::KernelList const& basisList) {
    build(basisList, Eigen::MatrixXd());
}

template <typename PixelT>
void KernelCandidate<PixelT>::build(lsst::afw::math::KernelList const& basisList,
                                    Eigen::MatrixXd const& hMat) {
    /* Examine the property set for control over the variance estimate */
    afwImage::Image<afwImage::VariancePixel> var =
            afwImage::Image<afwImage::VariancePixel>(*(_scienceMaskedImage->getVariance()), true);
    /* Variance estimate comes from sum of image variances */
    var += (*(_templateMaskedImage->getVariance()));

    if (_ps->getAsBool("constantVarianceWeighting")) {
        /* Constant variance weighting */
        afwMath::Statistics varStats = afwMath::makeStatistics(var, afwMath::MEDIAN);
        float varValue;
        if (varStats.getValue(afwMath::MEDIAN) <= 0.0)
            varValue = 1.0;
        else
            varValue = varStats.getValue(afwMath::MEDIAN);
        LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate", "Candidate %d using constant variance of %.2f",
                   this->getId(), varValue);
        var = varValue;
    }

    _varianceEstimate = VariancePtr(new afwImage::Image<afwImage::VariancePixel>(var));

    try {
        _buildKernelSolution(basisList, hMat);
    } catch (pexExcept::Exception& e) {
        throw e;
    }

    if (_ps->getAsBool("iterateSingleKernel") && (!(_ps->getAsBool("constantVarianceWeighting")))) {
        afwImage::MaskedImage<PixelT> diffim = getDifferenceImage(KernelCandidate::RECENT);
        _varianceEstimate = diffim.getVariance();

        try {
            _buildKernelSolution(basisList, hMat);
        } catch (pexExcept::Exception& e) {
            throw e;
        }
    }

    _isInitialized = true;
}

template <typename PixelT>
void KernelCandidate<PixelT>::_buildKernelSolution(lsst::afw::math::KernelList const& basisList,
                                                   Eigen::MatrixXd const& hMat) {
    bool checkConditionNumber = _ps->getAsBool("checkConditionNumber");
    double maxConditionNumber = _ps->getAsDouble("maxConditionNumber");
    std::string conditionNumberType = _ps->getAsString("conditionNumberType");
    KernelSolution::ConditionNumberType ctype;
    if (conditionNumberType == "SVD") {
        ctype = KernelSolution::SVD;
    } else if (conditionNumberType == "EIGENVALUE") {
        ctype = KernelSolution::EIGENVALUE;
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "conditionNumberType not recognized");
    }

    /* Do we have a regularization matrix?  If so use it */
    if (hMat.size() > 0) {
        _useRegularization = true;
        LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate.build", "Using kernel regularization");

        if (_isInitialized) {
            _kernelSolutionPca = std::shared_ptr<StaticKernelSolution<PixelT> >(
                    new RegularizedKernelSolution<PixelT>(basisList, _fitForBackground, hMat, *_ps));
            _kernelSolutionPca->build(*(_templateMaskedImage->getImage()), *(_scienceMaskedImage->getImage()),
                                      *_varianceEstimate);
            if (checkConditionNumber) {
                if (_kernelSolutionPca->getConditionNumber(ctype) > maxConditionNumber) {
                    LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate",
                               "Candidate %d solution has bad condition number", this->getId());
                    this->setStatus(afwMath::SpatialCellCandidate::BAD);
                    return;
                }
            }
            _kernelSolutionPca->solve();
        } else {
            _kernelSolutionOrig = std::shared_ptr<StaticKernelSolution<PixelT> >(
                    new RegularizedKernelSolution<PixelT>(basisList, _fitForBackground, hMat, *_ps));
            _kernelSolutionOrig->build(*(_templateMaskedImage->getImage()),
                                       *(_scienceMaskedImage->getImage()), *_varianceEstimate);
            if (checkConditionNumber) {
                if (_kernelSolutionOrig->getConditionNumber(ctype) > maxConditionNumber) {
                    LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate",
                               "Candidate %d solution has bad condition number", this->getId());
                    this->setStatus(afwMath::SpatialCellCandidate::BAD);
                    return;
                }
            }
            _kernelSolutionOrig->solve();
        }
    } else {
        _useRegularization = false;
        LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate.build", "Not using kernel regularization");
        if (_isInitialized) {
            _kernelSolutionPca = std::shared_ptr<StaticKernelSolution<PixelT> >(
                    new StaticKernelSolution<PixelT>(basisList, _fitForBackground));
            _kernelSolutionPca->build(*(_templateMaskedImage->getImage()), *(_scienceMaskedImage->getImage()),
                                      *_varianceEstimate);
            if (checkConditionNumber) {
                if (_kernelSolutionPca->getConditionNumber(ctype) > maxConditionNumber) {
                    LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate",
                               "Candidate %d solution has bad condition number", this->getId());
                    this->setStatus(afwMath::SpatialCellCandidate::BAD);
                    return;
                }
            }
            _kernelSolutionPca->solve();
        } else {
            _kernelSolutionOrig = std::shared_ptr<StaticKernelSolution<PixelT> >(
                    new StaticKernelSolution<PixelT>(basisList, _fitForBackground));
            _kernelSolutionOrig->build(*(_templateMaskedImage->getImage()),
                                       *(_scienceMaskedImage->getImage()), *_varianceEstimate);
            if (checkConditionNumber) {
                if (_kernelSolutionOrig->getConditionNumber(ctype) > maxConditionNumber) {
                    LOGL_DEBUG("TRACE4.ip.diffim.KernelCandidate",
                               "Candidate %d solution has bad condition number", this->getId());
                    this->setStatus(afwMath::SpatialCellCandidate::BAD);
                    return;
                }
            }
            _kernelSolutionOrig->solve();
        }
    }
}

template <typename PixelT>
std::shared_ptr<lsst::afw::math::Kernel> KernelCandidate<PixelT>::getKernel(CandidateSwitch cand) const {
    if (cand == KernelCandidate::ORIG) {
        if (_kernelSolutionOrig)
            return _kernelSolutionOrig->getKernel();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Original kernel does not exist");
    } else if (cand == KernelCandidate::PCA) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->getKernel();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Pca kernel does not exist");
    } else if (cand == KernelCandidate::RECENT) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->getKernel();
        else if (_kernelSolutionOrig)
            return _kernelSolutionOrig->getKernel();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "No kernels exist");
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "Invalid CandidateSwitch, cannot get kernel");
    }
}

template <typename PixelT>
double KernelCandidate<PixelT>::getBackground(CandidateSwitch cand) const {
    if (cand == KernelCandidate::ORIG) {
        if (_kernelSolutionOrig)
            return _kernelSolutionOrig->getBackground();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Original kernel does not exist");
    } else if (cand == KernelCandidate::PCA) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->getBackground();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Pca kernel does not exist");
    } else if (cand == KernelCandidate::RECENT) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->getBackground();
        else if (_kernelSolutionOrig)
            return _kernelSolutionOrig->getBackground();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "No kernels exist");
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "Invalid CandidateSwitch, cannot get background");
    }
}

template <typename PixelT>
double KernelCandidate<PixelT>::getKsum(CandidateSwitch cand) const {
    if (cand == KernelCandidate::ORIG) {
        if (_kernelSolutionOrig)
            return _kernelSolutionOrig->getKsum();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Original kernel does not exist");
    } else if (cand == KernelCandidate::PCA) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->getKsum();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Pca kernel does not exist");
    } else if (cand == KernelCandidate::RECENT) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->getKsum();
        else if (_kernelSolutionOrig)
            return _kernelSolutionOrig->getKsum();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "No kernels exist");
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "Invalid CandidateSwitch, cannot get kSum");
    }
}

template <typename PixelT>
std::shared_ptr<typename KernelCandidate<PixelT>::ImageT> KernelCandidate<PixelT>::getKernelImage(
        CandidateSwitch cand) const {
    if (cand == KernelCandidate::ORIG) {
        if (_kernelSolutionOrig)
            return _kernelSolutionOrig->makeKernelImage();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Original kernel does not exist");
    } else if (cand == KernelCandidate::PCA) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->makeKernelImage();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Pca kernel does not exist");
    } else if (cand == KernelCandidate::RECENT) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca->makeKernelImage();
        else if (_kernelSolutionOrig)
            return _kernelSolutionOrig->makeKernelImage();
        else
            throw LSST_EXCEPT(pexExcept::Exception, "No kernels exist");
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "Invalid CandidateSwitch, cannot get kernel image");
    }
}

template <typename PixelT>
std::shared_ptr<typename KernelCandidate<PixelT>::ImageT const> KernelCandidate<PixelT>::getImage() const {
    return getKernelImage(KernelCandidate::ORIG);
}

template <typename PixelT>
std::shared_ptr<StaticKernelSolution<PixelT> > KernelCandidate<PixelT>::getKernelSolution(
        CandidateSwitch cand) const {
    if (cand == KernelCandidate::ORIG) {
        if (_kernelSolutionOrig)
            return _kernelSolutionOrig;
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Original kernel does not exist");
    } else if (cand == KernelCandidate::PCA) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca;
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Pca kernel does not exist");
    } else if (cand == KernelCandidate::RECENT) {
        if (_kernelSolutionPca)
            return _kernelSolutionPca;
        else if (_kernelSolutionOrig)
            return _kernelSolutionOrig;
        else
            throw LSST_EXCEPT(pexExcept::Exception, "No kernels exist");
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "Invalid CandidateSwitch, cannot get solution");
    }
}

template <typename PixelT>
lsst::afw::image::MaskedImage<PixelT> KernelCandidate<PixelT>::getDifferenceImage(CandidateSwitch cand) {
    if (cand == KernelCandidate::ORIG) {
        if (_kernelSolutionOrig)
            return getDifferenceImage(_kernelSolutionOrig->getKernel(), _kernelSolutionOrig->getBackground());
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Original kernel does not exist");
    } else if (cand == KernelCandidate::PCA) {
        if (_kernelSolutionPca)
            return getDifferenceImage(_kernelSolutionPca->getKernel(), _kernelSolutionPca->getBackground());
        else
            throw LSST_EXCEPT(pexExcept::Exception, "Pca kernel does not exist");
    } else if (cand == KernelCandidate::RECENT) {
        if (_kernelSolutionPca)
            return getDifferenceImage(_kernelSolutionPca->getKernel(), _kernelSolutionPca->getBackground());
        else if (_kernelSolutionOrig)
            return getDifferenceImage(_kernelSolutionOrig->getKernel(), _kernelSolutionOrig->getBackground());
        else
            throw LSST_EXCEPT(pexExcept::Exception, "No kernels exist");
    } else {
        throw LSST_EXCEPT(pexExcept::Exception, "Invalid CandidateSwitch, cannot get diffim");
    }
}

template <typename PixelT>
lsst::afw::image::MaskedImage<PixelT> KernelCandidate<PixelT>::getDifferenceImage(
        std::shared_ptr<lsst::afw::math::Kernel> kernel, double background) {
    /* Make diffim and set chi2 from result */
    afwImage::MaskedImage<PixelT> diffIm =
            convolveAndSubtract(*_templateMaskedImage, *_scienceMaskedImage, *kernel, background);
    return diffIm;
}

/***********************************************************************************************************/
//
// Explicit instantiations
//
typedef float PixelT;

template class KernelCandidate<PixelT>;

}  // namespace diffim
}  // namespace ip
}  // namespace lsst