lsst::ip::diffim::detail::KernelSumVisitor< PixelT > Class Template Reference

A class to accumulate kernel sums across SpatialCells. More...

#include <KernelSumVisitor.h>

Inheritance diagram for lsst::ip::diffim::detail::KernelSumVisitor< PixelT >:

Public Types
enum	Mode { AGGREGATE = 0 , REJECT = 1 }
typedef std::shared_ptr< KernelSumVisitor< PixelT > >	Ptr

Public Member Functions
	KernelSumVisitor (lsst::daf::base::PropertySet const &ps)
virtual	~KernelSumVisitor ()
void	setMode (Mode mode)
int	getNRejected ()
double	getkSumMean ()
double	getkSumStd ()
double	getdkSumMax ()
int	getkSumNpts ()
void	resetKernelSum ()
void	processCandidate (lsst::afw::math::SpatialCellCandidate *candidate)
void	processKsumDistribution ()
virtual void	reset ()

Detailed Description

template<typename PixelT>
class lsst::ip::diffim::detail::KernelSumVisitor< PixelT >

A class to accumulate kernel sums across SpatialCells.

std::shared_ptr<PropertySet> ps(new PropertySet);
ps->set("kernelSumClipping", false);
ps->set("maxKsumSigma", 3.0);
 
detail::KernelSumVisitor<PixelT> kernelSumVisitor(*ps);
kernelSumVisitor.reset();
kernelSumVisitor.setMode(detail::KernelSumVisitor<PixelT>::AGGREGATE);
kernelCells.visitCandidates(&kernelSumVisitor, nStarPerCell);
kernelSumVisitor.processKsumDistribution();
kernelSumVisitor.setMode(detail::KernelSumVisitor<PixelT>::REJECT);
kernelCells.visitCandidates(&kernelSumVisitor, nStarPerCell);
int nRejected = kernelSumVisitor.getNRejected();

Note

The class has 2 processing modes; the first AGGREGATES kernel sums across all candidates. You must the process the distribution to set member variables representing the mean and standard deviation of the kernel sums. The second mode then REJECTs candidates with kernel sums outside the acceptable range (set by the ps). It does this by setting candidate status to afwMath::SpatialCellCandidate::BAD. In this mode it also accumulates the number of candidates it sets as bad.

The statistics call calculates sigma-clipped values (afwMath::MEANCLIP, afwMath::STDEVCLIP)

Definition at line 27 of file KernelSumVisitor.h.

Member Typedef Documentation

Ptr

template<typename PixelT>

typedef std::shared_ptr<KernelSumVisitor<PixelT> > lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::Ptr

Definition at line 29 of file KernelSumVisitor.h.

Member Enumeration Documentation

Mode

template<typename PixelT>

enum lsst::ip::diffim::detail::KernelSumVisitor::Mode

Enumerator
AGGREGATE
REJECT

Definition at line 31 of file KernelSumVisitor.h.

{AGGREGATE = 0, REJECT = 1};

Constructor & Destructor Documentation

KernelSumVisitor()

template<typename PixelT>

lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::KernelSumVisitor

(

lsst::daf::base::PropertySet const &

ps

)

Parameters

ps	ps file directing behavior

Definition at line 65 of file KernelSumVisitor.cc.

          :
        afwMath::CandidateVisitor(),
        _mode(AGGREGATE),
        _kSums(std::vector<double>()),
        _kSumMean(0.),
        _kSumStd(0.),
        _dkSumMax(0.),
        _kSumNpts(0),
        _nRejected(0),
        _ps(ps.deepCopy())
    {};

~KernelSumVisitor()

template<typename PixelT>

virtual lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::~KernelSumVisitor ( )

inlinevirtual

Definition at line 34 of file KernelSumVisitor.h.

{};

Member Function Documentation

getdkSumMax()

template<typename PixelT>

double lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::getdkSumMax ( )

inline

Definition at line 40 of file KernelSumVisitor.h.

{return _dkSumMax;}

getkSumMean()

template<typename PixelT>

double lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::getkSumMean ( )

inline

Definition at line 38 of file KernelSumVisitor.h.

{return _kSumMean;}

getkSumNpts()

template<typename PixelT>

int lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::getkSumNpts ( )

inline

Definition at line 41 of file KernelSumVisitor.h.

{return _kSumNpts;}

getkSumStd()

template<typename PixelT>

double lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::getkSumStd ( )

inline

Definition at line 39 of file KernelSumVisitor.h.

{return _kSumStd;}

getNRejected()

template<typename PixelT>

int lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::getNRejected ( )

inline

Definition at line 37 of file KernelSumVisitor.h.

{return _nRejected;}

processCandidate()

template<typename PixelT>

void lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::processCandidate ( lsst::afw::math::SpatialCellCandidate * candidate )

virtual

Reimplemented from lsst::afw::math::CandidateVisitor.

