LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
trkf::KHitBase Class Referenceabstract

#include "KHitBase.h"

Inheritance diagram for trkf::KHitBase:
trkf::KHit< 1 > trkf::KHit< N > trkf::KHitMulti trkf::KHitWireLine trkf::KHitWireX

Public Member Functions

 KHitBase ()
 Default constructor. More...
 
 KHitBase (const std::shared_ptr< const Surface > &psurf, int plane=-1)
 Initializing Constructor. More...
 
virtual ~KHitBase ()
 Destructor. More...
 
const std::shared_ptr< const Surface > & getPredSurface () const
 Predition surface. More...
 
double getPredDistance () const
 Prediction distance. More...
 
const std::shared_ptr< const Surface > & getMeasSurface () const
 Measurement surface. More...
 
int getMeasPlane () const
 Measurement plane index. More...
 
int getID () const
 Unique id. More...
 
void setMeasSurface (const std::shared_ptr< const Surface > &psurf)
 Measurement surface. More...
 
void setMeasPlane (int plane)
 Measurement plane. More...
 
virtual bool predict (const KETrack &tre, const Propagator *prop=0, const KTrack *ref=0) const =0
 Prediction method (return false if fail). More...
 
virtual double getChisq () const =0
 Return incremental chisquare. More...
 
virtual void update (KETrack &tre) const =0
 Update track method. More...
 
virtual std::ostream & Print (std::ostream &out, bool doTitle=true) const
 Printout. More...
 

Protected Attributes

std::shared_ptr< const SurfacefPredSurf
 Prediction surface. More...
 
double fPredDist
 Prediction distance. More...
 
int fID
 Unique id. More...
 

Private Attributes

std::shared_ptr< const SurfacefMeasSurf
 Measurement surface. More...
 
int fMeasPlane
 Measurement plane index. More...
 

Detailed Description

Definition at line 59 of file KHitBase.h.

Constructor & Destructor Documentation

trkf::KHitBase::KHitBase ( )

Default constructor.

Default Constructor.

Definition at line 16 of file KHitBase.cxx.

16  :
17  fPredDist(0.),
18  fID(0),
19  fMeasPlane(-1)
20  {}
int fID
Unique id.
Definition: KHitBase.h:118
double fPredDist
Prediction distance.
Definition: KHitBase.h:117
int fMeasPlane
Measurement plane index.
Definition: KHitBase.h:123
trkf::KHitBase::KHitBase ( const std::shared_ptr< const Surface > &  psurf,
int  plane = -1 
)

Initializing Constructor.

Initializing Constructor.

Arguments:

psurf - Measurement surface pointer.

Definition at line 28 of file KHitBase.cxx.

28  :
29  fPredDist(0.),
30  fID(0),
31  fMeasSurf(psurf),
32  fMeasPlane(plane)
33  {}
std::shared_ptr< const Surface > fMeasSurf
Measurement surface.
Definition: KHitBase.h:122
int fID
Unique id.
Definition: KHitBase.h:118
double fPredDist
Prediction distance.
Definition: KHitBase.h:117
int fMeasPlane
Measurement plane index.
Definition: KHitBase.h:123
trkf::KHitBase::~KHitBase ( )
virtual

Destructor.

Definition at line 36 of file KHitBase.cxx.

37  {}

Member Function Documentation

virtual double trkf::KHitBase::getChisq ( ) const
pure virtual
int trkf::KHitBase::getID ( ) const
inline
int trkf::KHitBase::getMeasPlane ( ) const
inline

Measurement plane index.

Definition at line 84 of file KHitBase.h.

References fMeasPlane.

Referenced by trkf::KalmanFilterAlg::buildTrack(), trkf::KalmanFilterAlg::cleanTrack(), trkf::KalmanFilterAlg::extendTrack(), and trkf::KGTrack::Print().

84 {return fMeasPlane;}
int fMeasPlane
Measurement plane index.
Definition: KHitBase.h:123
const std::shared_ptr<const Surface>& trkf::KHitBase::getMeasSurface ( ) const
inline

Measurement surface.

Definition at line 81 of file KHitBase.h.

References fMeasSurf.

Referenced by trkf::KHit< N >::predict(), trkf::KHitWireLine::subpredict(), and trkf::KHitWireX::subpredict().

81 {return fMeasSurf;}
std::shared_ptr< const Surface > fMeasSurf
Measurement surface.
Definition: KHitBase.h:122
double trkf::KHitBase::getPredDistance ( ) const
inline

Prediction distance.

Definition at line 78 of file KHitBase.h.

