LArSoft  v10_06_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | Protected Attributes | Private Attributes | List of all members
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 ()=default
 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, 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 Surface > fPredSurf
 Prediction surface. More...
 
double fPredDist
 Prediction distance. More...
 
int fID
 Unique id. More...
 

Private Attributes

std::shared_ptr< const Surface > fMeasSurf
 Measurement surface. More...
 
int fMeasPlane
 Measurement plane index. More...
 

Detailed Description

Definition at line 62 of file KHitBase.h.

Constructor & Destructor Documentation

trkf::KHitBase::KHitBase ( )

Default constructor.

Default Constructor.

Definition at line 18 of file KHitBase.cxx.

18 : fPredDist(0.), fID(0), fMeasPlane(-1) {}
trkf::KHitBase::fID
int fID
Unique id.
Definition: KHitBase.h:119
trkf::KHitBase::fPredDist
double fPredDist
Prediction distance.
Definition: KHitBase.h:118
trkf::KHitBase::fMeasPlane
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 26 of file KHitBase.cxx.

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

Destructor.

Member Function Documentation

virtual double trkf::KHitBase::getChisq ( ) const
pure virtual

Return incremental chisquare.

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

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

int trkf::KHitBase::getID ( ) const
inline

Unique id.

Definition at line 88 of file KHitBase.h.

References fID.

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

88 { return fID; }
trkf::KHitBase::fID
int fID
Unique id.
Definition: KHitBase.h:119
int trkf::KHitBase::getMeasPlane ( ) const
inline

Measurement plane index.

Definition at line 85 of file KHitBase.h.

References fMeasPlane.

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

85 { return fMeasPlane; }
trkf::KHitBase::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 82 of file KHitBase.h.

References fMeasSurf.

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

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

Prediction distance.

Definition at line 79 of file KHitBase.h.

References fPredDist.

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

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

Predition surface.

Definition at line 76 of file KHitBase.h.

References fPredSurf.

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

76 { return fPredSurf; }
trkf::KHitBase::fPredSurf
std::shared_ptr< const Surface > fPredSurf
Prediction surface.
Definition: KHitBase.h:117
virtual bool trkf::KHitBase::predict ( const KETrack &  tre,
const Propagator &  prop,
const KTrack *  ref = 0 
) const
pure virtual

Prediction method (return false if fail).

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

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

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 31 of file KHitBase.cxx.

References fMeasPlane, fMeasSurf, fPredDist, and fPredSurf.

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

32  {
33  if (doTitle) out << "KHitBase:\n";
34  out << " Measurement Surface: " << *fMeasSurf << "\n";
35  out << " Measurement Plane: " << fMeasPlane << "\n";
36  if (fPredSurf.get() != 0) {
37  out << " Prediction Surface: " << *fPredSurf << "\n";
38  out << " Prediction Distance: " << fPredDist << "\n";
39  }
40  return out;
41  }
trkf::KHitBase::fMeasSurf
std::shared_ptr< const Surface > fMeasSurf
Measurement surface.
Definition: KHitBase.h:122
trkf::KHitBase::fPredSurf
std::shared_ptr< const Surface > fPredSurf
Prediction surface.
Definition: KHitBase.h:117
trkf::KHitBase::fPredDist
double fPredDist
Prediction distance.
Definition: KHitBase.h:118
trkf::KHitBase::fMeasPlane
int fMeasPlane
Measurement plane index.
Definition: KHitBase.h:123
void trkf::KHitBase::setMeasPlane ( int  plane)
inline

Measurement plane.

Definition at line 96 of file KHitBase.h.

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

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

96 { fMeasPlane = plane; }
trkf::KHitBase::fMeasPlane
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 93 of file KHitBase.h.

References fMeasSurf.

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

93 { fMeasSurf = psurf; }
trkf::KHitBase::fMeasSurf
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 119 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 118 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 117 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: