trkf::KETrack Class Reference

#include "KETrack.h"

Inheritance diagram for trkf::KETrack:

Public Member Functions
	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...
boost::optional< double >	combineTrack (const KETrack &tre)
	Combine two tracks. More...
virtual std::ostream &	Print (std::ostream &out, bool doTitle=true) const
	Printout. More...
const std::shared_ptr< const Surface > &	getSurface () const
	Surface. More...
const TrackVector &	getVector () const
	Track state vector. More...
TrackVector &	getVector ()
	Modifiable state vector. More...
Surface::TrackDirection	getDirection () const
	Track direction. More...
int	PdgCode () const
	Pdg code. More...
double	Mass () const
	Based on pdg code. 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
TrackError	fErr
	Track error matrix. More...

Detailed Description

Definition at line 29 of file KETrack.h.

Constructor & Destructor Documentation

trkf::KETrack::KETrack

(

)

Default constructor.

Definition at line 18 of file KETrack.cxx.

  {}

trkf::KETrack::KETrack

(

const std::shared_ptr< const Surface > &

psurf

)

Constructor - specify surface only.

Constructor - specify surface only.

Arguments:

psurf - Surface pointer.

Definition at line 27 of file KETrack.cxx.

                                                            :
    KTrack(psurf)
  {}

trkf::KETrack::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.

Constructor - surface + track parameters + error matrix.

Arguments:

psurf - Surface pointer. vec - Track state vector. err - Track error matrix. dir - Track direction. pdg - Pdg code.

Definition at line 41 of file KETrack.cxx.

                            :
    KTrack(psurf, vec, dir, pdg),
    fErr(err)
  {}

trkf::KETrack::KETrack	(	const KTrack &	trk,
		const TrackError &	err
	)

Constructor - KTrack + error matrix.

Constructor - KTrack + error matrix.

Arguments:

trk - KTrack. err - Track error matrix.

Definition at line 57 of file KETrack.cxx.

                                                           :
    KTrack(trk),
    fErr(err)
  {}

trkf::KETrack::~KETrack ( )

virtual

Destructor.

Definition at line 63 of file KETrack.cxx.

  {}

Member Function Documentation

boost::optional< double > trkf::KETrack::combineTrack

(

const KETrack &

tre

)

Combine two tracks.

Combine two tracks.

Arguments:

tre - Another track.

Returns: Chisquare + success flag.

This method updates the current track to be the weighted average of itself and another track. The chisquare of the combination is returned as the result value. The combination can fail because the sum of the two error matrices is singular, in which case the success flag embedded in the return value is false.

Definition at line 95 of file KETrack.cxx.

References getError(), trkf::KTrack::getSurface(), trkf::KTrack::getVector(), trkf::KTrack::isValid(), setError(), trkf::KTrack::setVector(), and trkf::syminvert().

Referenced by trkf::KFitTrack::combineFit(), and setError().

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

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

    // Default result is failure.

    boost::optional<double> result(false, 0.);

    // We will use asymmetric versions of the updating formulas, such
    // that the result is calculated as a perturbation on the
    // better-measured track.  We define the better measured track as
    // the one with the smaller error matrix trace.

    // Extract the two state vectors and error matrices as pointers.

    const TrackVector* vec1 = &getVector();
    const TrackError* err1 = &getError();
    const TrackVector* vec2 = &tre.getVector();
    const TrackError* err2 = &tre.getError();

    // Calculate the traces of the error matrices.

    double tr1 = 0;
    for(unsigned int i=0; i<err1->size1(); ++i)
      tr1 += (*err1)(i,i);

    double tr2 = 0;
    for(unsigned int i=0; i<err2->size1(); ++i)
      tr2 += (*err2)(i,i);

    // Define vec1, err1 as belong to the better measured track.
    // Swap if necessary.

    if(tr1 > tr2) {
      const TrackVector* tvec = vec1;
      vec1 = vec2;
      vec2 = tvec;
      const TrackError* terr = err1;
      err1 = err2;
      err2 = terr;
    }

    // Calculate the difference vector and difference error matrix.

    TrackVector dvec = *vec1 - *vec2;
    TrackError derr = *err1 + *err2;

    // Invert the difference error matrix.
    // This is the only place where a detectable failure can occur.

    bool ok = syminvert(derr);
    if(ok) {

      // Calculate updated state vector.
      // vec1 = vec1 - err1 * derr * dvec

      TrackVector tvec1 = prod(derr, dvec);
      TrackVector tvec2 = prod(*err1, tvec1);
      TrackVector tvec3 = *vec1 - tvec2;
      setVector(tvec3);

      // Calculate updated error matrix.
      // err1 = err1 - err1 * derr * err1

      TrackMatrix terr1 = prod(derr, *err1);
      TrackMatrix terr2 = prod(*err1, terr1);
      TrackError terr2s = ublas::symmetric_adaptor<TrackMatrix>(terr2);
      TrackError terr3 = *err1 - terr2s;
      setError(terr3);

      // Calculate chisquare.
      // chisq = dvec^T * derr * dvec

      TrackVector dvec1 = prod(derr, dvec);
      double chisq = inner_prod(dvec, dvec1);
      result = boost::optional<double>(true, chisq);
    }

    // Final validity check.

    if(!isValid())
      result = boost::optional<double>(false, 0.);

    // Done.

    return result;
  }

