lsst.afw g87b8406481+6d9b2db676
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
lsst::afw::image::ImagePca< ImageT > Class Template Reference

#include <ImagePca.h>

Public Types

using ImageList = std::vector< std::shared_ptr< ImageT > >
 

Public Member Functions

 ImagePca (bool constantWeight=true)
 ctor More...
 
virtual ~ImagePca ()=default
 
 ImagePca (ImagePca const &)
 
 ImagePca (ImagePca &&)
 
ImagePcaoperator= (ImagePca const &)
 
ImagePcaoperator= (ImagePca &&)
 
void addImage (std::shared_ptr< ImageT > img, double flux=0.0)
 Add an image to the set to be analyzed. More...
 
ImageList getImageList () const
 Return the list of images being analyzed. More...
 
lsst::geom::Extent2I const getDimensions () const
 Return the dimension of the images being analyzed. More...
 
std::shared_ptr< ImageT > getMean () const
 Return the mean of the images in ImagePca's list. More...
 
virtual void analyze ()
 
virtual double updateBadPixels (unsigned long mask, int const ncomp)
 Update the bad pixels (i.e. More...
 
std::vector< double > const & getEigenValues () const
 Return Eigen values. More...
 
ImageList const & getEigenImages () const
 Return Eigen images. More...
 

Detailed Description

template<typename ImageT>
class lsst::afw::image::ImagePca< ImageT >

Definition at line 45 of file ImagePca.h.

Member Typedef Documentation

◆ ImageList

template<typename ImageT >
using lsst::afw::image::ImagePca< ImageT >::ImageList = std::vector<std::shared_ptr<ImageT> >

Definition at line 47 of file ImagePca.h.

Constructor & Destructor Documentation

◆ ImagePca() [1/3]

template<typename ImageT >
lsst::afw::image::ImagePca< ImageT >::ImagePca ( bool  constantWeight = true)
explicit

ctor

Parameters
constantWeightShould all stars be weighted equally?

Definition at line 46 of file ImagePca.cc.

◆ ~ImagePca()

template<typename ImageT >
virtual lsst::afw::image::ImagePca< ImageT >::~ImagePca ( )
virtualdefault

◆ ImagePca() [2/3]

template<typename ImageT >
lsst::afw::image::ImagePca< ImageT >::ImagePca ( ImagePca< ImageT > const &  )
default

◆ ImagePca() [3/3]

template<typename ImageT >
lsst::afw::image::ImagePca< ImageT >::ImagePca ( ImagePca< ImageT > &&  )
default

Member Function Documentation

◆ addImage()

template<typename ImageT >
void lsst::afw::image::ImagePca< ImageT >::addImage ( std::shared_ptr< ImageT >  img,
double  flux = 0.0 
)

Add an image to the set to be analyzed.

Parameters
imgImage to add to set
fluxImage's flux
Exceptions
lsst::pex::exceptions::LengthErrorif all the images aren't the same size

Definition at line 64 of file ImagePca.cc.

◆ analyze()

template<typename ImageT >
void lsst::afw::image::ImagePca< ImageT >::analyze
virtual

Definition at line 123 of file ImagePca.cc.

◆ getDimensions()

template<typename ImageT >
lsst::geom::Extent2I const lsst::afw::image::ImagePca< ImageT >::getDimensions ( ) const
inline

Return the dimension of the images being analyzed.

Definition at line 75 of file ImagePca.h.

◆ getEigenImages()

template<typename ImageT >
ImageList const & lsst::afw::image::ImagePca< ImageT >::getEigenImages ( ) const
inline

Return Eigen images.

Definition at line 100 of file ImagePca.h.

◆ getEigenValues()

template<typename ImageT >
std::vector< double > const & lsst::afw::image::ImagePca< ImageT >::getEigenValues ( ) const
inline

Return Eigen values.

Definition at line 98 of file ImagePca.h.

◆ getImageList()

template<typename ImageT >
ImagePca< ImageT >::ImageList lsst::afw::image::ImagePca< ImageT >::getImageList

Return the list of images being analyzed.

Definition at line 85 of file ImagePca.cc.

◆ getMean()

template<typename ImageT >
std::shared_ptr< ImageT > lsst::afw::image::ImagePca< ImageT >::getMean

Return the mean of the images in ImagePca's list.

Definition at line 90 of file ImagePca.cc.

◆ operator=() [1/2]

template<typename ImageT >
ImagePca< ImageT > & lsst::afw::image::ImagePca< ImageT >::operator= ( ImagePca< ImageT > &&  )
default

◆ operator=() [2/2]

template<typename ImageT >
ImagePca< ImageT > & lsst::afw::image::ImagePca< ImageT >::operator= ( ImagePca< ImageT > const &  )
default

◆ updateBadPixels()

template<typename ImageT >
double lsst::afw::image::ImagePca< ImageT >::updateBadPixels ( unsigned long  mask,
int const  ncomp 
)
virtual

Update the bad pixels (i.e.

those for which (value & mask) != 0) based on the current PCA decomposition; if none is available, use the mean of the good pixels

Parameters
maskMask defining bad pixels
ncompNumber of components to use in estimate
Returns
the maximum change made to any pixel

N.b. the work is actually done in do_updateBadPixels as the code only makes sense and compiles when we are doing a PCA on a set of MaskedImages

Definition at line 386 of file ImagePca.cc.


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