#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 std::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 (Eigen::MatrixXd mMat, Eigen::VectorXd bVec, bool fitForBackground)

	KernelSolution (bool fitForBackground)

	KernelSolution ()

virtual	~KernelSolution ()

virtual void	solve ()

virtual void	solve (Eigen::MatrixXd const &mMat, Eigen::VectorXd const &bVec)

KernelSolvedBy	getSolvedBy ()

virtual double	getConditionNumber (ConditionNumberType conditionType)

virtual double	getConditionNumber (Eigen::MatrixXd const &mMat, ConditionNumberType conditionType)

Eigen::MatrixXd const &	getM ()

Eigen::VectorXd const &	getB ()

void	printM ()

void	printB ()

void	printA ()

int	getId () const

Protected Attributes
int	_id
	Unique ID for object. More...

Eigen::MatrixXd	_mMat
	Derived least squares M matrix. More...

Eigen::VectorXd	_bVec
	Derived least squares B vector. More...

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 31 of file KernelSolution.h.

Member Typedef Documentation

◆ ImageT

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

Definition at line 35 of file KernelSolution.h.

◆ PixelT

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

Definition at line 34 of file KernelSolution.h.

◆ Ptr

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

Definition at line 33 of file KernelSolution.h.

Member Enumeration Documentation

◆ ConditionNumberType

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

Enumerator
EIGENVALUE
SVD

Definition at line 45 of file KernelSolution.h.

                                  {
             EIGENVALUE = 0,
             SVD        = 1
         };

◆ KernelSolvedBy

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

Enumerator
NONE
CHOLESKY_LDLT
CHOLESKY_LLT
LU
EIGENVECTOR

Definition at line 37 of file KernelSolution.h.

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

Constructor & Destructor Documentation

◆ KernelSolution() [1/3]

lsst::ip::diffim::KernelSolution::KernelSolution	(	Eigen::MatrixXd	mMat,
		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)
     {};

◆ KernelSolution() [2/3]

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)
     {};

◆ KernelSolution() [3/3]

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

explicit

Definition at line 81 of file KernelSolution.cc.

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

◆ ~KernelSolution()

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

inlinevirtual

Definition at line 56 of file KernelSolution.h.

56 {};

Member Function Documentation

◆ getB()

Eigen::VectorXd const& lsst::ip::diffim::KernelSolution::getB ( )

inline

Definition at line 65 of file KernelSolution.h.

65 {return _bVec;}

◆ getConditionNumber() [1/2]

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

virtual

Definition at line 94 of file KernelSolution.cc.

                                                                                {
         return getConditionNumber(_mMat, conditionType);
     }

◆ getConditionNumber() [2/2]

double lsst::ip::diffim::KernelSolution::getConditionNumber	(	Eigen::MatrixXd const &	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();
             LOGL_DEBUG("TRACE3.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();
             LOGL_DEBUG("TRACE3.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;
             }
         }
     }

◆ getId()

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

inline

Definition at line 69 of file KernelSolution.h.

69 { return _id; }

◆ getM()

Eigen::MatrixXd const& lsst::ip::diffim::KernelSolution::getM ( )

inline

Definition at line 64 of file KernelSolution.h.

64 {return _mMat;}

◆ getSolvedBy()

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

inline

Definition at line 60 of file KernelSolution.h.

60 {return _solvedBy;}

◆ printA()

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

inline

Definition at line 68 of file KernelSolution.h.

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

std::cout

std::endl

T endl(T... args)

◆ printB()

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

inline

Definition at line 67 of file KernelSolution.h.

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

◆ printM()

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

inline

Definition at line 66 of file KernelSolution.h.

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

◆ solve() [1/2]

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);
     }

◆ solve() [2/2]

void lsst::ip::diffim::KernelSolution::solve	(	Eigen::MatrixXd const &	mMat,
		Eigen::VectorXd const &	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();
  
         LOGL_DEBUG("TRACE2.ip.diffim.KernelSolution.solve",
                    "Solving for kernel");
                 _solvedBy = LU;
                 Eigen::FullPivLU<Eigen::MatrixXd> lu(mMat);
                 if (lu.isInvertible()) {
                         aVec = lu.solve(bVec);
                 } else {
                         LOGL_DEBUG("TRACE3.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;
                                 LOGL_DEBUG("TRACE3.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();
         LOGL_DEBUG("TRACE3.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 = aVec;
     }

Member Data Documentation

◆ _aVec

Eigen::VectorXd lsst::ip::diffim::KernelSolution::_aVec

protected

Derived least squares solution matrix.

Definition at line 75 of file KernelSolution.h.

◆ _bVec

Eigen::VectorXd lsst::ip::diffim::KernelSolution::_bVec

protected

Derived least squares B vector.

Definition at line 74 of file KernelSolution.h.

◆ _fitForBackground

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

protected

Background terms included in fit.

Definition at line 77 of file KernelSolution.h.

◆ _id

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

protected

Unique ID for object.

Definition at line 72 of file KernelSolution.h.

◆ _mMat

Eigen::MatrixXd lsst::ip::diffim::KernelSolution::_mMat

protected

Derived least squares M matrix.

Definition at line 73 of file KernelSolution.h.

◆ _SolutionId

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

staticprotected

Unique identifier for solution.

Definition at line 78 of file KernelSolution.h.

◆ _solvedBy

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

protected

Type of algorithm used to make solution.

Definition at line 76 of file KernelSolution.h.

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-19-gb93eaa13+aab3ef7709/include/lsst/ip/diffim/KernelSolution.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_diffim/22.0.1-19-gb93eaa13+aab3ef7709/src/KernelSolution.cc

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ImageT

◆ PixelT

◆ Ptr

Member Enumeration Documentation

◆ ConditionNumberType

◆ KernelSolvedBy

Constructor & Destructor Documentation

◆ KernelSolution() [1/3]

◆ KernelSolution() [2/3]

◆ KernelSolution() [3/3]

◆ ~KernelSolution()

Member Function Documentation

◆ getB()

◆ getConditionNumber() [1/2]

◆ getConditionNumber() [2/2]

◆ getId()

◆ getM()

◆ getSolvedBy()

◆ printA()

◆ printB()

◆ printM()

◆ solve() [1/2]

◆ solve() [2/2]

Member Data Documentation

◆ _aVec

◆ _bVec

◆ _fitForBackground

◆ _id

◆ _mMat

◆ _SolutionId

◆ _solvedBy