Surface::TrackDirection trkf::KTrack::getDirection ( ) const

inherited

Track direction.

Track direction accessor. Track direction implied by track parameters has precedence over track direction attribute. If the surface pointer is null, return UNKNOWN.

Definition at line 72 of file KTrack.cxx.

References trkf::KTrack::fDir, trkf::KTrack::fSurf, trkf::KTrack::fVec, and trkf::Surface::UNKNOWN.

Referenced by trkf::KTrack::getMomentum(), trkf::KTrack::getVector(), trkf::KTrack::isValid(), trkf::Propagator::lin_prop(), trkf::InteractPlane::noise(), trkf::PropYZLine::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZPlane::short_vec_prop(), and trkf::PropXYZPlane::short_vec_prop().

  {
    Surface::TrackDirection result = Surface::UNKNOWN;
    if(fSurf.get() != 0)
      result = fSurf->getDirection(fVec, fDir);
    return result;
  }

const TrackError& trkf::KETrack::getError ( ) const

inline

Track error matrix.

Definition at line 54 of file KETrack.h.

References fErr, and PointingError().

Referenced by combineTrack(), trkf::Propagator::err_prop(), trkf::KalmanFilterAlg::extendTrack(), trkf::KGTrack::fillTrack(), trkf::KalmanFilterAlg::fitMomentum(), trkf::KalmanFilterAlg::fitMomentumMS(), trkf::KalmanFilterAlg::fitMomentumRange(), trkf::Propagator::noise_prop(), trkf::KHitMulti::predict(), trkf::KHitWireLine::subpredict(), trkf::KHitWireX::subpredict(), trkf::KHitMulti::update(), trkf::KHit< N >::update(), and trkf::KalmanFilterAlg::updateMomentum().

TrackError& trkf::KETrack::getError ( )

inline

Modifiable error matrix.

Definition at line 59 of file KETrack.h.

References fErr.

void trkf::KTrack::getMomentum ( double  mom[3] ) const

inherited

Get momentum vector of track.

Get momentum vector of track. Throw an exception if track is not valid.

Arguments:

mom - Momentum vector of track.

Definition at line 217 of file KTrack.cxx.

References dir, trkf::KTrack::fSurf, trkf::KTrack::fVec, trkf::KTrack::getDirection(), and trkf::KTrack::isValid().

Referenced by trkf::KGTrack::fillTrack(), trkf::InteractGeneral::noise(), trkf::KTrack::Print(), trkf::KGTrack::Print(), trkf::Track3DKalmanHitAlg::qualityCutsOnSeedTrack(), trkf::KTrack::setPdgCode(), trkf::Propagator::vec_prop(), trkf::KTrack::XLatitude(), and trkf::KTrack::XLongitude().

  {
    if(!isValid())
      throw cet::exception("KTrack") << "Momentum vector requested for invalid track.\n";
    Surface::TrackDirection dir = getDirection();
    fSurf->getMomentum(fVec, mom, dir);
  }

