trkf::KHitMulti Class Reference

#include <KHitMulti.h>

Inheritance diagram for trkf::KHitMulti:

Public Member Functions
	KHitMulti ()
	Default constructor. More...
	KHitMulti (const std::shared_ptr< const Surface > &psurf)
	Initializing Constructor – measurement surface only. More...
virtual	~KHitMulti ()
	Destructor. More...
int	getMeasDim () const
	Measurement space dimension. More...
const std::vector < std::shared_ptr< const KHit< 1 > > > &	getMeasVec () const
	Measurement collection. More...
const ublas::vector< double > &	getMeasVector () const
	Measurement vector. More...
const ublas::symmetric_matrix < double > &	getMeasError () const
	Measurement error matrix. More...
const ublas::vector< double > &	getPredVector () const
	Prediction vector. More...
const ublas::symmetric_matrix < double > &	getPredError () const
	Prediction matrix. More...
const ublas::vector< double > &	getResVector () const
	Residual vector. More...
const ublas::symmetric_matrix < double > &	getResError () const
	Residual error matrix. More...
const ublas::symmetric_matrix < double > &	getResInvError () const
	Residual inv. error matrix. More...
const ublas::matrix< double > &	getH () const
	Kalman H-matrix. More...
double	getChisq () const
	Incremental chisquare. More...
void	addMeas (const std::shared_ptr< const KHitBase > &pmeas)
	Add a measurement of unknown type. More...
void	addMeas (const std::shared_ptr< const KHit< 1 >> &pmeas)
	Add a one-dimensional measurement. More...
bool	predict (const KETrack &tre, const Propagator &prop, const KTrack *ref=0) const
	Prediction method (return false if fail). More...
void	update (KETrack &tre) const
	Update track method. More...
virtual std::ostream &	Print (std::ostream &out, bool doTitle=true) const
	Printout. More...
Public Member Functions inherited from trkf::KHitBase
	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...

Private Attributes
int	fMeasDim
	Measurement space dimension. More...
std::vector< std::shared_ptr < const KHit< 1 > > >	fMeasVec
	Underlying measurements. More...
ublas::vector< double >	fMvec
	Measurement vector. More...
ublas::symmetric_matrix< double >	fMerr
	Measurement error matrix. More...
ublas::vector< double >	fPvec
	Prediction vector. More...
ublas::symmetric_matrix< double >	fPerr
	Prediction error matrix. More...
ublas::vector< double >	fRvec
	Residual vector. More...
ublas::symmetric_matrix< double >	fRerr
	Residual error matrix. More...
ublas::symmetric_matrix< double >	fRinv
	Residual inverse error matrix. More...
ublas::matrix< double >	fH
	Kalman H-matrix. More...
double	fChisq
	Incremental chisquare. More...

Additional Inherited Members
Protected Attributes inherited from trkf::KHitBase
std::shared_ptr< const Surface >	fPredSurf
	Prediction surface. More...
double	fPredDist
	Prediction distance. More...
int	fID
	Unique id. More...

Detailed Description

Definition at line 53 of file KHitMulti.h.

Constructor & Destructor Documentation

trkf::KHitMulti::KHitMulti

(

)

Default constructor.

Default Constructor.

Definition at line 17 of file KHitMulti.cxx.

: fMeasDim(0), fChisq(0.) {}

trkf::KHitMulti::KHitMulti

(

const std::shared_ptr< const Surface > &

psurf

)

Initializing Constructor – measurement surface only.

Initializing Constructor.

Arguments:

psurf - Measurement surface pointer.

Definition at line 25 of file KHitMulti.cxx.

    : KHitBase(psurf), fMeasDim(0), fChisq(0.)
  {}

trkf::KHitMulti::~KHitMulti ( )

virtual

Destructor.

Definition at line 30 of file KHitMulti.cxx.

{}

Member Function Documentation

void trkf::KHitMulti::addMeas

(

const std::shared_ptr< const KHitBase > &

pmeas

)

Add a measurement of unknown type.

Add a measurement.

Arguments:

pmeas - Measurement.

This method tries to dynamic cast the measurement to a supported type. If the dynamic cast fails, throw an exception.

Definition at line 42 of file KHitMulti.cxx.

  {
    // It is an error to pass in a null pointer.

    if (pmeas.get() == 0)
      throw cet::exception("KHitMulti") << "Attempt to add null measurement pointer.\n";

    // Do the dynamic cast.

    std::shared_ptr<const KHit<1>> pmeas1 =
      std::dynamic_pointer_cast<const KHit<1>, const KHitBase>(pmeas);

    // Throw an exception if dynamic cast failed.

    if (pmeas1.get() == 0)
      throw cet::exception("KHitMulti") << "Dynamic cast for KHitBase pointer failed.\n";
    addMeas(pmeas1);
  }

void trkf::KHitMulti::addMeas

