Builds the convolution kernel for a given candidate. More...

#include <BuildSingleKernelVisitor.h>

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

Public Types
typedef boost::shared_ptr < BuildSingleKernelVisitor < PixelT > >	Ptr

Public Member Functions
	BuildSingleKernelVisitor (lsst::afw::math::KernelList const &basisList, lsst::pex::policy::Policy const &policy)

	BuildSingleKernelVisitor (lsst::afw::math::KernelList const &basisList, lsst::pex::policy::Policy const &policy, boost::shared_ptr< Eigen::MatrixXd > hMat)

virtual	~BuildSingleKernelVisitor ()

void	setSkipBuilt (bool skip)

int	getNRejected ()

int	getNProcessed ()

void	reset ()

void	processCandidate (lsst::afw::math::SpatialCellCandidate *candidate)

Public Member Functions inherited from lsst::afw::math::CandidateVisitor
	CandidateVisitor ()

virtual	~CandidateVisitor ()

Private Types
typedef lsst::afw::image::MaskedImage < PixelT >	MaskedImageT

Private Attributes
lsst::afw::math::KernelList const	_basisList
	Basis set. More...

lsst::pex::policy::Policy	_policy
	Policy controlling behavior. More...

boost::shared_ptr < Eigen::MatrixXd >	_hMat
	Regularization matrix. More...

ImageStatistics< PixelT >	_imstats
	To calculate statistics of difference image. More...

bool	_skipBuilt
	Skip over built candidates during processCandidate() More...

int	_nRejected
	Number of candidates rejected during processCandidate() More...

int	_nProcessed
	Number of candidates processed during processCandidate() More...

bool	_useRegularization
	Regularize if delta function basis. More...

bool	_useCoreStats
	Extracted from _policy. More...

int	_coreRadius
	Extracted from _policy. More...

Detailed Description

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

Builds the convolution kernel for a given candidate.

   Policy::Ptr policy(new Policy);
   policy->set("constantVarianceWeighting", false);
   policy->set("iterateSingleKernel", false);
   policy->set("singleKernelClipping", true);
   policy->set("candidateResidualMeanMax", 0.25);
   policy->set("candidateResidualStdMax", 1.25);
   detail::BuildSingleKernelVisitor<PixelT> singleKernelFitter(*policy);
   int nRejected = -1;
   while (nRejected != 0) {
       singleKernelFitter.reset();
       kernelCells.visitCandidates(&singleKernelFitter, nStarPerCell);
       nRejected = singleKernelFitter.getNRejected();
   }
* 

Note: Visits each current candidate in a afwMath::SpatialCellSet, and builds its kernel using its build() method. We don't build the kernel for every candidate since this is computationally expensive, only when its the current candidate in the cell. During the course of building the kernel, it also assesses the quality of the difference image. If it is determined to be bad (based on the Policy paramters) the candidate is flagged as afwMath::SpatialCellCandidate::BAD; otherwise its marked as afwMath::SpatialCellCandidate::GOOD. Keeps a running sample of all the new candidates it visited that turned out to be bad.; Because this visitor does not have access to the next candidate in the cell, it must be called iteratively until no candidates are rejected. This ensures that the current candidate of every cell has an initialized Kernel. This also requires that this class re-Visit all the cells after any other Visitors with the ability to mark something as BAD.; Because we are frequently re-Visiting entirely GOOD candidates during these iterations, the option of _skipBuilt=true will enable the user to not rebuilt the kernel on every visit.; For the particular use case of creating a Pca basis from the raw kernels, we want to re-Visit each candidate and re-fit the kernel using this Pca basis. This requires the user to setSkipBuilt(false) so that the candidate is reprocessed with this new basis.

Definition at line 30 of file BuildSingleKernelVisitor.h.

Member Typedef Documentation

template<typename PixelT >

typedef lsst::afw::image::MaskedImage<PixelT> lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::MaskedImageT

private

Definition at line 31 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

typedef boost::shared_ptr<BuildSingleKernelVisitor<PixelT> > lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::Ptr

Definition at line 33 of file BuildSingleKernelVisitor.h.

Constructor & Destructor Documentation

template<typename PixelT >

lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::BuildSingleKernelVisitor	(	lsst::afw::math::KernelList const &	basisList,
		lsst::pex::policy::Policy const &	policy
	)

Parameters

basisList	List of basis kernels for resulting LinearCombinationKernel
policy	Policy file directing behavior

Definition at line 90 of file BuildSingleKernelVisitor.cc.

           :
         afwMath::CandidateVisitor(),
         _basisList(basisList),
         _policy(policy),
         _hMat(),
         _imstats(ImageStatistics<PixelT>(_policy)),
         _skipBuilt(true),
         _nRejected(0),
         _nProcessed(0),
         _useRegularization(false),
         _useCoreStats(_policy.getBool("useCoreStats")),
         _coreRadius(_policy.getInt("candidateCoreRadius"))
     {};