Definition at line 90 of file KernelSumVisitor.cc.

                                                                {
 
        KernelCandidate<PixelT> *kCandidate = dynamic_cast<KernelCandidate<PixelT> *>(candidate);
        if (kCandidate == NULL) {
            throw LSST_EXCEPT(pexExcept::LogicError,
                              "Failed to cast SpatialCellCandidate to KernelCandidate");
        }
        LOGL_DEBUG("TRACE5.ip.diffim.KernelSumVisitor.processCandidate",
                   "Processing candidate %d, mode %d", kCandidate->getId(), _mode);
 
        /* Grab all kernel sums and look for outliers */
        if (_mode == AGGREGATE) {
            _kSums.push_back(kCandidate->getKernelSolution(KernelCandidate<PixelT>::ORIG)->getKsum());
        }
        else if (_mode == REJECT) {
            if (_ps->getAsBool("kernelSumClipping")) {
                double kSum =
                    kCandidate->getKernelSolution(KernelCandidate<PixelT>::ORIG)->getKsum();
 
                if (fabs(kSum - _kSumMean) > _dkSumMax) {
                    kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
                    LOGL_DEBUG("TRACE3.ip.diffim.KernelSumVisitor.processCandidate",
                               "Rejecting candidate %d; bad source kernel sum : (%.2f)",
                               kCandidate->getId(),
                               kSum);
                    _nRejected += 1;
                }
            }
            else {
                LOGL_DEBUG("TRACE5.ip.diffim.KernelSumVisitor.processCandidate",
                           "Sigma clipping not enabled");
            }
        }
    }

processKsumDistribution()

template<typename PixelT>

void lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::processKsumDistribution

(

)

Definition at line 127 of file KernelSumVisitor.cc.

                                                           {
        if (_kSums.size() == 0) {
            throw LSST_EXCEPT(pexExcept::RuntimeError,
                              "Unable to determine kernel sum; 0 candidates");
        }
        else if (_kSums.size() == 1) {
            LOGL_DEBUG("TRACE1.ip.diffim.KernelSumVisitor.processKsumDistribution",
                       "WARNING: only 1 kernel candidate");
 
            _kSumMean = _kSums[0];
            _kSumStd  = 0.0;
            _kSumNpts = 1;
        }
        else {
            try {
                afwMath::Statistics stats = afwMath::makeStatistics(_kSums,
                                                                    afwMath::NPOINT |
                                                                    afwMath::MEANCLIP |
                                                                    afwMath::STDEVCLIP);
                _kSumMean = stats.getValue(afwMath::MEANCLIP);
                _kSumStd  = stats.getValue(afwMath::STDEVCLIP);
                _kSumNpts = static_cast<int>(stats.getValue(afwMath::NPOINT));
            } catch (pexExcept::Exception &e) {
                LSST_EXCEPT_ADD(e, "Unable to calculate kernel sum statistics");
                throw e;
            }
            if (std::isnan(_kSumMean)) {
                throw LSST_EXCEPT(pexExcept::RuntimeError,
                                  str(boost::format("Mean kernel sum returns NaN (%d points)")
                                      % _kSumNpts));
            }
            if (std::isnan(_kSumStd)) {
                throw LSST_EXCEPT(pexExcept::RuntimeError,
                                  str(boost::format("Kernel sum stdev returns NaN (%d points)")
                                      % _kSumNpts));
            }
        }
        _dkSumMax = _ps->getAsDouble("maxKsumSigma") * _kSumStd;
        LOGL_DEBUG("TRACE1.ip.diffim.KernelSumVisitor.processCandidate",
                   "Kernel Sum Distribution : %.3f +/- %.3f (%d points)",
                   _kSumMean, _kSumStd, _kSumNpts);
    }

reset()

virtual void lsst::afw::math::CandidateVisitor::reset ( )

inlinevirtualinherited

Reimplemented in lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >, lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >, and lsst::meas::algorithms::evalChi2Visitor< PixelT >.

Definition at line 63 of file SpatialCell.h.

{}

resetKernelSum()

template<typename PixelT>

void lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::resetKernelSum

(

)

Definition at line 80 of file KernelSumVisitor.cc.

                                                  {
        _kSums.clear();
        _kSumMean =  0.;
        _kSumStd  =  0.;
        _dkSumMax =  0.;
        _kSumNpts =  0;
        _nRejected = 0;
    }

setMode()

template<typename PixelT>

void lsst::ip::diffim::detail::KernelSumVisitor< PixelT >::setMode ( Mode mode )

inline

Definition at line 36 of file KernelSumVisitor.h.

{_mode = mode;}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/ip_diffim/g7cc15d900a+d121454f8d/include/lsst/ip/diffim/KernelSumVisitor.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/ip_diffim/g7cc15d900a+d121454f8d/src/KernelSumVisitor.cc