void trkf::KTrack::getPosition ( double  xyz[3] ) const

inherited

Get position of track.

Get position of track. Throw an exception if track is not valid.

Arguments:

xyz - Position vector.

Definition at line 170 of file KTrack.cxx.

References trkf::KTrack::fSurf, trkf::KTrack::fVec, and trkf::KTrack::isValid().

Referenced by trkf::KGTrack::fillTrack(), trkf::InteractGeneral::noise(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZLine::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), trkf::KTrack::Print(), trkf::KGTrack::Print(), trkf::KTrack::setPdgCode(), trkf::PropYZLine::short_vec_prop(), trkf::PropYZPlane::short_vec_prop(), trkf::PropXYZPlane::short_vec_prop(), and trkf::Propagator::vec_prop().

  {
    if(!isValid())
      throw cet::exception("KTrack") << "Position requested for invalid track.\n";
    fSurf->getPosition(fVec, xyz);
  }

const std::shared_ptr<const Surface>& trkf::KTrack::getSurface ( ) const

inlineinherited

Surface.

Definition at line 55 of file KTrack.h.

References trkf::KTrack::fSurf.

Referenced by trkf::KalmanFilterAlg::buildTrack(), trkf::KFitTrack::combineFit(), combineTrack(), trkf::KalmanFilterAlg::extendTrack(), trkf::KalmanFilterAlg::fitMomentumMS(), trkf::Propagator::lin_prop(), trkf::InteractPlane::noise(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZLine::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), PointingError(), trkf::KHitMulti::predict(), trkf::KHit< N >::predict(), trkf::KalmanFilterAlg::smoothTrack(), trkf::KHitWireX::subpredict(), trkf::KHitWireLine::subpredict(), trkf::KHitMulti::update(), trkf::KHit< N >::update(), and trkf::KalmanFilterAlg::updateMomentum().

const TrackVector& trkf::KTrack::getVector ( ) const

inlineinherited

Track state vector.

Definition at line 56 of file KTrack.h.

References trkf::KTrack::fVec, and trkf::KTrack::getDirection().

Referenced by combineTrack(), trkf::KalmanFilterAlg::extendTrack(), trkf::KalmanFilterAlg::fitMomentum(), trkf::KalmanFilterAlg::fitMomentumMS(), trkf::KalmanFilterAlg::fitMomentumRange(), trkf::Propagator::lin_prop(), trkf::InteractPlane::noise(), trkf::PropYZPlane::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZLine::origin_vec_prop(), PointingError(), trkf::KHitMulti::predict(), trkf::PropXYZPlane::short_vec_prop(), trkf::PropYZPlane::short_vec_prop(), trkf::PropYZLine::short_vec_prop(), trkf::KHitWireX::subpredict(), trkf::KHitWireLine::subpredict(), trkf::KHitMulti::update(), trkf::KHit< N >::update(), trkf::KalmanFilterAlg::updateMomentum(), and trkf::Propagator::vec_prop().

TrackVector& trkf::KTrack::getVector ( )

inlineinherited

Modifiable state vector.

Definition at line 63 of file KTrack.h.

References trkf::KTrack::fVec.

bool trkf::KTrack::isValid ( ) const

inherited

Test if track is valid.

Test if track is valid.

A default-constructed or partially-constructed track, is invalid by virtue of having an unknown propagation direction or a null surface pointer.

Tracks can become invaliddynamically for other reasons. This method also does the following checks: a) Check for invalid floating point values (inf and nan). b) Surface-dependent checks via virtual method Surface::isTrackValid.

Definition at line 90 of file KTrack.cxx.

References trkf::KTrack::fSurf, trkf::KTrack::fVec, trkf::KTrack::getDirection(), geo::vect::isfinite(), and trkf::Surface::UNKNOWN.