template<typename PixelT >

lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::BuildSingleKernelVisitor	(	lsst::afw::math::KernelList const &	basisList,
		lsst::pex::policy::Policy const &	policy,
		boost::shared_ptr< Eigen::MatrixXd >	hMat
	)

Parameters

basisList	List of basis kernels for resulting LinearCombinationKernel
policy	Policy file directing behavior
hMat	Regularization matrix

Definition at line 109 of file BuildSingleKernelVisitor.cc.

           :
         afwMath::CandidateVisitor(),
         _basisList(basisList),
         _policy(policy),
         _hMat(hMat),
         _imstats(ImageStatistics<PixelT>(_policy)),
         _skipBuilt(true),
         _nRejected(0),
         _nProcessed(0),
         _useRegularization(true),
         _useCoreStats(_policy.getBool("useCoreStats")),
         _coreRadius(_policy.getInt("candidateCoreRadius"))
     {};

template<typename PixelT >

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

inlinevirtual

Definition at line 44 of file BuildSingleKernelVisitor.h.

44 {};

Member Function Documentation

template<typename PixelT >

int lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::getNProcessed ( )

inline

Definition at line 56 of file BuildSingleKernelVisitor.h.

56 {return _nProcessed;}

lsst::ip::diffim::detail::BuildSingleKernelVisitor::_nProcessed

int _nProcessed

Number of candidates processed during processCandidate()

Definition: BuildSingleKernelVisitor.h:68

template<typename PixelT >

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

inline

Definition at line 55 of file BuildSingleKernelVisitor.h.

55 {return _nRejected;}

lsst::ip::diffim::detail::BuildSingleKernelVisitor::_nRejected

int _nRejected

Number of candidates rejected during processCandidate()

Definition: BuildSingleKernelVisitor.h:67

template<typename PixelT >

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

virtual

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

Definition at line 130 of file BuildSingleKernelVisitor.cc.

           {
         
         ipDiffim::KernelCandidate<PixelT> *kCandidate = 
             dynamic_cast<ipDiffim::KernelCandidate<PixelT> *>(candidate);
         if (kCandidate == NULL) {
             pexLogging::TTrace<3>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                   "Failed to cast SpatialCellCandidate to KernelCandidate %d", 
                                   kCandidate->getId());
             throw LSST_EXCEPT(pexExcept::LogicError,
                               "Failed to cast SpatialCellCandidate to KernelCandidate");
         }
         
         if (_skipBuilt and kCandidate->isInitialized()) {
             return;
         }
         
         pexLogging::TTrace<2>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                               "Processing candidate %d", kCandidate->getId());
         pexLogging::TTrace<5>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate",
                               "X = %.2f Y = %.2f",
                               kCandidate->getXCenter(), 
                               kCandidate->getYCenter());
                               
         /* Build its kernel here */
         try {
             if (_useRegularization)
                 kCandidate->build(_basisList, _hMat);
             else
                 kCandidate->build(_basisList);
 
         } catch (pexExcept::Exception &e) {
             kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
             pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                   "Unable to process candidate %d; exception caught (%s)", 
                                   kCandidate->getId(),
                                   e.what());
             _nRejected += 1;
             return;
         } 
 
         if (kCandidate->getStatus() == afwMath::SpatialCellCandidate::BAD) {
             pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                   "Candidate %d Returned BAD upon build, exiting", 
                                   kCandidate->getId());
             _nRejected += 1;
             return;
         }
             
          
          /* 
          * Make diffim and set chi2 from result.  Note that you need to use the
          * most recent kernel
          */
         MaskedImageT diffim = kCandidate->getDifferenceImage(ipDiffim::KernelCandidate<PixelT>::RECENT);
         try {
             if (_useCoreStats) 
                 _imstats.apply(diffim, _coreRadius);
             else
                 _imstats.apply(diffim);
         } catch (pexExcept::Exception& e) {
             pexLogging::TTrace<3>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                   "Unable to calculate imstats for Candidate %d", kCandidate->getId()); 
             kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
             return;
         }
         _nProcessed += 1;
 
         kCandidate->setChi2(_imstats.getVariance());
         
         /* When using a Pca basis, we don't reset the kernel or background,
            so we need to evaluate these locally for the Trace */
         double kSum = kCandidate->getKsum(ipDiffim::KernelCandidate<PixelT>::RECENT);
         double background = kCandidate->getBackground(ipDiffim::KernelCandidate<PixelT>::RECENT);
         
         pexLogging::TTrace<5>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                               "Chi2 = %.3f", kCandidate->getChi2());
         pexLogging::TTrace<5>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate",
                               "Kernel Sum = %.3f", kSum);
         pexLogging::TTrace<5>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate",
                               "Background = %.3f", background);
         pexLogging::TTrace<3>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate",
                               "Candidate %d resids = %.3f +/- %.3f sigma (%d pix)",
                               kCandidate->getId(),
                               _imstats.getMean(),
                               _imstats.getRms(),
                               _imstats.getNpix());
         
         bool meanIsNan = std::isnan(_imstats.getMean());
         bool rmsIsNan  = std::isnan(_imstats.getRms());
         if (meanIsNan || rmsIsNan) {
             kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
             pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                   "Rejecting candidate %d, encountered NaN",
                                   kCandidate->getId());
             _nRejected += 1;
             return;
         }
         
         if (_policy.getBool("singleKernelClipping")) {
             if (fabs(_imstats.getMean()) > _policy.getDouble("candidateResidualMeanMax")) {
                 kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
                 pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                       "Rejecting candidate %d; bad mean residual : |%.3f| > %.3f",
                                       kCandidate->getId(),
                                       _imstats.getMean(),
                                       _policy.getDouble("candidateResidualMeanMax"));
                 _nRejected += 1;
             }
             else if (_imstats.getRms() > _policy.getDouble("candidateResidualStdMax")) {
                 kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
                 pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                       "Rejecting candidate %d; bad residual rms : %.3f > %.3f",
                                       kCandidate->getId(),
                                       _imstats.getRms(),
                                       _policy.getDouble("candidateResidualStdMax"));
                 _nRejected += 1;
             }
             else {
                 kCandidate->setStatus(afwMath::SpatialCellCandidate::GOOD);
                 pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                       "Source kernel OK");
             }
         }
         else {
             kCandidate->setStatus(afwMath::SpatialCellCandidate::GOOD);
             pexLogging::TTrace<6>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                   "Sigma clipping not enabled");
         }
         
         /* Core resids for debugging */
         if (!(_useCoreStats)) {
             try {
                 _imstats.apply(diffim, _coreRadius);
             } catch (pexExcept::Exception& e) {
                 pexLogging::TTrace<3>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate", 
                                       "Unable to calculate core imstats for Candidate %d", 
                                       kCandidate->getId()); 
                 kCandidate->setStatus(afwMath::SpatialCellCandidate::BAD);
                 return;
             }
             pexLogging::TTrace<4>("lsst.ip.diffim.BuildSingleKernelVisitor.processCandidate",
                                   "Candidate %d core resids = %.3f +/- %.3f sigma (%d pix)",
                                   kCandidate->getId(),
                                   _imstats.getMean(),
                                   _imstats.getRms(),
                                   _imstats.getNpix());
         }
         
     }

