CMS 3D CMS Logo

List of all members | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes
KFTrajectoryFitter Class Referencefinal

#include <KFTrajectoryFitter.h>

Inheritance diagram for KFTrajectoryFitter:
TrajectoryFitter

Public Member Functions

std::unique_ptr< TrajectoryFitterclone () const override
 
const MeasurementEstimatorestimator () const
 
Trajectory fitOne (const Trajectory &aTraj, fitType) const override
 
Trajectory fitOne (const TrajectorySeed &aSeed, const RecHitContainer &hits, fitType) const override
 
Trajectory fitOne (const TrajectorySeed &aSeed, const RecHitContainer &hits, const TSOS &firstPredTsos, fitType) const override
 
 KFTrajectoryFitter (const Propagator &aPropagator, const TrajectoryStateUpdator &aUpdator, const MeasurementEstimator &aEstimator, int minHits=3, const DetLayerGeometry *detLayerGeometry=0, TkCloner const *hc=0)
 
 KFTrajectoryFitter (const Propagator *aPropagator, const TrajectoryStateUpdator *aUpdator, const MeasurementEstimator *aEstimator, int minHits=3, const DetLayerGeometry *detLayerGeometry=0, TkCloner const *hc=0)
 
const Propagatorpropagator () const
 
void setHitCloner (TkCloner const *hc) override
 
const TrajectoryStateUpdatorupdator () const
 
 ~KFTrajectoryFitter () override
 
- Public Member Functions inherited from TrajectoryFitter
std::vector< Trajectoryfit (const Trajectory &traj, fitType type=standard) const
 
std::vector< Trajectoryfit (const TrajectorySeed &seed, const RecHitContainer &hits, fitType type=standard) const
 
std::vector< Trajectoryfit (const TrajectorySeed &seed, const RecHitContainer &hits, const TrajectoryStateOnSurface &tsos, fitType type=standard) const
 
virtual ~TrajectoryFitter ()
 

Private Types

typedef FreeTrajectoryState FTS
 
typedef TrajectoryMeasurement TM
 
typedef TrajectoryStateOnSurface TSOS
 

Private Member Functions

 KFTrajectoryFitter (KFTrajectoryFitter const &)=delete
 

Private Attributes

int minHits_
 
bool owner
 
const MeasurementEstimatortheEstimator
 
const DetLayerGeometrytheGeometry
 
TkCloner const * theHitCloner = 0
 
const PropagatorthePropagator
 
const TrajectoryStateUpdatortheUpdator
 

Static Private Attributes

static const DetLayerGeometry dummyGeometry
 

Additional Inherited Members

- Public Types inherited from TrajectoryFitter
enum  fitType { standard =0, looper =1 }
 
typedef Trajectory::RecHitContainer RecHitContainer
 
typedef TrajectoryFitterRecord Record
 

Detailed Description

A Kalman track fit that splits matched RecHits into individual components before fitting them. Ported from ORCA

Author
todorov, cerati

A Standard Kalman fit. Ported from ORCA

Author
todorov, cerati

Definition at line 22 of file KFTrajectoryFitter.h.

Member Typedef Documentation

Definition at line 27 of file KFTrajectoryFitter.h.

Definition at line 28 of file KFTrajectoryFitter.h.

Definition at line 26 of file KFTrajectoryFitter.h.

Constructor & Destructor Documentation

KFTrajectoryFitter::KFTrajectoryFitter ( const Propagator aPropagator,
const TrajectoryStateUpdator aUpdator,
const MeasurementEstimator aEstimator,
int  minHits = 3,
const DetLayerGeometry detLayerGeometry = 0,
TkCloner const *  hc = 0 
)
inline

Definition at line 34 of file KFTrajectoryFitter.h.

References dummyGeometry, and theGeometry.

Referenced by clone(), and setHitCloner().

39  :
40  thePropagator(aPropagator.clone()),
41  theUpdator(aUpdator.clone()),
42  theEstimator(aEstimator.clone()),
44  theGeometry(detLayerGeometry),
46  owner(true){
48  // FIXME. Why this first constructor is needed? who is using it? Can it be removed?
49  // it is uses in many many places
50  }
virtual Propagator * clone() const =0
const MeasurementEstimator * theEstimator
const TrajectoryStateUpdator * theUpdator
static const DetLayerGeometry dummyGeometry
virtual MeasurementEstimator * clone() const =0
const DetLayerGeometry * theGeometry
const Propagator * thePropagator
susybsm::HSCParticleCollection hc
Definition: classes.h:25
virtual TrajectoryStateUpdator * clone() const =0
TkCloner const * theHitCloner
KFTrajectoryFitter::KFTrajectoryFitter ( const Propagator aPropagator,
const TrajectoryStateUpdator aUpdator,
const MeasurementEstimator aEstimator,
int  minHits = 3,
const DetLayerGeometry detLayerGeometry = 0,
TkCloner const *  hc = 0 
)
inline

Definition at line 53 of file KFTrajectoryFitter.h.

References dummyGeometry, and theGeometry.

58  :
59  thePropagator(aPropagator),
60  theUpdator(aUpdator),
61  theEstimator(aEstimator),
63  theGeometry(detLayerGeometry),
65  owner(false){
67  }
const MeasurementEstimator * theEstimator
const TrajectoryStateUpdator * theUpdator
static const DetLayerGeometry dummyGeometry
const DetLayerGeometry * theGeometry
const Propagator * thePropagator
susybsm::HSCParticleCollection hc
Definition: classes.h:25
TkCloner const * theHitCloner
KFTrajectoryFitter::~KFTrajectoryFitter ( )
inlineoverride

Definition at line 69 of file KFTrajectoryFitter.h.

References fitOne(), hfClusterShapes_cfi::hits, owner, theEstimator, thePropagator, and theUpdator.

69  {
70  if (owner) {
71  delete thePropagator;
72  delete theUpdator;
73  delete theEstimator;
74  }
75  }
const MeasurementEstimator * theEstimator
const TrajectoryStateUpdator * theUpdator
const Propagator * thePropagator
KFTrajectoryFitter::KFTrajectoryFitter ( KFTrajectoryFitter const &  )
privatedelete

Member Function Documentation

std::unique_ptr<TrajectoryFitter> KFTrajectoryFitter::clone ( void  ) const
inlineoverridevirtual

Implements TrajectoryFitter.

Definition at line 89 of file KFTrajectoryFitter.h.

References KFTrajectoryFitter(), minHits_, owner, theEstimator, theGeometry, theHitCloner, thePropagator, and theUpdator.

