reco::PrincipalComponents Class Reference

#include <Cluster3D.h>

Public Types
using	EigenValues = Eigen::Vector3f
using	EigenVectors = Eigen::Matrix3f

Public Member Functions
	PrincipalComponents ()
	PrincipalComponents (bool ok, int nHits, const EigenValues &eigenValues, const EigenVectors &eigenVecs, const Eigen::Vector3f &avePos, const float aveHitDoca=9999.)
bool	getSvdOK () const
int	getNumHitsUsed () const
const EigenValues &	getEigenValues () const
const EigenVectors &	getEigenVectors () const
const Eigen::Vector3f &	getAvePosition () const
const float	getAveHitDoca () const
void	flipAxis (size_t axis)
void	setAveHitDoca (double doca) const

Private Attributes
bool	m_svdOK
	SVD Decomposition was successful. More...
int	m_numHitsUsed
	Number of hits in the decomposition. More...
EigenValues	m_eigenValues
	Eigen values from SVD decomposition. More...
EigenVectors	m_eigenVectors
	The three principle axes. More...
Eigen::Vector3f	m_avePosition
	Average position of hits fed to PCA. More...
double	m_aveHitDoca
	Average doca of hits used in PCA. More...

Friends
std::ostream &	operator<< (std::ostream &o, const PrincipalComponents &a)
bool	operator< (const PrincipalComponents &a, const PrincipalComponents &b)

Detailed Description

Definition at line 222 of file Cluster3D.h.

Member Typedef Documentation

using reco::PrincipalComponents::EigenValues = Eigen::Vector3f

Definition at line 226 of file Cluster3D.h.

using reco::PrincipalComponents::EigenVectors = Eigen::Matrix3f

Definition at line 227 of file Cluster3D.h.

Constructor & Destructor Documentation

reco::PrincipalComponents::PrincipalComponents

(

)

Definition at line 190 of file Cluster3D.cxx.

                                         :
       m_svdOK(false),
       m_numHitsUsed(0),
       m_eigenValues(EigenValues::Zero()),
       m_eigenVectors(EigenVectors::Zero()),
       m_avePosition(Eigen::Vector3f::Zero()),
       m_aveHitDoca(9999.)
{}

reco::PrincipalComponents::PrincipalComponents	(	bool	ok,
		int	nHits,
		const EigenValues &	eigenValues,
		const EigenVectors &	eigenVecs,
		const Eigen::Vector3f &	avePos,
		const float	aveHitDoca = 9999.
	)

Definition at line 199 of file Cluster3D.cxx.

                                                                                                                                                                               :
           m_svdOK(ok),
           m_numHitsUsed(nHits),
           m_eigenValues(eigenValues),
           m_eigenVectors(eigenVecs),
           m_avePosition(avePos),
           m_aveHitDoca(aveHitDoca)
{}

Member Function Documentation

void reco::PrincipalComponents::flipAxis

(

size_t

axis

)

Definition at line 208 of file Cluster3D.cxx.

{
    m_eigenVectors.row(axisDir) = -m_eigenVectors.row(axisDir);

    return;
}

const float reco::PrincipalComponents::getAveHitDoca ( ) const

inline

Definition at line 249 of file Cluster3D.h.

{return m_aveHitDoca;}

const Eigen::Vector3f& reco::PrincipalComponents::getAvePosition ( ) const

inline

Definition at line 248 of file Cluster3D.h.

{return m_avePosition;}

const EigenValues& reco::PrincipalComponents::getEigenValues ( ) const

inline

Definition at line 246 of file Cluster3D.h.

{return m_eigenValues;}

const EigenVectors& reco::PrincipalComponents::getEigenVectors ( ) const

inline

Definition at line 247 of file Cluster3D.h.

{return m_eigenVectors;}

int reco::PrincipalComponents::getNumHitsUsed ( ) const

inline

Definition at line 245 of file Cluster3D.h.

{return m_numHitsUsed;}

bool reco::PrincipalComponents::getSvdOK ( ) const

inline

Definition at line 244 of file Cluster3D.h.

{return m_svdOK;}

void reco::PrincipalComponents::setAveHitDoca ( double  doca ) const

inline

Definition at line 252 of file Cluster3D.h.

{m_aveHitDoca = doca;}

Friends And Related Function Documentation

bool operator< ( const PrincipalComponents &  a, const PrincipalComponents &  b  )

friend

Definition at line 235 of file Cluster3D.cxx.

{
    if (a.m_svdOK && b.m_svdOK)
        return a.m_eigenValues(0) > b.m_eigenValues(0);

    return false; //They are equal
}

std::ostream& operator<< ( std::ostream &  o, const PrincipalComponents &  a  )

friend

Definition at line 215 of file Cluster3D.cxx.

{
    if (a.m_svdOK)
    {
        o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
        o << " PCAxis ID run with " << a.m_numHitsUsed << " space points" << std::endl;
        o << "   - center position: " << std::setw(6) << a.m_avePosition(0) << ", " << a.m_avePosition(1) << ", " << a.m_avePosition(2) << std::endl;
        o << "   - eigen values: " << std::setw(8) << std::right << a.m_eigenValues(0) << ", "
        << a.m_eigenValues(1) << ", " << a.m_eigenValues(1) << std::endl;
        o << "   - average doca: " << a.m_aveHitDoca << std::endl;
        o << "   - Principle axis: " << std::setw(7) << std::setprecision(4) << a.m_eigenVectors(0,0) << ", " << a.m_eigenVectors(0,1) << ", " << a.m_eigenVectors(0,2) << std::endl;
        o << "   - second axis:    " << std::setw(7) << std::setprecision(4) << a.m_eigenVectors(1,0) << ", " << a.m_eigenVectors(1,1) << ", " << a.m_eigenVectors(1,2) << std::endl;
        o << "   - third axis:     " << std::setw(7) << std::setprecision(4) << a.m_eigenVectors(2,0) << ", " << a.m_eigenVectors(2,1) << ", " << a.m_eigenVectors(2,2) << std::endl;
    }
    else
        o << " Principal Components Axis is not valid" << std::endl;

    return o;
}

Member Data Documentation

double reco::PrincipalComponents::m_aveHitDoca

mutableprivate

Average doca of hits used in PCA.

Definition at line 238 of file Cluster3D.h.

Eigen::Vector3f reco::PrincipalComponents::m_avePosition

private

Average position of hits fed to PCA.

Definition at line 237 of file Cluster3D.h.

EigenValues reco::PrincipalComponents::m_eigenValues

private

Eigen values from SVD decomposition.

Definition at line 235 of file Cluster3D.h.

EigenVectors reco::PrincipalComponents::m_eigenVectors

private

The three principle axes.

Definition at line 236 of file Cluster3D.h.

int reco::PrincipalComponents::m_numHitsUsed

private

Number of hits in the decomposition.

Definition at line 234 of file Cluster3D.h.

bool reco::PrincipalComponents::m_svdOK

private

SVD Decomposition was successful.

Definition at line 233 of file Cluster3D.h.

---

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

• larreco/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.h
• larreco/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.cxx