Referenced by trkf::KGTrack::addTrack(), trkf::KalmanFilterAlg::buildTrack(), combineTrack(), trkf::KalmanFilterAlg::extendTrack(), trkf::KTrack::getMomentum(), trkf::KTrack::getPosition(), trkf::Propagator::lin_prop(), trkf::PropYZLine::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), PointingError(), trkf::KTrack::setPdgCode(), and trkf::KalmanFilterAlg::smoothTrack().

  {
    bool result = true;

    // Check for valid direction.

    if(getDirection() == Surface::UNKNOWN)
      result = false;

    // Check for non-null surface pointer (for safety, should be redundant
    // with previous check.

    if(result && fSurf.get() == 0)
      result = false;

    // Check for track parameters containing invalid floating point
    // values.

    if(result) {
      for(unsigned int i=0; i<fVec.size(); ++i) {
        if(!std::isfinite(fVec(i))) {
          result = false;
          break;
        }
      }
    }

    // Surface-dependent check on track validity.

    if(result && !fSurf->isTrackValid(fVec))
      result = false;

    // Done.

    return result;
  }

double trkf::KTrack::Mass ( ) const

inherited

Based on pdg code.

Particle mass based on pdg code.

Definition at line 128 of file KTrack.cxx.

References trkf::KTrack::fPdgCode.

Referenced by trkf::KalmanFilterAlg::fitMomentumMS(), trkf::InteractPlane::noise(), trkf::KTrack::PdgCode(), trkf::PropYZLine::short_vec_prop(), trkf::PropXYZPlane::short_vec_prop(), trkf::PropYZPlane::short_vec_prop(), and trkf::Propagator::vec_prop().

  {
    double mass = 0.;
    int apdg = std::abs(fPdgCode);

    // Muon

    if(apdg == 13)
      mass = mumass;

    // Charged pion

    else if(apdg == 211)
      mass = pimass;

    // Charged kaon

    else if(apdg == 321)
      mass = kmass;

    // (Anti)proton

    else if(apdg == 2212)
      mass = pmass;

    // Anything else throw exception

    else
      throw cet::exception("KTrack") << "Mass requested for invalid pdg id = " << fPdgCode << "\n";

    // Done.

    return mass;
  }

int trkf::KTrack::PdgCode ( ) const

inlineinherited

Pdg code.

Definition at line 58 of file KTrack.h.

References trkf::KTrack::fPdgCode, and trkf::KTrack::Mass().

double trkf::KETrack::PointingError

(

)

const

Pointing error (radians).

Calculate track pointing error (sigma, in radians).

This method calculates a single pointing error (sigma, in radians) based on the track parameters and error matrix. The actual calculation is done by the similarly names method of the surface class, since this class doesn't know what the track parameters mean.

Definition at line 74 of file KETrack.cxx.

References fErr, trkf::KTrack::getSurface(), trkf::KTrack::getVector(), and trkf::KTrack::isValid().

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

  {
    if(!isValid())
      throw cet::exception("KETrack") << "Pointing error requested for invalid track.\n";
    return getSurface()->PointingError(getVector(), fErr);
  }

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

virtual

Printout.

Reimplemented from trkf::KTrack.

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

Definition at line 188 of file KETrack.cxx.

References fErr, PointingError(), and trkf::KTrack::Print().

Referenced by trkf::KFitTrack::Print(), and setError().

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

    // Print base class.

    KTrack::Print(out, false);

    // Print diagonal errors.

    out << "  Diagonal errors:\n"
        << "  [";
    for(unsigned int i = 0; i < fErr.size1(); ++i) {
      if(i != 0)
        out << ", ";
      double err = fErr(i,i);
      err = (err >= 0. ? std::sqrt(err) : -std::sqrt(-err));
      out << err;
    }
    out << "]\n";

    // Print correlations.

    out << "  Correlation matrix:";
    for(unsigned int i = 0; i < fErr.size1(); ++i) {
      if(i == 0)
        out << "\n  [";
      else
        out << "\n   ";
      for(unsigned int j = 0; j <= i; ++j) {
        if(j != 0)
          out << ", ";
        if(i == j)
          out << 1.;
        else {
          double eiijj = fErr(i,i) * fErr(j,j);
          double eij = fErr(i,j);
          if(eiijj != 0.)
            eij /= std::sqrt(std::abs(eiijj));
          else
            eij = 0.;
          out << eij;
        }
      }
    }
    out << "]\n";
    out << "  Pointing error = " << PointingError() << "\n";
    return out;
  }

