trkf::KTrack Class Reference

#include "KTrack.h"

Inheritance diagram for trkf::KTrack:

Public Member Functions
	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...
virtual std::ostream &	Print (std::ostream &out, bool doTitle=true) const
	Printout. More...

Private Attributes
std::shared_ptr< const Surface >	fSurf
	Track surface. More...
TrackVector	fVec
	Track state vector. More...
Surface::TrackDirection	fDir
	Track direction. More...
int	fPdgCode
	Pdg id. hypothesis. More...

Detailed Description

Definition at line 32 of file KTrack.h.

Constructor & Destructor Documentation

trkf::KTrack::KTrack

(

)

Enum.

Default constructor.

Definition at line 29 of file KTrack.cxx.

: fDir(Surface::UNKNOWN), fPdgCode(0) {}

trkf::KTrack::KTrack

(

const std::shared_ptr< const Surface > &

psurf

)

Constructor - specify surface only.

Constructor - specify surface only.

Arguments:

psurf - Surface pointer.

Definition at line 37 of file KTrack.cxx.

    : fSurf(psurf), fDir(Surface::UNKNOWN), fPdgCode(0)
  {}

trkf::KTrack::KTrack	(	std::shared_ptr< const Surface >	psurf,
		const TrackVector &	vec,
		Surface::TrackDirection	dir = Surface::UNKNOWN,
		int	pdg = 0
	)

Constructor - surface + track parameters.

Constructor - surface + track parameters.

Arguments:

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

Definition at line 50 of file KTrack.cxx.

    : fSurf(psurf), fVec(vec), fDir(dir), fPdgCode(pdg)
  {}

trkf::KTrack::~KTrack ( )

virtual

Destructor.

Definition at line 58 of file KTrack.cxx.

{}

Member Function Documentation

Surface::TrackDirection trkf::KTrack::getDirection

(

)

const

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 64 of file KTrack.cxx.

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

Referenced by getMomentum(), getVector(), 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;
  }

void trkf::KTrack::getMomentum

(

double

mom[3]

)

const

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 201 of file KTrack.cxx.

References dir, fSurf, fVec, getDirection(), and isValid().

Referenced by trkf::KGTrack::fillTrack(), trkf::InteractGeneral::noise(), Print(), trkf::KGTrack::Print(), trkf::Track3DKalmanHitAlg::qualityCutsOnSeedTrack(), setPdgCode(), trkf::Propagator::vec_prop(), XLatitude(), and 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

Get position of track.

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

Arguments:

xyz - Position vector.

Definition at line 157 of file KTrack.cxx.

References fSurf, fVec, and isValid().

Referenced by trkf::KGTrack::fillTrack(), trkf::InteractGeneral::noise(), trkf::PropYZLine::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), Print(), trkf::KGTrack::Print(), 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

inline

Surface.

Definition at line 53 of file KTrack.h.

References fSurf.

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

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

inline

Track state vector.

Definition at line 54 of file KTrack.h.

References fVec, and getDirection().

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

TrackVector& trkf::KTrack::getVector ( )

inline

Modifiable state vector.

Definition at line 61 of file KTrack.h.

References fVec.

bool trkf::KTrack::isValid

(

)

const

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 81 of file KTrack.cxx.

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

Referenced by trkf::KGTrack::addTrack(), trkf::KalmanFilterAlg::buildTrack(), trkf::KETrack::combineTrack(), trkf::KalmanFilterAlg::extendTrack(), getMomentum(), getPosition(), trkf::Propagator::lin_prop(), trkf::PropYZLine::origin_vec_prop(), trkf::PropXYZPlane::origin_vec_prop(), trkf::PropYZPlane::origin_vec_prop(), trkf::KETrack::PointingError(), 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

Based on pdg code.

Particle mass based on pdg code.

Definition at line 116 of file KTrack.cxx.

References util::abs(), and fPdgCode.

Referenced by trkf::KalmanFilterAlg::fitMomentumMS(), trkf::InteractPlane::noise(), 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

inline

Pdg code.

Definition at line 56 of file KTrack.h.

References fPdgCode, and Mass().

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

virtual

Printout.

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

Definition at line 210 of file KTrack.cxx.

References trkf::Surface::BACKWARD, dir, fDir, trkf::Surface::FORWARD, fPdgCode, fSurf, fVec, getMomentum(), getPosition(), XLatitude(), and XLongitude().

Referenced by trkf::operator<<(), trkf::KETrack::Print(), and setPdgCode().

  {
    if (doTitle) out << "KTrack:\n";
    double xyz[3];
    double dir[3];
    getPosition(xyz);
    getMomentum(dir);
    double p = std::sqrt(dir[0] * dir[0] + dir[1] * dir[1] + dir[2] * dir[2]);
    if (p != 0.) {
      dir[0] /= p;
      dir[1] /= p;
      dir[2] /= p;
    }
    out << "  Surface direction = "
        << (fDir == Surface::FORWARD ? "FORWARD" :
                                       (fDir == Surface::BACKWARD ? "BACKWARD" : "UNKNOWN"))
        << "\n"
        << "  Pdg = " << fPdgCode << "\n"
        << "  Surface: " << *fSurf << "\n"
        << "  Track parameters:\n"
        << "  [";
    for (unsigned int i = 0; i < fVec.size(); ++i) {
      if (i != 0) out << ", ";
      out << fVec(i);
    }
    out << "]\n";
    out << "  Position:  [" << xyz[0] << ", " << xyz[1] << ", " << xyz[2] << "]\n";
    out << "  Direction: [" << dir[0] << ", " << dir[1] << ", " << dir[2] << "]\n";
    out << "  X-Latitude  = " << XLatitude() << "\n";
    out << "  X-Longitude = " << XLongitude() << "\n";
    return out;
  }

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

inline

Set direction.

Definition at line 66 of file KTrack.h.

References dir, and fDir.

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

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

inline

Set pdg code.

Definition at line 67 of file KTrack.h.

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

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

inline

Set surface.

Definition at line 64 of file KTrack.h.

References fSurf.

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

{ fSurf = psurf; }

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

inline

Set state vector.

Definition at line 65 of file KTrack.h.

References fVec.

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

double trkf::KTrack::XLatitude

(

)

const

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 169 of file KTrack.cxx.

References getMomentum().

Referenced by Print(), and 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

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 185 of file KTrack.cxx.

References getMomentum().

Referenced by Print(), and 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

Surface::TrackDirection trkf::KTrack::fDir

private

Track direction.

Definition at line 92 of file KTrack.h.

Referenced by getDirection(), Print(), and setDirection().

int trkf::KTrack::fPdgCode

private

Pdg id. hypothesis.

Definition at line 93 of file KTrack.h.

Referenced by Mass(), PdgCode(), Print(), and setPdgCode().

std::shared_ptr<const Surface> trkf::KTrack::fSurf

private

Track surface.

Definition at line 90 of file KTrack.h.

Referenced by getDirection(), getMomentum(), getPosition(), getSurface(), isValid(), Print(), and setSurface().

TrackVector trkf::KTrack::fVec

private

Track state vector.

Definition at line 91 of file KTrack.h.

Referenced by getDirection(), getMomentum(), getPosition(), getVector(), isValid(), Print(), and setVector().

---

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

• lardata/v09_16_03/source/lardata/RecoObjects/KTrack.h
• lardata/v09_16_03/source/lardata/RecoObjects/KTrack.cxx