(

const std::shared_ptr< const KHit< 1 >> &

pmeas

)

Add a one-dimensional measurement.

Add a measurement.

Arguments:

pmeas - Measurement.

Definition at line 68 of file KHitMulti.cxx.

  {
    // It is an error to pass in a null pointer.

    if (pmeas.get() == 0)
      throw cet::exception("KHitMulti") << "Attempt to add null measurement pointer.\n";

    // Add the measurement.

    ++fMeasDim;
    fMeasVec.push_back(pmeas);
  }

double trkf::KHitMulti::getChisq ( ) const

inlinevirtual

Incremental chisquare.

Implements trkf::KHitBase.

Definition at line 138 of file KHitMulti.h.

    {
      return fChisq;
    }

const ublas::matrix<double>& trkf::KHitMulti::getH ( ) const

inline

Kalman H-matrix.

Definition at line 131 of file KHitMulti.h.

    {
      return fH;
    }

int trkf::KHitMulti::getMeasDim ( ) const

inline

Measurement space dimension.

Definition at line 68 of file KHitMulti.h.

    {
      return fMeasDim;
    }

const ublas::symmetric_matrix<double>& trkf::KHitMulti::getMeasError ( ) const

inline

Measurement error matrix.

Definition at line 89 of file KHitMulti.h.

    {
      return fMerr;
    }

const std::vector<std::shared_ptr<const KHit<1> > >& trkf::KHitMulti::getMeasVec ( ) const

inline

Measurement collection.

Definition at line 75 of file KHitMulti.h.

    {
      return fMeasVec;
    }

const ublas::vector<double>& trkf::KHitMulti::getMeasVector ( ) const

inline

Measurement vector.

Definition at line 82 of file KHitMulti.h.

    {
      return fMvec;
    }

const ublas::symmetric_matrix<double>& trkf::KHitMulti::getPredError ( ) const

inline

Prediction matrix.

Definition at line 103 of file KHitMulti.h.

    {
      return fPerr;
    }

const ublas::vector<double>& trkf::KHitMulti::getPredVector ( ) const

inline

Prediction vector.

Definition at line 96 of file KHitMulti.h.

    {
      return fPvec;
    }

const ublas::symmetric_matrix<double>& trkf::KHitMulti::getResError ( ) const

inline

Residual error matrix.

Definition at line 117 of file KHitMulti.h.

    {
      return fRerr;
    }

const ublas::symmetric_matrix<double>& trkf::KHitMulti::getResInvError ( ) const

inline

Residual inv. error matrix.

Definition at line 124 of file KHitMulti.h.

    {
      return fRinv;
    }

const ublas::vector<double>& trkf::KHitMulti::getResVector ( ) const

inline

Residual vector.

Definition at line 110 of file KHitMulti.h.

    {
      return fRvec;
    }

bool trkf::KHitMulti::predict ( const KETrack &  tre, const Propagator &  prop, const KTrack *  ref = 0  ) const

virtual

Prediction method (return false if fail).

Prediction method (return false if fail).

Arguments:

tre - Track hypothesis. prop - Propagator. ref - Reference track.

Returns: True if success.

This class calls the predict method of each underlying measurement and updates the combined prediction attributes.

Implements trkf::KHitBase.

Definition at line 95 of file KHitMulti.cxx.

  {
    // Resize and clear all linear algebra objects.

    fMvec.resize(fMeasDim, false);
    fMvec.clear();

    fMerr.resize(fMeasDim, false);
    fMerr.clear();

    fPvec.resize(fMeasDim, false);
    fPvec.clear();

    fPerr.resize(fMeasDim, false);
    fPerr.clear();

    fRvec.resize(fMeasDim, false);
    fRvec.clear();

    fRerr.resize(fMeasDim, false);
    fRerr.clear();

    fRinv.resize(fMeasDim, false);
    fRinv.clear();

    fH.resize(fMeasDim, tre.getVector().size());
    fH.clear();

    // Update the prediction surface to be the track surface.

    fPredSurf = tre.getSurface();
    fPredDist = 0.;

    // Result.

    bool ok = true;

    // Loop over one-dimensional measurements.

    for (unsigned int im = 0; ok && im < fMeasVec.size(); ++im) {
      const KHit<1>& meas = *(fMeasVec[im]);

      // Update prediction for this measurement.

      ok = meas.predict(tre, prop, ref);
      if (!ok) break;

      //

      // Update objects that are concatenations of underlying measurements.

      fMvec(im) = meas.getMeasVector()(0);       // Measurement vector.
      fMerr(im, im) = meas.getMeasError()(0, 0); // Measurement error matrix.
      fPvec(im) = meas.getPredVector()(0);       // Prediction vector.

      // H-matrix.

      for (unsigned int j = 0; j < meas.getH().size2(); ++j)
        fH(im, j) = meas.getH()(0, j);
    }
    if (ok) {

      // Calculate prediction error matrix.
      // T = H C H^T.

      ublas::matrix<double> temp(fH.size2(), fMeasDim);
      ublas::matrix<double> temp2(fMeasDim, fMeasDim);
      temp = prod(tre.getError(), trans(fH));
      temp2 = prod(fH, temp);
      fPerr = ublas::symmetric_adaptor<ublas::matrix<double>>(temp2);

      // Update residual

      fRvec = fMvec - fPvec;
      fRerr = fMerr + fPerr;
      fRinv = fRerr;
      ok = syminvert(fRinv);
      if (ok) {

        // Calculate incremental chisquare.

        ublas::vector<double> rtemp = prod(fRinv, fRvec);
        fChisq = inner_prod(fRvec, rtemp);
      }
    }

    // If a problem occured at any step, clear the prediction surface pointer.

    if (!ok) {
      fPredSurf.reset();
      fPredDist = 0.;
    }

    // Done.

    return ok;
  }

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

