lsst::ip::diffim::KernelSolution Class Reference

#include <KernelSolution.h>

Inheritance diagram for lsst::ip::diffim::KernelSolution:

Public Types
enum	KernelSolvedBy {   NONE = 0, CHOLESKY_LDLT = 1, CHOLESKY_LLT = 2, LU = 3,   EIGENVECTOR = 4 }
enum	ConditionNumberType { EIGENVALUE = 0, SVD = 1 }
typedef boost::shared_ptr < KernelSolution >	Ptr
typedef lsst::afw::math::Kernel::Pixel	PixelT
typedef lsst::afw::image::Image < lsst::afw::math::Kernel::Pixel >	ImageT

Public Member Functions
	KernelSolution (boost::shared_ptr< Eigen::MatrixXd > mMat, boost::shared_ptr< Eigen::VectorXd > bVec, bool fitForBackground)
	KernelSolution (bool fitForBackground)
	KernelSolution ()
virtual	~KernelSolution ()
virtual void	solve ()
virtual void	solve (Eigen::MatrixXd mMat, Eigen::VectorXd bVec)
KernelSolvedBy	getSolvedBy ()
virtual double	getConditionNumber (ConditionNumberType conditionType)
virtual double	getConditionNumber (Eigen::MatrixXd mMat, ConditionNumberType conditionType)
boost::shared_ptr < Eigen::MatrixXd >	getM ()
boost::shared_ptr < Eigen::VectorXd >	getB ()
void	printM ()
void	printB ()
void	printA ()
int	getId () const

Protected Attributes
int	_id
	Unique ID for object. More...
boost::shared_ptr < Eigen::MatrixXd >	_mMat
	Derived least squares M matrix. More...
boost::shared_ptr < Eigen::VectorXd >	_bVec
	Derived least squares B vector. More...
boost::shared_ptr < Eigen::VectorXd >	_aVec
	Derived least squares solution matrix. More...
KernelSolvedBy	_solvedBy
	Type of algorithm used to make solution. More...
bool	_fitForBackground
	Background terms included in fit. More...

Static Protected Attributes
static int	_SolutionId = 0
	Unique identifier for solution. More...

Detailed Description

Definition at line 30 of file KernelSolution.h.

Member Typedef Documentation

typedef lsst::afw::image::Image<lsst::afw::math::Kernel::Pixel> lsst::ip::diffim::KernelSolution::ImageT

Definition at line 34 of file KernelSolution.h.

typedef lsst::afw::math::Kernel::Pixel lsst::ip::diffim::KernelSolution::PixelT

Definition at line 33 of file KernelSolution.h.

typedef boost::shared_ptr<KernelSolution> lsst::ip::diffim::KernelSolution::Ptr

Definition at line 32 of file KernelSolution.h.

Member Enumeration Documentation

enum lsst::ip::diffim::KernelSolution::ConditionNumberType

Enumerator
EIGENVALUE
SVD

Definition at line 44 of file KernelSolution.h.

                                 {
            EIGENVALUE = 0,
            SVD        = 1
        };

enum lsst::ip::diffim::KernelSolution::KernelSolvedBy

Enumerator
NONE
CHOLESKY_LDLT
CHOLESKY_LLT
LU
EIGENVECTOR

Definition at line 36 of file KernelSolution.h.

                            {
            NONE          = 0,
            CHOLESKY_LDLT = 1,
            CHOLESKY_LLT  = 2,
            LU            = 3,
            EIGENVECTOR   = 4
        };

Constructor & Destructor Documentation

lsst::ip::diffim::KernelSolution::KernelSolution ( boost::shared_ptr< Eigen::MatrixXd >  mMat, boost::shared_ptr< Eigen::VectorXd >  bVec, bool  fitForBackground  )

explicit

Definition at line 57 of file KernelSolution.cc.

          :
        _id(++_SolutionId),
        _mMat(mMat),
        _bVec(bVec),
        _aVec(),
        _solvedBy(NONE),
        _fitForBackground(fitForBackground)
    {};