References fPredDist.

Referenced by trkf::KalmanFilterAlg::buildTrack(), and trkf::KalmanFilterAlg::extendTrack().

78 {return fPredDist;}
double fPredDist
Prediction distance.
Definition: KHitBase.h:117
const std::shared_ptr<const Surface>& trkf::KHitBase::getPredSurface ( ) const
inline

Predition surface.

Definition at line 75 of file KHitBase.h.

References fPredSurf.

Referenced by trkf::KHitMulti::update(), and trkf::KHit< N >::update().

75 {return fPredSurf;}
std::shared_ptr< const Surface > fPredSurf
Prediction surface.
Definition: KHitBase.h:116
virtual bool trkf::KHitBase::predict ( const KETrack tre,
const Propagator prop = 0,
const KTrack ref = 0 
) const
pure virtual
std::ostream & trkf::KHitBase::Print ( std::ostream &  out,
bool  doTitle = true 
) const
virtual

Printout.

Reimplemented in trkf::KHit< N >, trkf::KHit< 1 >, and trkf::KHitMulti.

Definition at line 40 of file KHitBase.cxx.

References fMeasPlane, fMeasSurf, fPredDist, and fPredSurf.

Referenced by trkf::operator<<(), trkf::KHit< N >::Print(), and setMeasPlane().

41  {
42  if(doTitle)
43  out << "KHitBase:\n";
44  out << " Measurement Surface: " << *fMeasSurf << "\n";
45  out << " Measurement Plane: " << fMeasPlane << "\n";
46  if(fPredSurf.get() != 0) {
47  out << " Prediction Surface: " << *fPredSurf << "\n";
48  out << " Prediction Distance: " << fPredDist << "\n";
49  }
50  return out;
51  }
std::shared_ptr< const Surface > fMeasSurf
Measurement surface.
Definition: KHitBase.h:122
std::shared_ptr< const Surface > fPredSurf
Prediction surface.
Definition: KHitBase.h:116
double fPredDist
Prediction distance.
Definition: KHitBase.h:117
int fMeasPlane
Measurement plane index.
Definition: KHitBase.h:123
void trkf::KHitBase::setMeasPlane ( int  plane)
inline

Measurement plane.

Definition at line 95 of file KHitBase.h.

References fMeasPlane, getChisq(), predict(), Print(), and update().

Referenced by trkf::KHitWireLine::KHitWireLine(), and trkf::KHitWireX::KHitWireX().

95 {fMeasPlane = plane;}
int fMeasPlane
Measurement plane index.
Definition: KHitBase.h:123
void trkf::KHitBase::setMeasSurface ( const std::shared_ptr< const Surface > &  psurf)
inline

Measurement surface.

Definition at line 92 of file KHitBase.h.

References fMeasSurf.

Referenced by trkf::KHitWireLine::KHitWireLine(), and trkf::KHitWireX::KHitWireX().

92 {fMeasSurf = psurf;}
std::shared_ptr< const Surface > fMeasSurf
Measurement surface.
Definition: KHitBase.h:122
virtual void trkf::KHitBase::update ( KETrack tre) const
pure virtual

Update track method.

Implemented in trkf::KHit< N >, trkf::KHit< 1 >, and trkf::KHitMulti.

Referenced by setMeasPlane(), and trkf::KalmanFilterAlg::smoothTrack().

Member Data Documentation

int trkf::KHitBase::fID
protected

Unique id.

Definition at line 118 of file KHitBase.h.

Referenced by getID(), trkf::KHitWireLine::KHitWireLine(), and trkf::KHitWireX::KHitWireX().

int trkf::KHitBase::fMeasPlane
private

Measurement plane index.

Definition at line 123 of file KHitBase.h.

Referenced by getMeasPlane(), Print(), and setMeasPlane().

std::shared_ptr<const Surface> trkf::KHitBase::fMeasSurf
private

Measurement surface.

Definition at line 122 of file KHitBase.h.

Referenced by getMeasSurface(), Print(), and setMeasSurface().

double trkf::KHitBase::fPredDist
mutableprotected

Prediction distance.

Definition at line 117 of file KHitBase.h.

Referenced by getPredDistance(), trkf::KHitMulti::predict(), trkf::KHit< N >::predict(), and Print().

std::shared_ptr<const Surface> trkf::KHitBase::fPredSurf
mutableprotected

Prediction surface.

Definition at line 116 of file KHitBase.h.

Referenced by getPredSurface(), trkf::KHitMulti::predict(), trkf::KHit< N >::predict(), and Print().


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