90  {
91  return owner ?
92  std::unique_ptr<TrajectoryFitter>(new KFTrajectoryFitter(*thePropagator,
93  *theUpdator,
94  *theEstimator,
96  std::unique_ptr<TrajectoryFitter>(new KFTrajectoryFitter(thePropagator,
97  theUpdator,
99  minHits_,
101  }
const MeasurementEstimator * theEstimator
const TrajectoryStateUpdator * theUpdator
const DetLayerGeometry * theGeometry
KFTrajectoryFitter(const Propagator &aPropagator, const TrajectoryStateUpdator &aUpdator, const MeasurementEstimator &aEstimator, int minHits=3, const DetLayerGeometry *detLayerGeometry=0, TkCloner const *hc=0)
const Propagator * thePropagator
TkCloner const * theHitCloner
const MeasurementEstimator* KFTrajectoryFitter::estimator ( void  ) const
inline

Definition at line 87 of file KFTrajectoryFitter.h.

References theEstimator.

Referenced by KFSplittingFitter::clone(), and fitOne().

87 {return theEstimator;}
const MeasurementEstimator * theEstimator
Trajectory KFTrajectoryFitter::fitOne ( const Trajectory aTraj,
fitType  type 
) const
overridevirtual

Implements TrajectoryFitter.

Definition at line 13 of file KFTrajectoryFitter.cc.

References Trajectory::empty(), Trajectory::firstMeasurement(), Trajectory::recHits(), Trajectory::seed(), and TrajectoryMeasurement::updatedState().

Referenced by KFSplittingFitter::fitOne(), and ~KFTrajectoryFitter().

13  {
14 
15  if(aTraj.empty()) return Trajectory();
16 
17  const TM& firstTM = aTraj.firstMeasurement();
18  TSOS firstTsos = TrajectoryStateWithArbitraryError()(firstTM.updatedState());
19 
20  return fitOne(aTraj.seed(), aTraj.recHits(), firstTsos,type);
21 }
bool empty() const
True if trajectory has no measurements.
Definition: Trajectory.h:254
type
Definition: HCALResponse.h:21
TrajectorySeed const & seed() const
Access to the seed used to reconstruct the Trajectory.
Definition: Trajectory.h:285
ConstRecHitContainer recHits() const
Definition: Trajectory.h:204
TrajectoryMeasurement TM
Trajectory fitOne(const Trajectory &aTraj, fitType) const override
TrajectoryMeasurement const & firstMeasurement() const
Definition: Trajectory.h:187
Trajectory KFTrajectoryFitter::fitOne ( const TrajectorySeed aSeed,
const RecHitContainer hits,
fitType   
) const
overridevirtual

Implements TrajectoryFitter.

Definition at line 23 of file KFTrajectoryFitter.cc.

References Exception.

24  {
25 
26  throw cms::Exception("TrackFitters",
27  "KFTrajectoryFitter::fit(TrajectorySeed, <TransientTrackingRecHit>) not implemented");
28 
29  return Trajectory();
30 }
Trajectory KFTrajectoryFitter::fitOne ( const TrajectorySeed aSeed,
const RecHitContainer hits,
const TSOS firstPredTsos,
fitType   
) const
overridevirtual

Implements TrajectoryFitter.

Definition at line 32 of file KFTrajectoryFitter.cc.

References funct::abs(), anyDirection, TrackingRecHit::canImproveWithTrack(), DetId::det(), TrajectorySeed::direction(), FrontierConditions_GlobalTag_cff::dump, estimator(), TrackingRecHit::geographicalId(), DetLayerGeometry::idToLayer(), edm::isNotFinite(), TrajectoryStateOnSurface::isValid(), TrackingRecHit::isValid(), likely, TrajectoryStateOnSurface::localError(), TrajectoryStateOnSurface::localParameters(), TrajectoryStateOnSurface::localPosition(), LogDebug, LogTrace, TkCloner::makeShared(), minHits_, LocalTrajectoryError::posDef(), GloballyPositioned< T >::position(), LocalTrajectoryParameters::position(), LocalTrajectoryParameters::qbp(), Trajectory::reserve(), edm::second(), SetPropagationDirection(), TrackingRecHit::surface(), theGeometry, theHitCloner, thePropagator, DetId::Tracker, mitigatedMETSequence_cff::U, unlikely, TrajectoryStateUpdator::update(), updator(), PV3DBase< T, PVType, FrameType >::x(), and PV3DBase< T, PVType, FrameType >::y().

35 {
36  if(hits.empty()) return Trajectory();
37 
38 
39  if unlikely(aSeed.direction() == anyDirection)
40  throw cms::Exception("KFTrajectoryFitter","TrajectorySeed::direction() requested but not set");
41 
42  std::unique_ptr<Propagator> p_cloned = SetPropagationDirection(*thePropagator,
43  aSeed.direction());
44 
45 #ifdef EDM_ML_DEBUG
46  LogDebug("TrackFitters")
47  <<" +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n"
48  <<" KFTrajectoryFitter::fit starting with " << hits.size() <<" HITS";
49 
50  for (unsigned int j=0;j<hits.size();j++) {
51  if (hits[j]->det())
52  LogTrace("TrackFitters") << "hit #:" << j+1 << " rawId=" << hits[j]->det()->geographicalId().rawId()
53  << " validity=" << hits[j]->isValid();
54  else
55  LogTrace("TrackFitters") << "hit #:" << j+1 << " Hit with no Det information";
56  }
57  LogTrace("TrackFitters") << " INITIAL STATE "<< firstPredTsos;
58 #endif
59 
60  Trajectory ret(aSeed, p_cloned->propagationDirection());
61  Trajectory & myTraj = ret;
62  myTraj.reserve(hits.size());
63 
64  TSOS predTsos(firstPredTsos);
65  TSOS currTsos;
66 
67  int hitcounter = 0;
68  for(auto ihit : hits) {
69  ++hitcounter;
70 
71  const TransientTrackingRecHit & hit = (*ihit);
72 
73  // if unlikely(hit.det() == nullptr) continue;
74 
75  if unlikely( (!hit.isValid()) && hit.surface() == nullptr) {
76  LogDebug("TrackFitters")<< " Error: invalid hit with no GeomDet attached .... skipping";
77  continue;
78  }
79  // if (hit.det() && hit.geographicalId()<1000U) LogDebug("TrackFitters")<< "Problem 0 det id for " << typeid(hit).name() << ' ' << hit.det()->geographicalId() ;
80  // if (hit.isValid() && hit.geographicalId()<1000U) LogDebug("TrackFitters")<< "Problem 0 det id for " << typeid(hit).name() << ' ' << hit.det()->geographicalId();
81 
82  if ( hitcounter != 1) //no propagation needed for the first hit
83  predTsos = p_cloned->propagate( currTsos, *(hit.surface()) );
84 
85 
86  if unlikely(!predTsos.isValid()) {
87  LogDebug("TrackFitters")
88  << "SOMETHING WRONG !" << "\n"
89  << "KFTrajectoryFitter: predicted tsos not valid!\n"
90  << "current TSOS: " << currTsos << "\n";
91 
92  if(hit.surface()) LogTrace("TrackFitters") << "next Surface: " << hit.surface()->position() << "\n";
93 
94  if( myTraj.foundHits() >= minHits_ ) {
95  LogDebug("TrackFitters") << " breaking trajectory" << "\n";
96  break;
97  } else {
98  LogDebug("TrackFitters") << " killing trajectory" << "\n";
99  return Trajectory();
100  }
101  }
102 
103 
104  if likely(hit.isValid()) {
105  assert( (hit.geographicalId()!=0U) | !hit.canImproveWithTrack() ) ;
106  assert(hit.surface()!=nullptr);
107  //update
108  LogTrace("TrackFitters") << "THE HIT IS VALID: updating hit with predTsos";
109  assert( (!hit.canImproveWithTrack()) | (nullptr!=theHitCloner));
110  assert( (!hit.canImproveWithTrack()) | (nullptr!=dynamic_cast<BaseTrackerRecHit const*>((ihit).get())));
111  auto preciseHit = theHitCloner->makeShared(ihit,predTsos);
112  dump(*preciseHit,hitcounter,"TrackFitters");
113  assert(preciseHit->isValid());
114  assert( (preciseHit->geographicalId()!=0U) | (!preciseHit->canImproveWithTrack()) );
115  assert(preciseHit->surface()!=nullptr);
116 
117  if unlikely(!preciseHit->isValid()){
118  LogTrace("TrackFitters") << "THE Precise HIT IS NOT VALID: using currTsos = predTsos" << "\n";
119  currTsos = predTsos;
120  myTraj.push(TM(predTsos, ihit,0,theGeometry->idToLayer((ihit)->geographicalId()) ));
121 
122  }else{
123  LogTrace("TrackFitters") << "THE Precise HIT IS VALID: updating currTsos" << "\n";
124  currTsos = updator()->update(predTsos, *preciseHit);
125  //check for valid hits with no det (refitter with constraints)
126  bool badState = (!currTsos.isValid())
127  || (hit.geographicalId().det() == DetId::Tracker
128  &&
129  (std::abs(currTsos.localParameters().qbp())>100
130  || std::abs(currTsos.localParameters().position().y()) > 1000
131  || std::abs(currTsos.localParameters().position().x()) > 1000
132  ) )
133  || edm::isNotFinite(currTsos.localParameters().qbp())
134  || !currTsos.localError().posDef();
135  if unlikely(badState){
136  if (!currTsos.isValid()) {
137  edm::LogError("FailedUpdate") <<"updating with the hit failed. Not updating the trajectory with the hit";
138 
139  }
140  else if (edm::isNotFinite(currTsos.localParameters().qbp())) {
141  edm::LogError("TrajectoryNaN")<<"Trajectory has NaN";
142 
143  }
144  else if (!currTsos.localError().posDef()) {
145  edm::LogError("TrajectoryNotPosDef")<<"Trajectory covariance is not positive-definite";
146 
147  }
148  else{
149  LogTrace("FailedUpdate")<<"updated state is valid but pretty bad, skipping. currTsos " <<currTsos<<"\n predTsos "<<predTsos;
150  }
151  myTraj.push(TM(predTsos, ihit,0,theGeometry->idToLayer((ihit)->geographicalId()) ));
152  //There is a no-fail policy here. So, it's time to give up
153  //Keep the traj with invalid TSOS so that it's clear what happened
154  if( myTraj.foundHits() >= minHits_ ) {
155  LogDebug("TrackFitters") << " breaking trajectory" << "\n";
156  break;
157  } else {
158  LogDebug("TrackFitters") << " killing trajectory" << "\n";
159  return Trajectory();
160  }
161  } else{
162  if (preciseHit->det()){
163  myTraj.push(TM(predTsos, currTsos, preciseHit,
164  estimator()->estimate(predTsos, *preciseHit).second,
165  theGeometry->idToLayer(preciseHit->geographicalId()) ));
166  }
167  else{
168  myTraj.push(TM(predTsos, currTsos, preciseHit,
169  estimator()->estimate(predTsos, *preciseHit).second));
170  }
171  }
172  }
173  } else { // invalid hit
174  dump(hit,hitcounter,"TrackFitters");
175  //no update
176  LogDebug("TrackFitters") << "THE HIT IS NOT VALID: using currTsos" << "\n";
177  currTsos = predTsos;
178  assert( ((ihit)->det()==nullptr) || (ihit)->geographicalId()!=0U);
179  if ((ihit)->det()) myTraj.push(TM(predTsos, ihit,0,theGeometry->idToLayer((ihit)->geographicalId()) ));
180  else myTraj.push(TM(predTsos, ihit,0));
181  }
182  LogTrace("TrackFitters")
183  << "predTsos !" << "\n"
184  << predTsos
185  <<" with local position " << predTsos.localPosition()
186  <<"currTsos !" << "\n"
187  << currTsos
188  <<" with local position " << currTsos.localPosition();
189  }
190 
191  LogDebug("TrackFitters") << "Found 1 trajectory with " << myTraj.foundHits() << " valid hits\n";
192 
193  return ret;
194 }
#define LogDebug(id)
PropagationDirection direction() const
virtual const Surface * surface() const
const LocalTrajectoryParameters & localParameters() const
const TrajectoryStateUpdator * updator() const
LocalPoint position() const
Local x and y position coordinates.
const MeasurementEstimator * estimator() const
T y() const
Definition: PV3DBase.h:63
TrajectoryMeasurement TM
TrackingRecHit::ConstRecHitPointer makeShared(TrackingRecHit::ConstRecHitPointer const &hit, TrajectoryStateOnSurface const &tsos) const
Definition: TkCloner.h:23
void reserve(unsigned int n)
Definition: Trajectory.h:150
virtual TrajectoryStateOnSurface update(const TrajectoryStateOnSurface &, const TrackingRecHit &) const =0
#define unlikely(x)
U second(std::pair< T, U > const &p)
#define likely(x)
std::unique_ptr< Propagator > SetPropagationDirection(Propagator const &iprop, PropagationDirection dir)
bool isNotFinite(T x)
Definition: isFinite.h:10
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
const LocalTrajectoryError & localError() const
#define LogTrace(id)
const DetLayerGeometry * theGeometry
virtual bool canImproveWithTrack() const
bool isValid() const
const Propagator * thePropagator
DetId geographicalId() const
virtual const DetLayer * idToLayer(const DetId &detId) const
Detector det() const
get the detector field from this detid
Definition: DetId.h:36
T x() const
Definition: PV3DBase.h:62
const PositionType & position() const
TkCloner const * theHitCloner
const Propagator* KFTrajectoryFitter::propagator ( ) const
inline

Definition at line 85 of file KFTrajectoryFitter.h.

References thePropagator.

Referenced by KFSplittingFitter::clone().

85 {return thePropagator;}
const Propagator * thePropagator
void KFTrajectoryFitter::setHitCloner ( TkCloner const *  hc)
inlineoverridevirtual

Implements TrajectoryFitter.

Definition at line 104 of file KFTrajectoryFitter.h.

References AnalysisDataFormats_SUSYBSMObjects::hc, KFTrajectoryFitter(), and theHitCloner.

Referenced by KFSplittingFitter::setHitCloner().

104 { theHitCloner = hc;}
susybsm::HSCParticleCollection hc
Definition: classes.h:25
TkCloner const * theHitCloner
const TrajectoryStateUpdator* KFTrajectoryFitter::updator ( ) const
inline

Definition at line 86 of file KFTrajectoryFitter.h.

References theUpdator.

Referenced by KFSplittingFitter::clone(), and fitOne().

86 {return theUpdator;}
const TrajectoryStateUpdator * theUpdator

Member Data Documentation

const DetLayerGeometry KFTrajectoryFitter::dummyGeometry
staticprivate

Definition at line 111 of file KFTrajectoryFitter.h.

Referenced by KFTrajectoryFitter().

int KFTrajectoryFitter::minHits_
private

Definition at line 117 of file KFTrajectoryFitter.h.

Referenced by clone(), and fitOne().

bool KFTrajectoryFitter::owner
private

Definition at line 118 of file KFTrajectoryFitter.h.

Referenced by clone(), and ~KFTrajectoryFitter().

const MeasurementEstimator* KFTrajectoryFitter::theEstimator
private

Definition at line 114 of file KFTrajectoryFitter.h.

Referenced by clone(), estimator(), and ~KFTrajectoryFitter().

const DetLayerGeometry* KFTrajectoryFitter::theGeometry
private

Definition at line 116 of file KFTrajectoryFitter.h.

Referenced by clone(), fitOne(), and KFTrajectoryFitter().

TkCloner const* KFTrajectoryFitter::theHitCloner = 0
private

Definition at line 115 of file KFTrajectoryFitter.h.

Referenced by clone(), fitOne(), and setHitCloner().

const Propagator* KFTrajectoryFitter::thePropagator
private

Definition at line 112 of file KFTrajectoryFitter.h.

Referenced by clone(), fitOne(), propagator(), and ~KFTrajectoryFitter().

const TrajectoryStateUpdator* KFTrajectoryFitter::theUpdator
private

Definition at line 113 of file KFTrajectoryFitter.h.

Referenced by clone(), updator(), and ~KFTrajectoryFitter().