#include "Cluster3D.h"

Public Types
typedef std::vector< std::vector< float > >	EigenVectors

Public Member Functions
	PrincipalComponents ()

	PrincipalComponents (bool ok, int nHits, const float eigenValues, const EigenVectors &eigenVecs, const float avePos, const float aveHitDoca=9999.)

bool	getSvdOK () const

int	getNumHitsUsed () const

const float *	getEigenValues () const

const EigenVectors &	getEigenVectors () const

const float *	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...

float	m_eigenValues [3]
	Eigen values from SVD decomposition. More...

EigenVectors	m_eigenVectors
	The three principle axes. More...

float	m_avePosition [3]
	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 203 of file Cluster3D.h.

Member Typedef Documentation

typedef std::vector<std::vector<float> > reco::PrincipalComponents::EigenVectors

Definition at line 207 of file Cluster3D.h.

Constructor & Destructor Documentation

reco::PrincipalComponents::PrincipalComponents ( )

Definition at line 173 of file Cluster3D.cxx.

                                          :
        m_svdOK(false),
        m_numHitsUsed(0),
        m_eigenValues{0.,0.,0.},
        m_avePosition{0.,0.,0.},
        m_aveHitDoca(9999.)
 {}    

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

Definition at line 181 of file Cluster3D.cxx.

References m_avePosition, and m_eigenValues.

                                                                                                                                                                  :
            m_svdOK(ok),
            m_numHitsUsed(nHits),
            m_eigenVectors(eigenVecs),
            m_aveHitDoca(aveHitDoca)
 {
     m_eigenValues[0]     = eigenValues[0];
     m_eigenValues[1]     = eigenValues[1];
     m_eigenValues[2]     = eigenValues[2];
     m_avePosition[0]     = avePos[0];
     m_avePosition[1]     = avePos[1];
     m_avePosition[2]     = avePos[2];
 }

Member Function Documentation

void reco::PrincipalComponents::flipAxis ( size_t axis )

Definition at line 195 of file Cluster3D.cxx.

References m_eigenVectors.

Referenced by lar_cluster3d::PCASeedFinderAlg::findTrackSeeds(), lar_cluster3d::ParallelHitsSeedFinderAlg::findTrackSeeds(), and lar_cluster3d::PCASeedFinderAlg::getHitsAtEnd().

 {
     std::vector<float>& axis = m_eigenVectors.at(axisDir);
     
     for(auto& val : axis) val *= -1.;
     
     return;
 }

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

inline

Definition at line 229 of file Cluster3D.h.

