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

Search through images for Footprints with no masked pixels. More...

#include <KernelCandidateDetection.h>

Public Types

typedef std::shared_ptr
< KernelCandidateDetection
Ptr
 
typedef std::shared_ptr
< lsst::afw::image::MaskedImage
< PixelT > > 
MaskedImagePtr
 

Public Member Functions

 KernelCandidateDetection (lsst::pex::policy::Policy const &policy)
 
virtual ~KernelCandidateDetection ()
 
void apply (MaskedImagePtr const &templateMaskedImage, MaskedImagePtr const &scienceMaskedImage)
 Runs Detection on a single image for significant peaks, and checks returned Footprints for Masked pixels. More...
 
bool growCandidate (std::shared_ptr< lsst::afw::detection::Footprint > fp, int fpGrowPix, MaskedImagePtr const &templateMaskedImage, MaskedImagePtr const &scienceMaskedImage)
 
std::vector< std::shared_ptr
< lsst::afw::detection::Footprint > > 
getFootprints ()
 

Private Attributes

lsst::pex::policy::Policy _policy
 
lsst::afw::image::MaskPixel _badBitMask
 
std::vector< std::shared_ptr
< lsst::afw::detection::Footprint > > 
_footprints
 

Detailed Description

template<typename PixelT>
class lsst::ip::diffim::KernelCandidateDetection< PixelT >

Search through images for Footprints with no masked pixels.

Note
Runs detection on the template; searches through both images for masked pixels
Parameters
templateMaskedImageMaskedImage that will be convolved with kernel
scienceMaskedImageMaskedImage to subtract convolved template from
policyPolicy for operations; in particular object detection

Definition at line 35 of file KernelCandidateDetection.h.

Member Typedef Documentation

template<typename PixelT >
typedef std::shared_ptr<lsst::afw::image::MaskedImage<PixelT> > lsst::ip::diffim::KernelCandidateDetection< PixelT >::MaskedImagePtr

Definition at line 38 of file KernelCandidateDetection.h.

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

Definition at line 37 of file KernelCandidateDetection.h.

Constructor & Destructor Documentation

template<typename PixelT >
lsst::ip::diffim::KernelCandidateDetection< PixelT >::KernelCandidateDetection ( lsst::pex::policy::Policy const &  policy)

Definition at line 33 of file KernelCandidateDetection.cc.

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

Definition at line 42 of file KernelCandidateDetection.h.

Member Function Documentation

template<typename PixelT >
void lsst::ip::diffim::KernelCandidateDetection< PixelT >::apply ( MaskedImagePtr const &  templateMaskedImage,
MaskedImagePtr const &  scienceMaskedImage 
)

Runs Detection on a single image for significant peaks, and checks returned Footprints for Masked pixels.

Note
Accepts two MaskedImages, one of which is to be convolved to match the other. The Detection package is run on either the image to be convolved (assumed to be higher S/N than the other image), or the image to not be convolved (assumed lower S/N; however if you run detection on a very deep template, you might not have significant S/N objects in the science image). The subimages associated with each returned Footprint in both images are checked for Masked pixels; Footprints containing Masked pixels are rejected. The Footprints are grown by an amount specified in the Policy. The acceptible Footprints are returned in a vector.
Returns
Vector of "clean" Footprints around which Image Subtraction Kernels will be built.

Definition at line 77 of file KernelCandidateDetection.cc.

template<typename PixelT >
std::vector<std::shared_ptr<lsst::afw::detection::Footprint> > lsst::ip::diffim::KernelCandidateDetection< PixelT >::getFootprints ( )
inline

Definition at line 52 of file KernelCandidateDetection.h.

template<typename PixelT >
bool lsst::ip::diffim::KernelCandidateDetection< PixelT >::growCandidate ( std::shared_ptr< lsst::afw::detection::Footprint >  fp,
int  fpGrowPix,
MaskedImagePtr const &  templateMaskedImage,
MaskedImagePtr const &  scienceMaskedImage 
)

Definition at line 147 of file KernelCandidateDetection.cc.

Member Data Documentation

template<typename PixelT >
lsst::afw::image::MaskPixel lsst::ip::diffim::KernelCandidateDetection< PixelT >::_badBitMask
private

Definition at line 56 of file KernelCandidateDetection.h.

template<typename PixelT >
std::vector<std::shared_ptr<lsst::afw::detection::Footprint> > lsst::ip::diffim::KernelCandidateDetection< PixelT >::_footprints
private

Definition at line 57 of file KernelCandidateDetection.h.

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

Definition at line 52 of file KernelCandidateDetection.h.


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