trkf::KFitTrack Class Reference

#include <KFitTrack.h>

Inheritance diagram for trkf::KFitTrack:

Public Types
enum	FitStatus {   INVALID, UNKNOWN, FORWARD, FORWARD_PREDICTED,   BACKWARD, BACKWARD_PREDICTED, OPTIMAL, OPTIMAL_PREDICTED }
	Fit status enum. More...

Public Member Functions
	KFitTrack ()
	Default constructor. More...
	KFitTrack (const KETrack &tre, double s=0., double chisq=0., FitStatus stat=INVALID)
	Initializing constructor. More...
virtual	~KFitTrack ()
	Destructor. More...
double	getPath () const
	Propagation distance. More...
double	getChisq () const
	Fit chisquare. More...
FitStatus	getStat () const
	Fit status. More...
void	setPath (double path)
	Set propagation distance. More...
void	setChisq (double chisq)
	Set chisquare. More...
void	setStat (FitStatus stat)
	Set fit status. More...
bool	combineFit (const KFitTrack &trf)
	Combine two tracks. More...
virtual std::ostream &	Print (std::ostream &out, bool doTitle=true) const
	Printout. More...
Public Member Functions inherited from trkf::KETrack
	KETrack ()
	Default constructor. More...
	KETrack (const std::shared_ptr< const Surface > &psurf)
	Constructor - specify surface only. More...
	KETrack (const std::shared_ptr< const Surface > &psurf, const TrackVector &vec, const TrackError &err, Surface::TrackDirection dir=Surface::UNKNOWN, int pdg=0)
	Constructor - surface + track parameters + error matrix. More...
	KETrack (const KTrack &trk, const TrackError &err)
	Constructor - KTrack + error matrix. More...
virtual	~KETrack ()
	Destructor. More...
const TrackError &	getError () const
	Track error matrix. More...
double	PointingError () const
	Pointing error (radians). More...
TrackError &	getError ()
	Modifiable error matrix. More...
void	setError (const TrackError &err)
	Set error matrix. More...
std::optional< double >	combineTrack (const KETrack &tre)
	Combine two tracks. More...
Public Member Functions inherited from trkf::KTrack
	KTrack ()
	Enum. More...
	KTrack (const std::shared_ptr< const Surface > &psurf)
	Constructor - specify surface only. More...
	KTrack (std::shared_ptr< const Surface > psurf, const TrackVector &vec, Surface::TrackDirection dir=Surface::UNKNOWN, int pdg=0)
	Constructor - surface + track parameters. More...
virtual	~KTrack ()
	Destructor. More...
const std::shared_ptr< const Surface > &	getSurface () const
	Surface. More...
const TrackVector &	getVector () const
	Track state vector. More...
Surface::TrackDirection	getDirection () const
	Track direction. More...
int	PdgCode () const
	Pdg code. More...
double	Mass () const
	Based on pdg code. More...
TrackVector &	getVector ()
	Modifiable state vector. More...
void	setSurface (const std::shared_ptr< const Surface > &psurf)
	Set surface. More...
void	setVector (const TrackVector &vec)
	Set state vector. More...
void	setDirection (Surface::TrackDirection dir)
	Set direction. More...
void	setPdgCode (int pdg)
	Set pdg code. More...
bool	isValid () const
	Test if track is valid. More...
void	getPosition (double xyz[3]) const
	Get position of track. More...
void	getMomentum (double mom[3]) const
	Get momentum vector of track. More...
double	XLatitude () const
	Get x-latitude. More...
double	XLongitude () const
	Get x-longitude. More...

Private Attributes
double	fPath
	Propagation distance. More...
double	fChisq
	Fit chisquare. More...
FitStatus	fStat
	Fit status. More...

Detailed Description

Definition at line 36 of file KFitTrack.h.

Member Enumeration Documentation

enum trkf::KFitTrack::FitStatus

Fit status enum.

Enumerator
INVALID
UNKNOWN
FORWARD
FORWARD_PREDICTED
BACKWARD
BACKWARD_PREDICTED
OPTIMAL
OPTIMAL_PREDICTED

Definition at line 41 of file KFitTrack.h.

                   {
      INVALID,             // No valid fit information.
      UNKNOWN,             // Unknown.
      FORWARD,             // Fit based on past measurements, including current surface.
      FORWARD_PREDICTED,   // Fit based on past measurements, not including current surface.
      BACKWARD,            // Fit based on future measurements, including current surface.
      BACKWARD_PREDICTED,  // Fit based on future measurements, not including current surface.
      OPTIMAL,             // Fit based on all measurements, including current surface.
      OPTIMAL_PREDICTED    // Fit based on all measurements, except current surface.
    };

Constructor & Destructor Documentation

trkf::KFitTrack::KFitTrack

(

)

Default constructor.

Definition at line 17 of file KFitTrack.cxx.

: fPath(0.), fChisq(0.), fStat(INVALID) {}

trkf::KFitTrack::KFitTrack	(	const KETrack &	tre,
		double	s = 0.,
		double	chisq = 0.,
		FitStatus	stat = INVALID
	)

Initializing constructor.

Initializing constructor.

Arguments:

tre - KETrack. s - Path distance. chisq - Fit chisquare. stat - Fit status.