lsst::ip::diffim::KernelSolution::KernelSolution ( bool  fitForBackground )

explicit

Definition at line 70 of file KernelSolution.cc.

          :
        _id(++_SolutionId),
        _mMat(),
        _bVec(),
        _aVec(),
        _solvedBy(NONE),
        _fitForBackground(fitForBackground)
    {};

lsst::ip::diffim::KernelSolution::KernelSolution ( )

explicit

Definition at line 81 of file KernelSolution.cc.

                                   :
        _id(++_SolutionId),
        _mMat(),
        _bVec(),
        _aVec(),
        _solvedBy(NONE),
        _fitForBackground(true)
    {};

virtual lsst::ip::diffim::KernelSolution::~KernelSolution ( )

inlinevirtual

Definition at line 55 of file KernelSolution.h.

{};

Member Function Documentation

boost::shared_ptr<Eigen::VectorXd> lsst::ip::diffim::KernelSolution::getB ( )

inline

Definition at line 64 of file KernelSolution.h.

{return _bVec;}

double lsst::ip::diffim::KernelSolution::getConditionNumber ( ConditionNumberType  conditionType )

virtual

Definition at line 94 of file KernelSolution.cc.

                                                                               {
        return getConditionNumber(*_mMat, conditionType);
    }

double lsst::ip::diffim::KernelSolution::getConditionNumber ( Eigen::MatrixXd  mMat, ConditionNumberType  conditionType  )

virtual

Definition at line 98 of file KernelSolution.cc.

                                                                                 {
        switch (conditionType) {
        case EIGENVALUE: 
            {
            Eigen::SelfAdjointEigenSolver<Eigen::MatrixXd> eVecValues(mMat);
            Eigen::VectorXd eValues = eVecValues.eigenvalues();
            double eMax = eValues.maxCoeff();
            double eMin = eValues.minCoeff();
            pexLog::TTrace<5>("lsst.ip.diffim.KernelSolution.getConditionNumber", 
                              "EIGENVALUE eMax / eMin = %.3e", eMax / eMin);
            return (eMax / eMin);
            break;
            }
        case SVD: 
            {
            Eigen::VectorXd sValues = mMat.jacobiSvd().singularValues();
            double sMax = sValues.maxCoeff();
            double sMin = sValues.minCoeff();
            pexLog::TTrace<5>("lsst.ip.diffim.KernelSolution.getConditionNumber", 
                              "SVD eMax / eMin = %.3e", sMax / sMin);
            return (sMax / sMin);
            break;
            }
        default:
            {
            throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                              "Undefined ConditionNumberType : only EIGENVALUE, SVD allowed.");
            break;
            }
        }
    }

int lsst::ip::diffim::KernelSolution::getId ( ) const

inline

Definition at line 68 of file KernelSolution.h.

{ return _id; }

boost::shared_ptr<Eigen::MatrixXd> lsst::ip::diffim::KernelSolution::getM ( )

inline

Definition at line 63 of file KernelSolution.h.

{return _mMat;}

KernelSolvedBy lsst::ip::diffim::KernelSolution::getSolvedBy ( )

inline

Definition at line 59 of file KernelSolution.h.

{return _solvedBy;} 

void lsst::ip::diffim::KernelSolution::printA ( )

inline

Definition at line 67 of file KernelSolution.h.

{std::cout << *_aVec << std::endl;}

void lsst::ip::diffim::KernelSolution::printB ( )

inline

Definition at line 66 of file KernelSolution.h.

{std::cout << *_bVec << std::endl;}

void lsst::ip::diffim::KernelSolution::printM ( )

inline

Definition at line 65 of file KernelSolution.h.

{std::cout << *_mMat << std::endl;}

void lsst::ip::diffim::KernelSolution::solve ( )

virtual

Reimplemented in lsst::ip::diffim::SpatialKernelSolution, lsst::ip::diffim::RegularizedKernelSolution< InputT >, and lsst::ip::diffim::StaticKernelSolution< InputT >.

Definition at line 90 of file KernelSolution.cc.

                               {
        solve(*_mMat, *_bVec);
    }