Referenced by lar_cluster3d::ClusterPathFinder::breakIntoTinyBits(), lar_cluster3d::VoronoiPathFinder::breakIntoTinyBits(), lar_cluster3d::HoughSeedFinderAlg::buildSeed(), lar_cluster3d::Cluster3D::ConvertToArtOutput(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis(), lar_cluster3d::Cluster3D::ProduceArtClusters(), and lar_cluster3d::Cluster3D::splitClustersWithHough().

229 {return m_aveHitDoca;}

reco::PrincipalComponents::m_aveHitDoca

double m_aveHitDoca

Average doca of hits used in PCA.

Definition: Cluster3D.h:218

const float* reco::PrincipalComponents::getAvePosition ( ) const

inline

Definition at line 228 of file Cluster3D.h.

228 {return m_avePosition;}

reco::PrincipalComponents::m_avePosition

float m_avePosition[3]

Average position of hits fed to PCA.

Definition: Cluster3D.h:217

const float* reco::PrincipalComponents::getEigenValues ( ) const

inline

Definition at line 226 of file Cluster3D.h.

226 {return m_eigenValues;}

reco::PrincipalComponents::m_eigenValues

float m_eigenValues[3]

Eigen values from SVD decomposition.

Definition: Cluster3D.h:215

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

inline

Definition at line 227 of file Cluster3D.h.

227 {return m_eigenVectors;}

reco::PrincipalComponents::m_eigenVectors

EigenVectors m_eigenVectors

The three principle axes.

Definition: Cluster3D.h:216

int reco::PrincipalComponents::getNumHitsUsed ( ) const

inline

Definition at line 225 of file Cluster3D.h.

Referenced by lar_cluster3d::ClusterPathFinder::breakIntoTinyBits(), lar_cluster3d::VoronoiPathFinder::breakIntoTinyBits(), lar_cluster3d::Cluster3D::ConvertToArtOutput(), and lar_cluster3d::Cluster3D::ProduceArtClusters().

225 {return m_numHitsUsed;}

reco::PrincipalComponents::m_numHitsUsed

int m_numHitsUsed

Number of hits in the decomposition.

Definition: Cluster3D.h:214

bool reco::PrincipalComponents::getSvdOK ( ) const

inline

Definition at line 224 of file Cluster3D.h.

Referenced by lar_cluster3d::ClusterPathFinder::breakIntoTinyBits(), lar_cluster3d::VoronoiPathFinder::breakIntoTinyBits(), lar_cluster3d::ClusterParamsBuilder::BuildClusterInfo(), lar_cluster3d::HoughSeedFinderAlg::buildSeed(), lar_cluster3d::MinSpanTreeAlg::CheckHitSorting(), lar_cluster3d::Cluster3D::ConvertToArtOutput(), lar_cluster3d::ClusterParamsBuilder::FillClusterParams(), lar_cluster3d::MinSpanTreeAlg::FindBestPathInCluster(), lar_cluster3d::HoughSeedFinderAlg::findHitGaps(), lar_cluster3d::HoughSeedFinderAlg::findTrackSeeds(), lar_cluster3d::ParallelHitsSeedFinderAlg::findTrackSeeds(), lar_cluster3d::PCASeedFinderAlg::getHitsAtEnd(), lar_cluster3d::ClusterMergeAlg::mergeClusters(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis(), lar_cluster3d::Cluster3D::ProduceArtClusters(), and lar_cluster3d::Cluster3D::splitClustersWithHough().

224 {return m_svdOK;}

reco::PrincipalComponents::m_svdOK

bool m_svdOK

SVD Decomposition was successful.

Definition: Cluster3D.h:213

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

inline

Definition at line 232 of file Cluster3D.h.

References reco::ClusterHit2D::operator<, and reco::ClusterHit2D::operator<<.

Referenced by lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_calc2DDocas(), and lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_calc3DDocas().

232 {m_aveHitDoca = doca;}

reco::PrincipalComponents::m_aveHitDoca

double m_aveHitDoca

Average doca of hits used in PCA.

Definition: Cluster3D.h:218

Friends And Related Function Documentation

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

friend

Definition at line 224 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 204 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[2] << 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 218 of file Cluster3D.h.

Referenced by reco::operator<<().

float reco::PrincipalComponents::m_avePosition[3]

private

Average position of hits fed to PCA.

Definition at line 217 of file Cluster3D.h.

Referenced by reco::operator<<(), and PrincipalComponents().

float reco::PrincipalComponents::m_eigenValues[3]

private

Eigen values from SVD decomposition.

Definition at line 215 of file Cluster3D.h.

Referenced by reco::operator<(), reco::operator<<(), and PrincipalComponents().

EigenVectors reco::PrincipalComponents::m_eigenVectors

private

The three principle axes.

Definition at line 216 of file Cluster3D.h.

Referenced by flipAxis(), and reco::operator<<().

int reco::PrincipalComponents::m_numHitsUsed

private

Number of hits in the decomposition.

Definition at line 214 of file Cluster3D.h.

Referenced by reco::operator<<().

bool reco::PrincipalComponents::m_svdOK

private

SVD Decomposition was successful.

Definition at line 213 of file Cluster3D.h.

Referenced by reco::operator<(), and reco::operator<<().

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

larreco/v06_64_02/source/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.h
larreco/v06_64_02/source/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.cxx

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation