#include "PCAxis.h"

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

Public Member Functions
	PCAxis ()

	PCAxis (bool ok, int nHits, const double eigenValues, const EigenVectors &eigenVecs, const double avePos, const double aveHitDoca=9999., size_t id=0)

bool	getSvdOK () const

int	getNumHitsUsed () const

const double *	getEigenValues () const

const EigenVectors &	getEigenVectors () const

const double *	getAvePosition () const

double	getAveHitDoca () const

size_t	getID () const

Private Attributes
bool	fSvdOK
	SVD Decomposition was successful. More...

int	fNumHitsUsed
	Number of hits in the decomposition. More...

double	fEigenValues [3]
	Eigen values from SVD decomposition. More...

EigenVectors	fEigenVectors
	The three principle axes. More...

double	fAvePosition [3]
	Average position of hits fed to PCA. More...

double	fAveHitDoca
	Average doca of hits used in PCA. More...

size_t	fID
	axis ID More...

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

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

Detailed Description

Definition at line 24 of file PCAxis.h.

Member Typedef Documentation

typedef std::vector<std::vector<double> > recob::PCAxis::EigenVectors

Definition at line 26 of file PCAxis.h.

Constructor & Destructor Documentation

recob::PCAxis::PCAxis ( )

Definition at line 20 of file PCAxis.cxx.

20 {}

recob::PCAxis::PCAxis	(	bool	ok,
		int	nHits,
		const double *	eigenValues,
		const EigenVectors &	eigenVecs,
		const double *	avePos,
		const double	aveHitDoca = `9999.`,
		size_t	id = `0`
	)

Definition at line 23 of file PCAxis.cxx.

References fAvePosition, and fEigenValues.

     : fSvdOK(ok), fNumHitsUsed(nHits), fEigenVectors(eigenVecs), fAveHitDoca(aveHitDoca), fID(id)
   {
     fEigenValues[0] = eigenValues[0];
     fEigenValues[1] = eigenValues[1];
     fEigenValues[2] = eigenValues[2];
     fAvePosition[0] = avePos[0];
     fAvePosition[1] = avePos[1];
     fAvePosition[2] = avePos[2];
   }

Member Function Documentation

double recob::PCAxis::getAveHitDoca ( ) const

inline

Definition at line 82 of file PCAxis.h.

References fAveHitDoca.

Referenced by recob::dumper::DumpPCAxis().

 {
   return fAveHitDoca;
 }

const double * recob::PCAxis::getAvePosition ( ) const

inline

Definition at line 78 of file PCAxis.h.

References fAvePosition.

Referenced by recob::dumper::DumpPCAxis(), and cosmic::CosmicPCAxisTagger::produce().

 {
   return fAvePosition;
 }

const double * recob::PCAxis::getEigenValues ( ) const

inline

Definition at line 70 of file PCAxis.h.

References fEigenValues.

Referenced by ShowerRecoTools::ShowerPCAEigenvalueLength::CalculateElement(), recob::dumper::DumpPCAxis(), and cosmic::CosmicPCAxisTagger::produce().

 {
   return fEigenValues;
 }

const recob::PCAxis::EigenVectors & recob::PCAxis::getEigenVectors ( ) const

inline

Definition at line 74 of file PCAxis.h.

References fEigenVectors.

Referenced by recob::dumper::DumpPCAxis(), ShowerRecoTools::ShowerPCADirection::GetPCAxisVector(), and cosmic::CosmicPCAxisTagger::produce().

 {
   return fEigenVectors;
 }

size_t recob::PCAxis::getID ( ) const

inline

Definition at line 86 of file PCAxis.h.

References fID.

Referenced by recob::dumper::DumpPCAxis(), and recob::operator<().

 {
   return fID;
 }

int recob::PCAxis::getNumHitsUsed ( ) const

inline

Definition at line 66 of file PCAxis.h.

References fNumHitsUsed.

Referenced by recob::dumper::DumpPCAxis().

 {
   return fNumHitsUsed;
 }

bool recob::PCAxis::getSvdOK ( ) const

inline

Definition at line 62 of file PCAxis.h.

References fSvdOK.

Referenced by recob::dumper::DumpPCAxis().

 {
   return fSvdOK;
 }

Friends And Related Function Documentation

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

friend

Definition at line 69 of file PCAxis.cxx.

   {
     if (a.getID() != b.getID()) return a.getID() < b.getID();
 
     return false; //They are equal
   }

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

friend

Definition at line 43 of file PCAxis.cxx.

   {
     if (a.fSvdOK) {
       o << std::setiosflags(std::ios::fixed) << std::setprecision(2);
       o << " PCAxis ID " << a.fID << " run with " << a.fNumHitsUsed << " space points" << std::endl;
       o << "   - center position: " << std::setw(6) << a.fAvePosition[0] << ", "
         << a.fAvePosition[1] << ", " << a.fAvePosition[2] << std::endl;
       o << "   - eigen values: " << std::setw(8) << std::right << a.fEigenValues[0] << ", "
         << a.fEigenValues[1] << ", " << a.fEigenValues[2] << std::endl;
       o << "   - average doca: " << a.fAveHitDoca << std::endl;
       o << "   - Principle axis: " << std::setw(7) << std::setprecision(4) << a.fEigenVectors[0][0]
         << ", " << a.fEigenVectors[0][1] << ", " << a.fEigenVectors[0][2] << std::endl;
       o << "   - second axis:    " << std::setw(7) << std::setprecision(4) << a.fEigenVectors[1][0]
         << ", " << a.fEigenVectors[1][1] << ", " << a.fEigenVectors[1][2] << std::endl;
       o << "   - third axis:     " << std::setw(7) << std::setprecision(4) << a.fEigenVectors[2][0]
         << ", " << a.fEigenVectors[2][1] << ", " << a.fEigenVectors[2][2] << std::endl;
     }
     else
       o << " Principal Components Axis is not valid" << std::endl;
 
     return o;
   }

Member Data Documentation

double recob::PCAxis::fAveHitDoca

private

Average doca of hits used in PCA.

Definition at line 36 of file PCAxis.h.

Referenced by getAveHitDoca(), and recob::operator<<().

double recob::PCAxis::fAvePosition[3]

private

Average position of hits fed to PCA.

Definition at line 35 of file PCAxis.h.

Referenced by getAvePosition(), recob::operator<<(), and PCAxis().

double recob::PCAxis::fEigenValues[3]

private

Eigen values from SVD decomposition.

Definition at line 33 of file PCAxis.h.

Referenced by getEigenValues(), recob::operator<<(), and PCAxis().

EigenVectors recob::PCAxis::fEigenVectors

private

The three principle axes.

Definition at line 34 of file PCAxis.h.

Referenced by getEigenVectors(), and recob::operator<<().

size_t recob::PCAxis::fID

private

axis ID

Definition at line 37 of file PCAxis.h.

Referenced by getID(), and recob::operator<<().

int recob::PCAxis::fNumHitsUsed

private

Number of hits in the decomposition.

Definition at line 32 of file PCAxis.h.

Referenced by getNumHitsUsed(), and recob::operator<<().

bool recob::PCAxis::fSvdOK

private

SVD Decomposition was successful.

Definition at line 31 of file PCAxis.h.

Referenced by getSvdOK(), and recob::operator<<().

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

lardataobj/v09_18_03/source/lardataobj/RecoBase/PCAxis.h
lardataobj/v09_18_03/source/lardataobj/RecoBase/PCAxis.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