virtual

Printout.

Reimplemented from trkf::KHitBase.

Definition at line 245 of file KHitMulti.cxx.

  {
    if (doTitle) out << "KHitMulti:\n";
    return out;
  }

void trkf::KHitMulti::update ( KETrack &  tre ) const

virtual

Update track method.

Update track method.

Arguments:

tre - Track to be updated.

This method is almost an exact copy of the update method in KHit<N>.

Implements trkf::KHitBase.

Definition at line 202 of file KHitMulti.cxx.

  {
    // Make sure that the track surface and the prediction surface are the same.
    // Throw an exception if they are not.

    if (!getPredSurface()->isEqual(*tre.getSurface()))
      throw cet::exception("KHitMulti") << "Track surface not the same as prediction surface.\n";

    const TrackVector& tvec = tre.getVector();
    const TrackError& terr = tre.getError();
    TrackVector::size_type size = tvec.size();

    // Calculate gain matrix.

    ublas::matrix<double> temp(size, fMeasDim);
    ublas::matrix<double> gain(size, fMeasDim);
    temp = prod(trans(fH), fRinv);
    gain = prod(terr, temp);

    // Calculate updated track state.

    TrackVector newvec = tre.getVector() + prod(gain, fRvec);

    // Calculate updated error matrix.

    TrackMatrix fact = ublas::identity_matrix<TrackVector::value_type>(size);
    fact -= prod(gain, fH);
    TrackMatrix errtemp1 = prod(terr, trans(fact));
    TrackMatrix errtemp2 = prod(fact, errtemp1);
    TrackError errtemp2s = ublas::symmetric_adaptor<TrackMatrix>(errtemp2);
    ublas::matrix<double> errtemp3 = prod(fMerr, trans(gain));
    TrackMatrix errtemp4 = prod(gain, errtemp3);
    TrackError errtemp4s = ublas::symmetric_adaptor<TrackMatrix>(errtemp4);
    TrackError newerr = errtemp2s + errtemp4s;

    // Update track.

    tre.setVector(newvec);
    tre.setError(newerr);
  }

Member Data Documentation

double trkf::KHitMulti::fChisq

mutableprivate

Incremental chisquare.

Definition at line 175 of file KHitMulti.h.

ublas::matrix<double> trkf::KHitMulti::fH

mutableprivate

Kalman H-matrix.

Definition at line 174 of file KHitMulti.h.

int trkf::KHitMulti::fMeasDim

private

Measurement space dimension.

Definition at line 165 of file KHitMulti.h.

std::vector<std::shared_ptr<const KHit<1> > > trkf::KHitMulti::fMeasVec

private

Underlying measurements.

Definition at line 166 of file KHitMulti.h.

ublas::symmetric_matrix<double> trkf::KHitMulti::fMerr

mutableprivate

Measurement error matrix.

Definition at line 168 of file KHitMulti.h.

ublas::vector<double> trkf::KHitMulti::fMvec

mutableprivate

Measurement vector.

Definition at line 167 of file KHitMulti.h.

ublas::symmetric_matrix<double> trkf::KHitMulti::fPerr

mutableprivate

Prediction error matrix.

Definition at line 170 of file KHitMulti.h.

ublas::vector<double> trkf::KHitMulti::fPvec

mutableprivate

Prediction vector.

Definition at line 169 of file KHitMulti.h.

ublas::symmetric_matrix<double> trkf::KHitMulti::fRerr

mutableprivate

Residual error matrix.

Definition at line 172 of file KHitMulti.h.

ublas::symmetric_matrix<double> trkf::KHitMulti::fRinv

mutableprivate

Residual inverse error matrix.

Definition at line 173 of file KHitMulti.h.

ublas::vector<double> trkf::KHitMulti::fRvec

mutableprivate

Residual vector.

Definition at line 171 of file KHitMulti.h.

---

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

• KHitMulti.h
• KHitMulti.cxx