RecoVertex/VertexPrimitives/interface/TransientVertex.h - master - githubmirror/cmssw

RecoVertex/VertexPrimitives/interface/TransientVertex.h
282 строки11 KB
Cms Build
Clang-Format
24 май 2019, 00:16
24 май 2019, 00:16876d1ce
#ifndef _Vtx_TransientVertex_H_
#define _Vtx_TransientVertex_H_

#include "DataFormats/GeometryVector/interface/GlobalPoint.h"
#include "DataFormats/GeometryCommonDetAlgo/interface/GlobalError.h"
#include "TrackingTools/TransientTrack/interface/TransientTrack.h"
#include "RecoVertex/VertexPrimitives/interface/VertexState.h"
#include "RecoVertex/VertexPrimitives/interface/TTtoTTmap.h"
#include "DataFormats/VertexReco/interface/Vertex.h"
#include "DataFormats/Candidate/interface/VertexCompositePtrCandidate.h"

#include <vector>
#include <map>

/** \class TransientVertex
 */

class TransientVertex {  //: public reco::Vertex {

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

  /** Empty constructor, produces invalid vertex
   */
  TransientVertex();

  /** Constructor defining the RecVertex by its 3D position
   *  and position uncertainty, its associated tracks
   *  and its chi-squared.
   *  The number of degrees of freedom is equal to
   *  2*nb of tracks - 3.
   */
  TransientVertex(const GlobalPoint& pos,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2);
  TransientVertex(const GlobalPoint& pos,
                  const double time,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2);

  /** Constructor defining the RecVertex by its 3D position
   *  and position uncertainty, its associated tracks, its chi-squared
   *  and its number of degrees of freedom.
   *  The ndf can be a float.
   */
  TransientVertex(const GlobalPoint& pos,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2,
                  float ndf);
  TransientVertex(const GlobalPoint& pos,
                  const double time,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2,
                  float ndf);

  /** Constructor defining the RecVertex by the prior,
   *  the vertex 3D position and uncertainty, the associated tracks
   *  and the chi-squared. Since the prior brings information on
   *  3 coordinates, the number of degrees of freedom is equal to
   *  2*nb of tracks.
   */
  TransientVertex(const GlobalPoint& priorPos,
                  const GlobalError& priorErr,
                  const GlobalPoint& pos,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2);
  TransientVertex(const GlobalPoint& priorPos,
                  const double priorTime,
                  const GlobalError& priorErr,
                  const GlobalPoint& pos,
                  const double time,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2);

  /** Constructor defining the RecVertex by the prior,
   *  the vertex 3D position and uncertainty, the associated tracks,
   *  the chi-squared and the number of degrees of freedom.
   *  The ndf can be a float.
   */
  TransientVertex(const GlobalPoint& priorPos,
                  const GlobalError& priorErr,
                  const GlobalPoint& pos,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2,
                  float ndf);
  TransientVertex(const GlobalPoint& priorPos,
                  const double priorTime,
                  const GlobalError& priorErr,
                  const GlobalPoint& pos,
                  const double time,
                  const GlobalError& posError,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2,
                  float ndf);

  /** Constructor defining the RecVertex by the prior,
   *  the vertex 3D position and uncertainty, time and uncertainty, the associated tracks,
   *  the chi-squared and the number of degrees of freedom.
   *  The ndf can be a float.
   */
  TransientVertex(const GlobalPoint& priorPos,
                  const GlobalError& priorErr,
                  const double priorTime,
                  const double priorTimeErr,
                  const GlobalPoint& pos,
                  const GlobalError& posError,
                  const double time,
                  const double timeErr,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2,
                  float ndf);

  /** Constructor defining the RecVertex by its 3D position 
   *  and position uncertainty, its associated tracks 
   *  and its chi-squared. 
   *  The number of degrees of freedom is equal to 
   *  2*nb of tracks - 3.
   */
  TransientVertex(const VertexState& state, const std::vector<reco::TransientTrack>& tracks, float chi2);

  /** Constructor defining the RecVertex by its 3D position
   *  and position uncertainty, its associated tracks, its chi-squared
   *  and its number of degrees of freedom.
   *  The ndf can be a float.
   */
  TransientVertex(const VertexState& state, const std::vector<reco::TransientTrack>& tracks, float chi2, float ndf);

  /** Constructor defining the RecVertex by the prior,
   *  the vertex 3D position and uncertainty, the associated tracks
   *  and the chi-squared. Since the prior brings information on
   *  3 coordinates, the number of degrees of freedom is equal to
   *  2*nb of tracks.
   */
  TransientVertex(const VertexState& prior,
                  const VertexState& state,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2);

  /** Constructor defining the RecVertex by the prior,
   *  the vertex 3D position and uncertainty, the associated tracks,
   *  the chi-squared and the number of degrees of freedom.
   *  The ndf can be a float.
   */
  TransientVertex(const VertexState& prior,
                  const VertexState& state,
                  const std::vector<reco::TransientTrack>& tracks,
                  float chi2,
                  float ndf);

