CachingVertex.cc

Go to the documentation of this file.

#include "RecoVertex/VertexPrimitives/interface/CachingVertex.h"
#include "RecoVertex/VertexPrimitives/interface/LinearizedTrackState.h"
#include "RecoVertex/VertexPrimitives/interface/VertexException.h"
#include "TrackingTools/TransientTrack/interface/TransientTrack.h"
#include "RecoVertex/VertexPrimitives/interface/TTtoTTmap.h"
#include <map>

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& pos,
                                const GlobalError& posErr,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, posErr),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(false)

{}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& pos,
                                const double time,
                                const GlobalError& posTimeErr,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, time, posTimeErr),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(true)

{}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& pos,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(false) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& pos,
                                const double time,
                                const GlobalWeight& posTimeWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, time, posTimeWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(true) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const AlgebraicVector3& weightTimesPosition,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(weightTimesPosition, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(false) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const AlgebraicVector4& weightTimesPosition,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(weightTimesPosition, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(false) {}

template <unsigned int N>
CachingVertex<N>::CachingVertex(const VertexState& aVertexState,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(aVertexState),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(true),
      vertexIs4D(aVertexState.is4D()) {}

template <unsigned int N>
CachingVertex<N>::CachingVertex(const VertexState& aVertexState,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq,
                                const TrackToTrackMap& covMap)
    : theVertexState(aVertexState),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMap(covMap),
      theCovMapAvailable(true),
      withPrior(false),
      theValid(true),
      vertexIs4D(aVertexState.is4D()) {
  if (theCovMap.empty())
    theCovMapAvailable = false;
}

template <unsigned int N>
CachingVertex<N>::CachingVertex(const VertexState& priorVertexState,
                                const VertexState& aVertexState,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(aVertexState),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorVertexState),
      withPrior(true),
      theValid(true),
      vertexIs4D(priorVertexState.is4D() && aVertexState.is4D()) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& priorPos,
                                const GlobalError& priorErr,
                                const GlobalPoint& pos,
                                const GlobalError& posErr,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, posErr),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorPos, priorErr),
      withPrior(true),
      theValid(true),
      vertexIs4D(false) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& priorPos,
                                const double priorTime,
                                const GlobalError& priorErr,
                                const GlobalPoint& pos,
                                const double time,
                                const GlobalError& posErr,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, time, posErr),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorPos, priorTime, priorErr),
      withPrior(true),
      theValid(true),
      vertexIs4D(true) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& priorPos,
                                const GlobalError& priorErr,
                                const GlobalPoint& pos,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorPos, priorErr),
      withPrior(true),
      theValid(true),
      vertexIs4D(false) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& priorPos,
                                const double priorTime,
                                const GlobalError& priorErr,
                                const GlobalPoint& pos,
                                const double time,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(pos, priorTime, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorPos, priorTime, priorErr),
      withPrior(true),
      theValid(true),
      vertexIs4D(true) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& priorPos,
                                const GlobalError& priorErr,
                                const AlgebraicVector3& weightTimesPosition,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(weightTimesPosition, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorPos, priorErr),
      withPrior(true),
      theValid(true) {}

//to be removed
template <unsigned int N>
CachingVertex<N>::CachingVertex(const GlobalPoint& priorPos,
                                const GlobalError& priorErr,
                                const AlgebraicVector4& weightTimesPosition,
                                const GlobalWeight& posWeight,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq)
    : theVertexState(weightTimesPosition, posWeight),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMapAvailable(false),
      thePriorVertexState(priorPos, priorErr),
      withPrior(true),
      theValid(true) {}

template <unsigned int N>
CachingVertex<N>::CachingVertex(const VertexState& priorVertexState,
                                const VertexState& aVertexState,
                                const std::vector<RefCountedVertexTrack>& tks,
                                float totalChiSq,
                                const TrackToTrackMap& covMap)
    : theVertexState(aVertexState),
      theChiSquared(totalChiSq),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(tks),
      theCovMap(covMap),
      theCovMapAvailable(true),
      thePriorVertexState(priorVertexState),
      withPrior(true),
      theValid(true),
      vertexIs4D(priorVertexState.is4D() && aVertexState.is4D()) {
  if (theCovMap.empty())
    theCovMapAvailable = false;
}

template <unsigned int N>
CachingVertex<N>::CachingVertex()
    : theChiSquared(-1),
      theNDF(0),
      theNDFAvailable(false),
      theTracks(),
      theCovMapAvailable(false),
      withPrior(false),
      theValid(false),
      vertexIs4D(false) {}

template <unsigned int N>
GlobalPoint CachingVertex<N>::position() const {
  return theVertexState.position();
}

template <unsigned int N>
double CachingVertex<N>::time() const {
  return theVertexState.time();
}

template <unsigned int N>
GlobalError CachingVertex<N>::error() const {
  return theVertexState.error();
}

