lsst::ip::diffim::detail::KernelPca< ImageT > Class Template Reference

Overrides the analyze method of base class afwImage::ImagePca. More...

#include <KernelPca.h>

Inheritance diagram for lsst::ip::diffim::detail::KernelPca< ImageT >:

Public Types
typedef std::shared_ptr< KernelPca< ImageT > >	Ptr
using	ImageList = std::vector< std::shared_ptr< ImageT > >

Public Member Functions
	KernelPca (bool constantWeight=true)
	Ctor. More...
virtual void	analyze ()
	Generate eigenimages that are normalised. More...
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 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::ip::diffim::detail::KernelPca< ImageT >

Overrides the analyze method of base class afwImage::ImagePca.

Note

Templated on the Image types it is running on (typically [exclusively?] afwMath::Kernel::Pixel, which is double)

This override normalizes the resulting eigenImages to have peak value of 1.0.

Definition at line 24 of file KernelPca.h.

Member Typedef Documentation

ImageList

template<typename ImageT >

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

inherited

Definition at line 47 of file ImagePca.h.

Ptr

template<typename ImageT >

typedef std::shared_ptr<KernelPca<ImageT> > lsst::ip::diffim::detail::KernelPca< ImageT >::Ptr

Definition at line 27 of file KernelPca.h.

Constructor & Destructor Documentation

KernelPca()

template<typename ImageT >

lsst::ip::diffim::detail::KernelPca< ImageT >::KernelPca ( bool  constantWeight = true )

inlineexplicit

Ctor.

Definition at line 33 of file KernelPca.h.

: Super(constantWeight) {}

Member Function Documentation

addImage()

template<typename ImageT >

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

inherited

Add an image to the set to be analyzed.

Parameters

img	Image to add to set
flux	Image's flux

Exceptions

lsst::pex::exceptions::LengthError

if all the images aren't the same size

Definition at line 64 of file ImagePca.cc.

                                                                      {
    if (_imageList.empty()) {
        _dimensions = img->getDimensions();
    } else {
        if (getDimensions() != img->getDimensions()) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              (boost::format("Dimension mismatch: saw %dx%d; expected %dx%d") %
                               img->getWidth() % img->getHeight() % _dimensions.getX() % _dimensions.getY())
                                      .str());
        }
    }
 
    if (flux == 0.0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::OutOfRangeError, "Flux may not be zero");
    }
 
    _imageList.push_back(img);
    _fluxList.push_back(flux);
}

analyze()

template<typename ImageT >

void lsst::ip::diffim::detail::KernelPca< ImageT >::analyze

virtual

Generate eigenimages that are normalised.

Reimplemented from lsst::afw::image::ImagePca< ImageT >.

Definition at line 163 of file KernelPca.cc.

    {
        Super::analyze();
 
        typename Super::ImageList const &eImageList = this->getEigenImages();
        typename Super::ImageList::const_iterator iter = eImageList.begin(), end = eImageList.end();
        for (size_t i = 0; iter != end; ++i, ++iter) {
            std::shared_ptr<ImageT> eImage = *iter;
 
            /*
             * Normalise eigenImages to have a maximum of 1.0.  For n > 0 they
             * (should) have mean == 0, so we can't use that to normalize
             */
            afwMath::Statistics stats = afwMath::makeStatistics(*eImage, (afwMath::MIN | afwMath::MAX));
            double const min = stats.getValue(afwMath::MIN);
            double const max = stats.getValue(afwMath::MAX);
 
            double const extreme = (fabs(min) > max) ? min :max;
            if (extreme != 0.0) {
                *eImage /= extreme;
            }
        }
    }

getDimensions()

template<typename ImageT >

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

inlineinherited

Return the dimension of the images being analyzed.

Definition at line 75 of file ImagePca.h.

{ return _dimensions; }

getEigenImages()

template<typename ImageT >

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

inlineinherited

Return Eigen images.

Definition at line 100 of file ImagePca.h.

{ return _eigenImages; }

getEigenValues()

template<typename ImageT >

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

inlineinherited

Return Eigen values.

Definition at line 98 of file ImagePca.h.

{ return _eigenValues; }

getImageList()

template<typename ImageT >

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

inherited

Return the list of images being analyzed.

Definition at line 85 of file ImagePca.cc.

                                                                        {
    return _imageList;
}

getMean()

template<typename ImageT >

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

inherited

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

Definition at line 90 of file ImagePca.cc.

                                                      {
    if (_imageList.empty()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError, "You haven't provided any images");
    }
 
    std::shared_ptr<ImageT> mean(new ImageT(getDimensions()));
    *mean = static_cast<typename ImageT::Pixel>(0);
 
    for (typename ImageList::const_iterator ptr = _imageList.begin(), end = _imageList.end(); ptr != end;
         ++ptr) {
        *mean += **ptr;
    }
    *mean /= _imageList.size();
 
    return mean;
}

updateBadPixels()

template<typename ImageT >

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

virtualinherited

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

mask	Mask defining bad pixels
ncomp	Number 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.

                                                                            {
    return do_updateBadPixels<ImageT>(typename ImageT::image_category(), _imageList, _fluxList, _eigenImages,
                                      mask, ncomp);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_diffim/22.0.1-24-g1ad7a390+a9625a72a8/include/lsst/ip/diffim/KernelPca.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_diffim/22.0.1-24-g1ad7a390+a9625a72a8/src/KernelPca.cc