Definition at line 28 of file KFitTrack.cxx.

    : KETrack(tre), fPath(s), fChisq(chisq), fStat(stat)
  {}

trkf::KFitTrack::~KFitTrack ( )

virtual

Destructor.

Definition at line 33 of file KFitTrack.cxx.

{}

Member Function Documentation

bool trkf::KFitTrack::combineFit

(

const KFitTrack &

trf

)

Combine two tracks.

Combine two tracks.

Arguments:

trf - Another track.

Returns: True if success.

This method updates the current track to be the weighted average of itself and another track. Track parameters and error matrix are updated by method KETrack::combineTrack. The updated chissquare is the sum of the original chisquare, the chisquare from the other track, and the chisquare of the combination. The path distance is not updated.

The updated status is derived from the input status according to the following table.

FORWARD + BACKWARD_PREDICTED = OPTIMAL FORWARD_PREDICTED + BACKWARD = OPTIMAL FORWARD_PREDICTED + BACKWARD_PREDICTED = OPTIMAL_PREDICTED

Any other combination of input statuses will cause this method to return failure. This method can also return failure because of singular error matrices. In case of failure, the original track is not updated.

The two tracks being combined should be on the same surface (throw exception if not).

Definition at line 66 of file KFitTrack.cxx.

  {
    // Make sure that the two track surfaces are the same.
    // Throw an exception if they are not.

    if (!getSurface()->isEqual(*trf.getSurface()))
      throw cet::exception("KFitTrack") << "Track combination surfaces are not the same.\n";

    // Default result failure.

    bool result = false;

    // Make sure input statuses are compatible and figure out the
    // updated status.

    FitStatus stat1 = getStat();
    FitStatus stat2 = trf.getStat();
    FitStatus statu = UNKNOWN;
    if ((stat1 == FORWARD && stat2 == BACKWARD_PREDICTED) ||
        (stat1 == FORWARD_PREDICTED && stat2 == BACKWARD) ||
        (stat1 == BACKWARD && stat2 == FORWARD_PREDICTED) ||
        (stat1 == BACKWARD_PREDICTED && stat2 == FORWARD))
      statu = OPTIMAL;
    else if (stat1 == FORWARD_PREDICTED && stat2 == BACKWARD_PREDICTED)
      statu = OPTIMAL_PREDICTED;
    else
      statu = UNKNOWN;
    if (statu != UNKNOWN) {

      // Update track parameters and error matrix.

      std::optional<double> chisq = combineTrack(trf);

      // Update status and chisquare.

      if (!!chisq) {
        result = true;
        fStat = statu;
        fChisq = fChisq + trf.getChisq() + *chisq;
      }
    }

    // Done.

    return result;
  }

double trkf::KFitTrack::getChisq ( ) const

inline

Fit chisquare.

Definition at line 67 of file KFitTrack.h.

double trkf::KFitTrack::getPath ( ) const

inline

Propagation distance.

Definition at line 66 of file KFitTrack.h.

FitStatus trkf::KFitTrack::getStat ( ) const

inline

Fit status.

Definition at line 68 of file KFitTrack.h.

std::ostream & trkf::KFitTrack::Print ( std::ostream &  out, bool  doTitle = true  ) const

virtual

Printout.

Reimplemented from trkf::KETrack.

Reimplemented in trkf::KHitsTrack, and trkf::KHitTrack.

Definition at line 115 of file KFitTrack.cxx.

  {
    if (doTitle) out << "KFitTrack:\n";

    // Print information specific to this class.

    out << "  Distance = " << fPath << "\n";
    out << "  Chisquare = " << fChisq << "\n";
    out << "  Status = "
        << (fStat == INVALID ?
              "INVALID" :
              (fStat == UNKNOWN ?
                 "UNKNOWN" :
                 (fStat == FORWARD ?
                    "FORWARD" :
                    (fStat == FORWARD_PREDICTED ?
                       "FORWARD_PREDICTED" :
                       (fStat == BACKWARD ?
                          "BACKWARD" :
                          (fStat == BACKWARD_PREDICTED ?
                             "BACKWARD_PREDICTED" :
                             (fStat == OPTIMAL ? "OPTIMAL" : "OPTIMAL_PREDICTED")))))))
        << "\n";

    // Print base class.

    KETrack::Print(out, false);
    return out;
  }

void trkf::KFitTrack::setChisq ( double  chisq )

inline

Set chisquare.

Definition at line 73 of file KFitTrack.h.

void trkf::KFitTrack::setPath ( double  path )

inline

Set propagation distance.

Definition at line 72 of file KFitTrack.h.

void trkf::KFitTrack::setStat ( FitStatus  stat )

inline

Set fit status.

Definition at line 74 of file KFitTrack.h.

Member Data Documentation

double trkf::KFitTrack::fChisq

private

Fit chisquare.

Definition at line 87 of file KFitTrack.h.

double trkf::KFitTrack::fPath

private

Propagation distance.

Definition at line 86 of file KFitTrack.h.

FitStatus trkf::KFitTrack::fStat

private

Fit status.

Definition at line 88 of file KFitTrack.h.

---

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

• lardata/lardata/RecoObjects/KFitTrack.h
• lardata/lardata/RecoObjects/KFitTrack.cxx