  //   /** Constructor defining the RecVertex by its 3D position
  //    *  and position uncertainty, its associated tracks, its chi-squared
  //    *  and its number of degrees of freedom, and the track weights.
  //    *  The ndf can be a float.
  //    */
  //   TransientVertex(const VertexState & state,
  // 		    const std::vector<reco::TransientTrack> & tracks, float chi2, float ndf,
  // 		    const reco::TransientTrackToFloatMap & weightMap);

  /** Access methods
   */
  VertexState const& vertexState() const { return theVertexState; }
  GlobalPoint position() const { return theVertexState.position(); }
  GlobalError positionError() const {
    return theVertexState.is4D() ? theVertexState.error4D() : theVertexState.error();
  }
  GlobalPoint priorPosition() const { return thePriorVertexState.position(); }
  GlobalError priorError() const {
    return thePriorVertexState.is4D() ? thePriorVertexState.error4D() : thePriorVertexState.error();
  }
  double time() const { return theVertexState.time(); }
  double timeError() const { return theVertexState.timeError(); }
  double priorTime() const { return thePriorVertexState.time(); }
  double priorTimeError() const { return thePriorVertexState.timeError(); }
  bool hasPrior() const { return withPrior; }

  //   /** Implements method of abstract Vertex.
  //    *  Returns track pointer container by value
  //    */
  //   Vertex::TrackPtrContainer tracks() const;

  float totalChiSquared() const { return theChi2; }
  float normalisedChiSquared() const { return totalChiSquared() / degreesOfFreedom(); }
  float degreesOfFreedom() const { return theNDF; }

  /** Returns true if vertex is valid.
   *  An invalid RecVertex is created e.g. when vertex fitting fails.
   */
  bool isValid() const { return vertexValid; }

  /** Access to the original tracks used to make the vertex.
   *  Returns track container by value.
   */
  std::vector<reco::TransientTrack> const& originalTracks() const { return theOriginalTracks; }

  /**
   * Returns true if at for at least one of the original tracks,
   * the refitted track is available
   */
  bool hasRefittedTracks() const { return withRefittedTracks; }

  /** Access to the refitted tracks used to make the vertex.
   *  Returns track container by value.
   */
  std::vector<reco::TransientTrack> const& refittedTracks() const { return theRefittedTracks; }

  /**
   * Returns the original track which corresponds to a particular refitted Track
   * Throws an exception if now refitted tracks are stored ot the track is not found in the list
   */

  reco::TransientTrack originalTrack(const reco::TransientTrack& refTrack) const;

  /**
   * Returns the refitted track which corresponds to a particular original Track
   * Throws an exception if now refitted tracks are stored ot the track is not found in the list
   */
  reco::TransientTrack refittedTrack(const reco::TransientTrack& track) const;

  /** Method to set the refitted tracks used to make the vertex.
   */
  void refittedTracks(const std::vector<reco::TransientTrack>& refittedTracks);

  /**
   * Returns true if the track-weights are available.
   */
  bool hasTrackWeight() const { return theWeightMapIsAvailable; }

  /**
   *   Returns the weight with which a track has been used in the fit.
   *   If the track is not present in the list, it is obviously not used, and
   *   this method returns a weight of 0.
   *   If this information has not been provided at construction, a weight of
   *   1.0 is assumed for all tracks used and present in the originalTracks() std::vector.
   */
  float trackWeight(const reco::TransientTrack& track) const;

  TransientTrackToFloatMap weightMap() const { return theWeightMap; }

  void weightMap(const TransientTrackToFloatMap& theMap);

  /**
   * Returns true if the Track-to-track covariance matrices have been calculated.
   */
  bool tkToTkCovarianceIsAvailable() const { return theCovMapAvailable; }

  /**
   *   Returns the Track-to-track covariance matrix for two specified tracks.
   *   In case these do not exist, or one of the tracks does not belong to the
   *   vertex, an exception is thrown.
   */
  AlgebraicMatrix33 tkToTkCovariance(const reco::TransientTrack& t1, const reco::TransientTrack& t2) const;
  void tkToTkCovariance(const TTtoTTmap& covMap);

  operator reco::Vertex() const;
  operator reco::VertexCompositePtrCandidate() const;

private:
  mutable VertexState thePriorVertexState;
  mutable VertexState theVertexState;

  //   void addTracks(const std::vector<reco::TransientTrack> & tracks);

  std::vector<reco::TransientTrack> theOriginalTracks;
  std::vector<reco::TransientTrack> theRefittedTracks;

  float theChi2;
  float theNDF;
  bool vertexValid;
  bool withPrior, theWeightMapIsAvailable, theCovMapAvailable;
  bool withRefittedTracks;
  TTtoTTmap theCovMap;
  TransientTrackToFloatMap theWeightMap;
};

#endif