lsst.ip.diffim  13.0-22-g3839dbb+8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT > Class Template Reference

Asseses the quality of a candidate given a spatial kernel and background model. More...

#include <AssessSpatialKernelVisitor.h>

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

Public Types

typedef std::shared_ptr
< AssessSpatialKernelVisitor
< PixelT > > 
Ptr
 

Public Member Functions

 AssessSpatialKernelVisitor (std::shared_ptr< lsst::afw::math::LinearCombinationKernel > spatialKernel, lsst::afw::math::Kernel::SpatialFunctionPtr spatialBackground, lsst::pex::policy::Policy const &policy)
 
virtual ~AssessSpatialKernelVisitor ()
 
void reset ()
 
int getNGood ()
 
int getNRejected ()
 
int getNProcessed ()
 
void processCandidate (lsst::afw::math::SpatialCellCandidate *candidate)
 

Private Types

typedef
lsst::afw::image::MaskedImage
< PixelT
MaskedImageT
 

Private Attributes

std::shared_ptr
< lsst::afw::math::LinearCombinationKernel > 
_spatialKernel
 Spatial kernel function. More...
 
lsst::afw::math::Kernel::SpatialFunctionPtr _spatialBackground
 Spatial background function. More...
 
lsst::pex::policy::Policy _policy
 Policy controlling behavior. More...
 
ImageStatistics< PixelT_imstats
 To calculate statistics of difference image. More...
 
int _nGood
 Number of good candidates remaining. More...
 
int _nRejected
 Number of candidates rejected during processCandidate() More...
 
int _nProcessed
 Number of candidates processed during processCandidate() More...
 
bool _useCoreStats
 Extracted from policy. More...
 
int _coreRadius
 Extracted from policy. More...
 

Detailed Description

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

Asseses the quality of a candidate given a spatial kernel and background model.

detail::AssessSpatialKernelVisitor<PixelT> spatialKernelAssessor(spatialKernel,
spatialBackground,
policy);
spatialKernelAssessor.reset();
kernelCells.visitCandidates(&spatialKernelAssessor, nStarPerCell);
nRejected = spatialKernelAssessor.getNRejected();
*
Note
Evaluates the spatial kernel and spatial background at the location of each candidate, and computes the resulting difference image. Sets candidate as afwMath::SpatialCellCandidate::GOOD/BAD if requested by the Policy.

Definition at line 26 of file AssessSpatialKernelVisitor.h.

Member Typedef Documentation

template<typename PixelT >
typedef lsst::afw::image::MaskedImage<PixelT> lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::MaskedImageT
private

Definition at line 27 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
typedef std::shared_ptr<AssessSpatialKernelVisitor<PixelT> > lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::Ptr

Definition at line 29 of file AssessSpatialKernelVisitor.h.

Constructor & Destructor Documentation

template<typename PixelT >
lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::AssessSpatialKernelVisitor ( std::shared_ptr< lsst::afw::math::LinearCombinationKernel >  spatialKernel,
lsst::afw::math::Kernel::SpatialFunctionPtr  spatialBackground,
lsst::pex::policy::Policy const &  policy 
)
Parameters
spatialKernelSpatially varying kernel
spatialBackgroundSpatially varying background
policyPolicy file

Definition at line 54 of file AssessSpatialKernelVisitor.cc.

template<typename PixelT >
virtual lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::~AssessSpatialKernelVisitor ( )
inlinevirtual

Definition at line 36 of file AssessSpatialKernelVisitor.h.

Member Function Documentation

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::getNGood ( )
inline

Definition at line 40 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::getNProcessed ( )
inline

Definition at line 42 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::getNRejected ( )
inline

Definition at line 41 of file AssessSpatialKernelVisitor.h.

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

Definition at line 72 of file AssessSpatialKernelVisitor.cc.

template<typename PixelT >
void lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::reset ( )
inline

Definition at line 38 of file AssessSpatialKernelVisitor.h.

Member Data Documentation

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_coreRadius
private

Extracted from policy.

Definition at line 55 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
ImageStatistics<PixelT> lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_imstats
private

To calculate statistics of difference image.

Definition at line 49 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_nGood
private

Number of good candidates remaining.

Definition at line 50 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_nProcessed
private

Number of candidates processed during processCandidate()

Definition at line 52 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
int lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_nRejected
private

Number of candidates rejected during processCandidate()

Definition at line 51 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
lsst::pex::policy::Policy lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_policy
private

Policy controlling behavior.

Definition at line 48 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
lsst::afw::math::Kernel::SpatialFunctionPtr lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_spatialBackground
private

Spatial background function.

Definition at line 47 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
std::shared_ptr<lsst::afw::math::LinearCombinationKernel> lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_spatialKernel
private

Spatial kernel function.

Definition at line 46 of file AssessSpatialKernelVisitor.h.

template<typename PixelT >
bool lsst::ip::diffim::detail::AssessSpatialKernelVisitor< PixelT >::_useCoreStats
private

Extracted from policy.

Definition at line 54 of file AssessSpatialKernelVisitor.h.


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