void trkf::KTrack::setDirection ( Surface::TrackDirection  dir )

inlineinherited

Set direction.

Definition at line 68 of file KTrack.h.

References dir, and trkf::KTrack::fDir.

Referenced by trkf::Propagator::lin_prop(), trkf::PropYZPlane::origin_vec_prop(), trkf::PropYZLine::origin_vec_prop(), and trkf::PropXYZPlane::origin_vec_prop().

void trkf::KETrack::setError ( const TrackError &  err )

inline

Set error matrix.

Definition at line 60 of file KETrack.h.

References combineTrack(), fErr, and Print().

Referenced by combineTrack(), trkf::Propagator::err_prop(), trkf::Propagator::noise_prop(), trkf::KHitMulti::update(), and trkf::KHit< N >::update().

void trkf::KTrack::setPdgCode ( int  pdg )

inlineinherited

Set pdg code.

Definition at line 69 of file KTrack.h.

References trkf::KTrack::fPdgCode, trkf::KTrack::getMomentum(), trkf::KTrack::getPosition(), trkf::KTrack::isValid(), trkf::KTrack::Print(), trkf::KTrack::XLatitude(), and trkf::KTrack::XLongitude().

void trkf::KTrack::setSurface ( const std::shared_ptr< const Surface > &  psurf )

inlineinherited

Set surface.

Definition at line 66 of file KTrack.h.

References trkf::KTrack::fSurf.

Referenced by trkf::Propagator::lin_prop(), trkf::PropYZPlane::origin_vec_prop(), trkf::PropYZLine::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZLine::short_vec_prop(), trkf::PropXYZPlane::short_vec_prop(), and trkf::PropYZPlane::short_vec_prop().

{fSurf = psurf;}

void trkf::KTrack::setVector ( const TrackVector &  vec )

inlineinherited

Set state vector.

Definition at line 67 of file KTrack.h.

References trkf::KTrack::fVec.

Referenced by combineTrack(), trkf::Propagator::lin_prop(), trkf::PropYZLine::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropXYZPlane::short_vec_prop(), trkf::PropYZPlane::short_vec_prop(), trkf::PropYZLine::short_vec_prop(), trkf::KHitMulti::update(), and trkf::KHit< N >::update().

double trkf::KTrack::XLatitude ( ) const

inherited

Get x-latitude.

Get x-latitude.

The x-latitude is the latitude defined with respect to the x-axis. The x-latitude is zero of the track is traveling parallel to the wire planes.

Definition at line 183 of file KTrack.cxx.

References trkf::KTrack::getMomentum().

Referenced by trkf::KTrack::Print(), and trkf::KTrack::setPdgCode().

  {
    double mom[3];
    getMomentum(mom);
    double ptx = std::sqrt(mom[1]*mom[1] + mom[2]*mom[2]);
    double result = 0.;
    if(ptx > 0. || mom[0] > 0.)
      result = atan2(mom[0], ptx);
    return result;
  }

double trkf::KTrack::XLongitude ( ) const

inherited

Get x-longitude.

Get x-longitude.

The x-longitude is the longitude defined with respect to the y- and z-axes. The x-longitude is zero of the track is parallel to the z-axis in the yz-plane.

Definition at line 200 of file KTrack.cxx.

References trkf::KTrack::getMomentum().

Referenced by trkf::KTrack::Print(), and trkf::KTrack::setPdgCode().

  {
    double mom[3];
    getMomentum(mom);
    double result = 0.;
    if(mom[1] != 0. || mom[2] != 0.)
      result = atan2(mom[1], mom[2]);
    return result;
  }

Member Data Documentation

TrackError trkf::KETrack::fErr

private

Track error matrix.

Definition at line 72 of file KETrack.h.

Referenced by getError(), PointingError(), Print(), and setError().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/RecoObjects/KETrack.h
• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/RecoObjects/KETrack.cxx