void lsst::ip::diffim::KernelSolution::solve ( Eigen::MatrixXd  mMat, Eigen::VectorXd  bVec  )

virtual

Definition at line 131 of file KernelSolution.cc.

                                                   {
        
        if (DEBUG_MATRIX) {
            std::cout << "M " << std::endl;
            std::cout << mMat << std::endl;
            std::cout << "B " << std::endl;
            std::cout << bVec << std::endl;
        }

        Eigen::VectorXd aVec = Eigen::VectorXd::Zero(bVec.size());

        boost::timer t;
        t.restart();

        pexLog::TTrace<4>("lsst.ip.difim.KernelSolution.solve", 
                          "Solving for kernel");
                _solvedBy = LU;
                Eigen::FullPivLU<Eigen::MatrixXd> lu(mMat);
                if (lu.isInvertible()) {
                        aVec = lu.solve(bVec);
                } else {
                        pexLog::TTrace<5>("lsst.ip.diffim.KernelSolution.solve", 
                                                          "Unable to determine kernel via LU");
                        /* LAST RESORT */
                        try {
                                
                                _solvedBy = EIGENVECTOR;
                                Eigen::SelfAdjointEigenSolver<Eigen::MatrixXd> eVecValues(mMat);
                                Eigen::MatrixXd const& rMat = eVecValues.eigenvectors();
                                Eigen::VectorXd eValues = eVecValues.eigenvalues();
                                
                                for (int i = 0; i != eValues.rows(); ++i) {
                                        if (eValues(i) != 0.0) {
                                                eValues(i) = 1.0/eValues(i);
                                        }
                                }
                                
                                aVec = rMat * eValues.asDiagonal() * rMat.transpose() * bVec;
                        } catch (pexExcept::Exception& e) {
                                
                                _solvedBy = NONE;
                                pexLog::TTrace<5>("lsst.ip.diffim.KernelSolution.solve", 
                                                                  "Unable to determine kernel via eigen-values");
                                
                                throw LSST_EXCEPT(pexExcept::Exception, "Unable to determine kernel solution");
                        }
                }

        double time = t.elapsed();
        pexLog::TTrace<5>("lsst.ip.diffim.KernelSolution.solve", 
                          "Compute time for matrix math : %.2f s", time);

        if (DEBUG_MATRIX) {
                  std::cout << "A " << std::endl;
            std::cout << aVec << std::endl;
        }
        
        _aVec = boost::shared_ptr<Eigen::VectorXd>(new Eigen::VectorXd(aVec));
    }

Member Data Documentation

boost::shared_ptr<Eigen::VectorXd> lsst::ip::diffim::KernelSolution::_aVec

protected

Derived least squares solution matrix.

Definition at line 74 of file KernelSolution.h.

boost::shared_ptr<Eigen::VectorXd> lsst::ip::diffim::KernelSolution::_bVec

protected

Derived least squares B vector.

Definition at line 73 of file KernelSolution.h.

bool lsst::ip::diffim::KernelSolution::_fitForBackground

protected

Background terms included in fit.

Definition at line 76 of file KernelSolution.h.

int lsst::ip::diffim::KernelSolution::_id

protected

Unique ID for object.

Definition at line 71 of file KernelSolution.h.

boost::shared_ptr<Eigen::MatrixXd> lsst::ip::diffim::KernelSolution::_mMat

protected

Derived least squares M matrix.

Definition at line 72 of file KernelSolution.h.

int lsst::ip::diffim::KernelSolution::_SolutionId = 0

staticprotected

Unique identifier for solution.

Definition at line 77 of file KernelSolution.h.

KernelSolvedBy lsst::ip::diffim::KernelSolution::_solvedBy

protected

Type of algorithm used to make solution.

Definition at line 75 of file KernelSolution.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ip_diffim/master-gcec1da163f+63/include/lsst/ip/diffim/KernelSolution.h
• /lsst/home/lsstsw/stack/Linux64/ip_diffim/master-gcec1da163f+63/src/KernelSolution.cc