template<typename PixelT >

void lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::reset ( )

inlinevirtual

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

Definition at line 57 of file BuildSingleKernelVisitor.h.

57 {_nRejected = 0; _nProcessed = 0;}

lsst::ip::diffim::detail::BuildSingleKernelVisitor::_nRejected

int _nRejected

Number of candidates rejected during processCandidate()

Definition: BuildSingleKernelVisitor.h:67

lsst::ip::diffim::detail::BuildSingleKernelVisitor::_nProcessed

int _nProcessed

Number of candidates processed during processCandidate()

Definition: BuildSingleKernelVisitor.h:68

template<typename PixelT >

void lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::setSkipBuilt ( bool skip )

inline

Definition at line 53 of file BuildSingleKernelVisitor.h.

53 {_skipBuilt = skip;}

lsst::ip::diffim::detail::BuildSingleKernelVisitor::_skipBuilt

bool _skipBuilt

Skip over built candidates during processCandidate()

Definition: BuildSingleKernelVisitor.h:66

Member Data Documentation

template<typename PixelT >

lsst::afw::math::KernelList const lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_basisList

private

Basis set.

Definition at line 62 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

int lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_coreRadius

private

Extracted from _policy.

Definition at line 72 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

boost::shared_ptr<Eigen::MatrixXd> lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_hMat

private

Regularization matrix.

Definition at line 64 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

ImageStatistics<PixelT> lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_imstats

private

To calculate statistics of difference image.

Definition at line 65 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

int lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_nProcessed

private

Number of candidates processed during processCandidate()

Definition at line 68 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

int lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_nRejected

private

Number of candidates rejected during processCandidate()

Definition at line 67 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

lsst::pex::policy::Policy lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_policy

private

Policy controlling behavior.

Definition at line 63 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

bool lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_skipBuilt

private

Skip over built candidates during processCandidate()

Definition at line 66 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

bool lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_useCoreStats

private

Extracted from _policy.

Definition at line 71 of file BuildSingleKernelVisitor.h.

template<typename PixelT >

bool lsst::ip::diffim::detail::BuildSingleKernelVisitor< PixelT >::_useRegularization

private

Regularize if delta function basis.

Definition at line 69 of file BuildSingleKernelVisitor.h.

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

/home/lsstsw/stack/Linux64/ip_diffim/11.0+1/include/lsst/ip/diffim/BuildSingleKernelVisitor.h
/home/lsstsw/stack/Linux64/ip_diffim/11.0+1/src/BuildSingleKernelVisitor.cc

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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