template <unsigned int N>
GlobalError CachingVertex<N>::error4D() const {
  return theVertexState.error4D();
}

template <unsigned int N>
GlobalWeight CachingVertex<N>::weight() const {
  return theVertexState.weight();
}

template <unsigned int N>
GlobalWeight CachingVertex<N>::weight4D() const {
  return theVertexState.weight4D();
}

template <unsigned int N>
AlgebraicVector3 CachingVertex<N>::weightTimesPosition() const {
  return theVertexState.weightTimesPosition();
}

template <unsigned int N>
AlgebraicVector4 CachingVertex<N>::weightTimesPosition4D() const {
  return theVertexState.weightTimesPosition4D();
}

template <unsigned int N>
float CachingVertex<N>::degreesOfFreedom() const {
  if (!theNDFAvailable)
    computeNDF();
  return theNDF;
}

template <unsigned int N>
void CachingVertex<N>::computeNDF() const {
  theNDF = 0;
  for (typename std::vector<RefCountedVertexTrack>::const_iterator itk = theTracks.begin(); itk != theTracks.end();
       ++itk) {
    theNDF += (**itk).weight();  // adds up weights
  }
  theNDF *= 2.;                                // times 2df for each track
  const double adjust = (vertexIs4D ? 4 : 3);  // ndf adjust is 3 or 4
  if (!withPrior)
    theNDF -= adjust;
  theNDFAvailable = true;
}

template <unsigned int N>
typename CachingVertex<N>::AlgebraicMatrixMM CachingVertex<N>::tkToTkCovariance(const RefCountedVertexTrack t1,
                                                                                const RefCountedVertexTrack t2) const {
  if (!tkToTkCovarianceIsAvailable()) {
    throw VertexException("CachingVertex::TkTkCovariance requested before been calculated");
  } else {
    RefCountedVertexTrack tr1;
    RefCountedVertexTrack tr2;
    bool transp = false;
    if (t1 < t2) {
      tr1 = t1;
      tr2 = t2;
    } else {
      tr1 = t2;
      tr2 = t1;
      transp = true;
    }
    typename TrackToTrackMap::const_iterator it = theCovMap.find(tr1);
    if (it != theCovMap.end()) {
      const TrackMap& tm = it->second;
      typename TrackMap::const_iterator nit = tm.find(tr2);
      if (nit != tm.end()) {
        if (transp)
          return (ROOT::Math::Transpose(nit->second));
        else
          return (nit->second);
      } else {
        throw VertexException("CachingVertex::requested TkTkCovariance does not exist");
      }
    } else {
      throw VertexException("CachingVertex::requested TkTkCovariance does not exist");
    }
  }
}

template <unsigned int N>
CachingVertex<N>::operator TransientVertex() const {
  //If the vertex is invalid, return an invalid TV !
  if (!isValid())
    return TransientVertex();

  typedef std::map<reco::TransientTrack, float> TransientTrackToFloatMap;

  // Construct Track vector
  std::vector<reco::TransientTrack> ttVect;
  ttVect.reserve(theTracks.size());
  std::vector<reco::TransientTrack> refTTVect;
  TransientTrackToFloatMap theWeightMap;
  TTtoTTmap ttCovMap;
  // float theMinWeight = 0.5;

  for (typename std::vector<RefCountedVertexTrack>::const_iterator i = theTracks.begin(); i != theTracks.end(); ++i) {
    // discard tracks with too low weight
    // if ((**i).weight() < theMinWeight) continue;

    reco::TransientTrack t1((**i).linearizedTrack()->track());
    ttVect.push_back(t1);
    //Fill in the weight map
    theWeightMap[t1] = (**i).weight();

    //Fill in the tk-to-tk covariance map
    if (theCovMapAvailable) {
      for (typename std::vector<RefCountedVertexTrack>::const_iterator j = (i + 1); j != theTracks.end(); ++j) {
        reco::TransientTrack t2((**j).linearizedTrack()->track());
        ttCovMap[t1][t2] = tkToTkCovariance(*i, *j);
      }
    }
    if ((**i).refittedStateAvailable()) {
      refTTVect.push_back((**i).refittedState()->transientTrack());
    }
  }
  TransientVertex tv;
  if (withPrior) {
    tv = TransientVertex(priorVertexState(), vertexState(), ttVect, totalChiSquared(), degreesOfFreedom());
  } else {
    tv = TransientVertex(vertexState(), ttVect, totalChiSquared(), degreesOfFreedom());
  }
  tv.weightMap(theWeightMap);
  if (theCovMapAvailable)
    tv.tkToTkCovariance(ttCovMap);
  if (!refTTVect.empty())
    tv.refittedTracks(refTTVect);
  return tv;
}

template class CachingVertex<5>;
template class CachingVertex<6>;