#include <CkfTrackCandidateMakerBase.h>

Inheritance diagram for cms::CkfTrackCandidateMakerBase:

Public Member Functions
virtual void	beginRunBase (edm::Run const &, edm::EventSetup const &es)

	CkfTrackCandidateMakerBase (const edm::ParameterSet &conf, edm::ConsumesCollector &&iC)

virtual void	produceBase (edm::Event &e, const edm::EventSetup &es)

virtual	~CkfTrackCandidateMakerBase ()

Protected Types
typedef edm::ContainerMask < edmNew::DetSetVector < SiPixelCluster > >	PixelClusterMask

typedef edm::ContainerMask < edmNew::DetSetVector < SiStripCluster > >	StripClusterMask

Protected Member Functions
virtual void	countSeedsDebugger ()

virtual void	deleteAssocDebugger ()

virtual TrajectorySeedCollection::const_iterator	lastSeed (TrajectorySeedCollection const &theSeedColl)

virtual void	printHitsDebugger (edm::Event &e)

Protected Attributes
bool	cleanTrajectoryAfterInOut

bool	doSeedingRegionRebuilding

edm::EDGetTokenT < PixelClusterMask >	maskPixels_

edm::EDGetTokenT < StripClusterMask >	maskStrips_

unsigned int	maxSeedsBeforeCleaning_

bool	reverseTrajectories

bool	skipClusters_

edm::ESHandle < GeometricSearchTracker >	theGeomSearchTracker

std::unique_ptr < TransientInitialStateEstimator >	theInitialState

edm::ESHandle< MagneticField >	theMagField

const std::string	theMagFieldName

unsigned int	theMaxNSeeds

edm::EDGetTokenT < MeasurementTrackerEvent >	theMTELabel

const NavigationSchool *	theNavigationSchool

std::string	theNavigationSchoolName

RedundantSeedCleaner *	theSeedCleaner

edm::EDGetTokenT< edm::View < TrajectorySeed > >	theSeedLabel

bool	theTrackCandidateOutput

std::unique_ptr < BaseCkfTrajectoryBuilder >	theTrajectoryBuilder

const TrajectoryCleaner *	theTrajectoryCleaner

std::string	theTrajectoryCleanerName

bool	theTrajectoryOutput

bool	useSplitting

Private Member Functions
void	setEventSetup (const edm::EventSetup &es)
	Initialize EventSetup objects at each event. More...

Detailed Description

Definition at line 35 of file CkfTrackCandidateMakerBase.h.

Member Typedef Documentation

typedef edm::ContainerMask<edmNew::DetSetVector<SiPixelCluster> > cms::CkfTrackCandidateMakerBase::PixelClusterMask

protected

Definition at line 78 of file CkfTrackCandidateMakerBase.h.

typedef edm::ContainerMask<edmNew::DetSetVector<SiStripCluster> > cms::CkfTrackCandidateMakerBase::StripClusterMask

protected

Definition at line 79 of file CkfTrackCandidateMakerBase.h.

Constructor & Destructor Documentation

cms::CkfTrackCandidateMakerBase::CkfTrackCandidateMakerBase	(	const edm::ParameterSet &	conf,
		edm::ConsumesCollector &&	iC
	)

explicit

Definition at line 56 of file CkfTrackCandidateMakerBase.cc.

References edm::hlt::Exception, edm::ParameterSet::exists(), edm::ParameterSet::existsAs(), edm::ParameterSet::getParameter(), maskPixels_, maskStrips_, maxSeedsBeforeCleaning_, skipClusters_, AlCaHLTBitMon_QueryRunRegistry::string, theSeedCleaner, and theSeedLabel.

                                                                                                                 : 
     theTrackCandidateOutput(true),
     theTrajectoryOutput(false),
     useSplitting(conf.getParameter<bool>("useHitsSplitting")),
     doSeedingRegionRebuilding(conf.getParameter<bool>("doSeedingRegionRebuilding")),
     cleanTrajectoryAfterInOut(conf.getParameter<bool>("cleanTrajectoryAfterInOut")),
     reverseTrajectories(conf.existsAs<bool>("reverseTrajectories") && conf.getParameter<bool>("reverseTrajectories")),
     theMaxNSeeds(conf.getParameter<unsigned int>("maxNSeeds")),
     theTrajectoryBuilder(createBaseCkfTrajectoryBuilder(conf.getParameter<edm::ParameterSet>("TrajectoryBuilderPSet"), iC)),
     theTrajectoryCleanerName(conf.getParameter<std::string>("TrajectoryCleaner")), 
     theTrajectoryCleaner(0),
     theInitialState(new TransientInitialStateEstimator(conf.getParameter<ParameterSet>("TransientInitialStateEstimatorParameters"))),
     theMagFieldName(conf.exists("SimpleMagneticField") ? conf.getParameter<std::string>("SimpleMagneticField") : ""),
     theNavigationSchoolName(conf.getParameter<std::string>("NavigationSchool")),
     theNavigationSchool(0),
     theSeedCleaner(0),
     maxSeedsBeforeCleaning_(0),
     theMTELabel(iC.consumes<MeasurementTrackerEvent>(conf.getParameter<edm::InputTag>("MeasurementTrackerEvent"))),
     skipClusters_(false)
   {  
     //produces<TrackCandidateCollection>();  
     // old configuration totally descoped.
     //    if (!conf.exists("src"))
     //      theSeedLabel = InputTag(conf_.getParameter<std::string>("SeedProducer"),conf_.getParameter<std::string>("SeedLabel"));
     //    else
       theSeedLabel= iC.consumes<edm::View<TrajectorySeed> >(conf.getParameter<edm::InputTag>("src"));
       if ( conf.exists("maxSeedsBeforeCleaning") ) 
        maxSeedsBeforeCleaning_=conf.getParameter<unsigned int>("maxSeedsBeforeCleaning");
 
       if (conf.existsAs<edm::InputTag>("clustersToSkip")) {
         skipClusters_ = true;
         maskPixels_ = iC.consumes<PixelClusterMask>(conf.getParameter<edm::InputTag>("clustersToSkip"));
         maskStrips_ = iC.consumes<StripClusterMask>(conf.getParameter<edm::InputTag>("clustersToSkip"));
       }
 
     std::string cleaner = conf.getParameter<std::string>("RedundantSeedCleaner");
     if (cleaner == "SeedCleanerByHitPosition") {
         theSeedCleaner = new SeedCleanerByHitPosition();
     } else if (cleaner == "SeedCleanerBySharedInput") {
         theSeedCleaner = new SeedCleanerBySharedInput();
     } else if (cleaner == "CachingSeedCleanerByHitPosition") {
         theSeedCleaner = new CachingSeedCleanerByHitPosition();
     } else if (cleaner == "CachingSeedCleanerBySharedInput") {
       int numHitsForSeedCleaner = conf.existsAs<int>("numHitsForSeedCleaner") ?
     conf.getParameter<int>("numHitsForSeedCleaner") : 4;
       int onlyPixelHits = conf.existsAs<bool>("onlyPixelHitsForSeedCleaner") ?
     conf.getParameter<bool>("onlyPixelHitsForSeedCleaner") : false;
       theSeedCleaner = new CachingSeedCleanerBySharedInput(numHitsForSeedCleaner,onlyPixelHits);
     } else if (cleaner == "none") {
         theSeedCleaner = 0;
     } else {
         throw cms::Exception("RedundantSeedCleaner not found", cleaner);
     }
 
 
   }

cms::CkfTrackCandidateMakerBase::~CkfTrackCandidateMakerBase ( )

virtual

Definition at line 115 of file CkfTrackCandidateMakerBase.cc.

References theSeedCleaner.

                                                           {
     if (theSeedCleaner) delete theSeedCleaner;
   }  

Member Function Documentation

void cms::CkfTrackCandidateMakerBase::beginRunBase	(	edm::Run const &	r,
		edm::EventSetup const &	es
	)

virtual

Definition at line 119 of file CkfTrackCandidateMakerBase.cc.

Referenced by cms::CkfDebugTrackCandidateMaker::beginRun(), cms::CkfTrackCandidateMaker::beginRun(), and cms::CkfTrajectoryMaker::beginRun().

   {
     /* no op*/
   }

virtual void cms::CkfTrackCandidateMakerBase::countSeedsDebugger ( )

inlineprotectedvirtual

Reimplemented in cms::CkfDebugTrackCandidateMaker.

Definition at line 86 of file CkfTrackCandidateMakerBase.h.

Referenced by produceBase().

86 {;}

virtual void cms::CkfTrackCandidateMakerBase::deleteAssocDebugger ( )

inlineprotectedvirtual

Reimplemented in cms::CkfDebugTrackCandidateMaker.

Definition at line 87 of file CkfTrackCandidateMakerBase.h.

Referenced by produceBase().

87 {;}

virtual TrajectorySeedCollection::const_iterator cms::CkfTrackCandidateMakerBase::lastSeed ( TrajectorySeedCollection const & theSeedColl )

inlineprotectedvirtual

Definition at line 84 of file CkfTrackCandidateMakerBase.h.

84 {return theSeedColl.end();}

virtual void cms::CkfTrackCandidateMakerBase::printHitsDebugger ( edm::Event & e )

inlineprotectedvirtual

Reimplemented in cms::CkfDebugTrackCandidateMaker.

Definition at line 85 of file CkfTrackCandidateMakerBase.h.

Referenced by produceBase().

85 {;}

void cms::CkfTrackCandidateMakerBase::produceBase	(	edm::Event &	e,
		const edm::EventSetup &	es
	)

virtual

Definition at line 143 of file CkfTrackCandidateMakerBase.cc.

References RedundantSeedCleaner::add(), alongMomentum, TrajectoryCleaner::clean(), cleanTrajectoryAfterInOut, countSeedsDebugger(), data, deleteAssocDebugger(), TrackingRecHit::det(), RedundantSeedCleaner::done(), doSeedingRegionRebuilding, PrintoutHelper::dumpCandidates(), edm::OwnVector< T, P >::front(), edm::EventSetup::get(), edm::Event::getByToken(), RedundantSeedCleaner::good(), RedundantSeedCleaner::init(), edm::isNotFinite(), TrajectoryStateOnSurface::isValid(), Trajectory::isValid(), j, LogDebug, LogTrace, maskPixels_, maskStrips_, maxSeedsBeforeCleaning_, IterativeTracking_cff::MeasurementTrackerEvent, oppositeToMomentum, convertSQLitetoXML_cfg::output, trajectoryStateTransform::persistentState(), printHitsDebugger(), Trajectory::push(), edm::OwnVector< T, P >::push_back(), edm::Event::put(), TrackingRecHit::rawId(), PrintoutHelper::regressionTest(), reverseTrajectories, setEventSetup(), Trajectory::setNLoops(), Trajectory::setSeedRef(), edm::OwnVector< T, P >::size(), skipClusters_, GeomDet::surface(), theInitialState, theMaxNSeeds, theMTELabel, theSeedCleaner, theSeedLabel, theTrackCandidateOutput, theTrajectoryBuilder, theTrajectoryCleaner, theTrajectoryOutput, patCandidatesForDimuonsSequences_cff::tracker, and useSplitting.

Referenced by cms::CkfDebugTrackCandidateMaker::produce(), cms::CkfTrackCandidateMaker::produce(), and cms::CkfTrajectoryMaker::produce().

   { 
     // getting objects from the EventSetup
     setEventSetup( es ); 
 
     // set the correct navigation
     // NavigationSetter setter( *theNavigationSchool);
     
     // propagator
     edm::ESHandle<Propagator> thePropagator;
     es.get<TrackingComponentsRecord>().get("AnyDirectionAnalyticalPropagator",
                        thePropagator);
 
     // method for Debugging
     printHitsDebugger(e);
 
     // Step A: set Event for the TrajectoryBuilder
     edm::Handle<MeasurementTrackerEvent> data;
     e.getByToken(theMTELabel, data);
 
     std::auto_ptr<MeasurementTrackerEvent> dataWithMasks;
     if (skipClusters_) {
         edm::Handle<PixelClusterMask> pixelMask;
         e.getByToken(maskPixels_, pixelMask);
             edm::Handle<StripClusterMask> stripMask;
             e.getByToken(maskStrips_, stripMask);
             dataWithMasks.reset(new MeasurementTrackerEvent(*data, *stripMask, *pixelMask));
         //std::cout << "Trajectory builder " << conf_.getParameter<std::string>("@module_label") << " created with masks, " << std::endl;
         theTrajectoryBuilder->setEvent(e, es, &*dataWithMasks);
     } else {
         //std::cout << "Trajectory builder " << conf_.getParameter<std::string>("@module_label") << " created without masks, " << std::endl;
         theTrajectoryBuilder->setEvent(e, es, &*data);
     }
     // TISE ES must be set here due to dependence on theTrajectoryBuilder
     theInitialState->setEventSetup( es, static_cast<TkTransientTrackingRecHitBuilder const *>(theTrajectoryBuilder->hitBuilder())->cloner() );
 
     // Step B: Retrieve seeds
     
     edm::Handle<View<TrajectorySeed> > collseed;
     e.getByToken(theSeedLabel, collseed);
     
     // Step C: Create empty output collection
     std::auto_ptr<TrackCandidateCollection> output(new TrackCandidateCollection);    
     std::auto_ptr<std::vector<Trajectory> > outputT (new std::vector<Trajectory>());
 
     if ( (*collseed).size()>theMaxNSeeds ) {
       LogError("TooManySeeds")<<"Exceeded maximum numeber of seeds! theMaxNSeeds="<<theMaxNSeeds<<" nSeed="<<(*collseed).size();
       if (theTrackCandidateOutput){ e.put(output);}
       if (theTrajectoryOutput){e.put(outputT);}
       return;
     }
     
     // Step D: Invoke the building algorithm
     if ((*collseed).size()>0){
 
       unsigned int lastCleanResult=0;
       vector<Trajectory> rawResult;
       rawResult.reserve(collseed->size() * 4);
 
       if (theSeedCleaner) theSeedCleaner->init( &rawResult );
       
       // method for debugging
       countSeedsDebugger();
 
       vector<Trajectory> theTmpTrajectories;
 
       // Loop over seeds
       size_t collseed_size = collseed->size(); 
       for (size_t j = 0; j < collseed_size; j++){
 
     LogDebug("CkfPattern") << "======== Begin to look for trajectories from seed " << j << " ========"<<endl;
     
     // Check if seed hits already used by another track
     if (theSeedCleaner && !theSeedCleaner->good( &((*collseed)[j])) ) {
           LogDebug("CkfTrackCandidateMakerBase")<<" Seed cleaning kills seed "<<j;
           continue; 
         }
 
     // Build trajectory from seed outwards
         theTmpTrajectories.clear();
     auto const & startTraj = theTrajectoryBuilder->buildTrajectories( (*collseed)[j], theTmpTrajectories, nullptr );
     
        
     LogDebug("CkfPattern") << "======== In-out trajectory building found " << theTmpTrajectories.size()
                         << " trajectories from seed " << j << " ========"<<endl
                    <<PrintoutHelper::dumpCandidates(theTmpTrajectories);
     
         if (cleanTrajectoryAfterInOut) {
 
       // Select the best trajectory from this seed (declare others invalid)
       theTrajectoryCleaner->clean(theTmpTrajectories);
 
       LogDebug("CkfPattern") << "======== In-out trajectory cleaning gave the following valid trajectories from seed " 
                                  << j << " ========"<<endl
                  << PrintoutHelper::dumpCandidates(theTmpTrajectories);
         }
 
     // Optionally continue building trajectory back through 
     // seed and if possible further inwards.
     
     if (doSeedingRegionRebuilding) {
       theTrajectoryBuilder->rebuildTrajectories(startTraj,(*collseed)[j],theTmpTrajectories);      
 
       LogDebug("CkfPattern") << "======== Out-in trajectory building found " << theTmpTrajectories.size()
                           << " valid/invalid trajectories from seed " << j << " ========"<<endl
                  <<PrintoutHelper::dumpCandidates(theTmpTrajectories);
         }
     
 
         // Select the best trajectory from this seed (after seed region rebuilding, can be more than one)
     theTrajectoryCleaner->clean(theTmpTrajectories);
 
         LogDebug("CkfPattern") << "======== Trajectory cleaning gave the following valid trajectories from seed " 
                                << j << " ========"<<endl
                    <<PrintoutHelper::dumpCandidates(theTmpTrajectories);
 
     for(vector<Trajectory>::iterator it=theTmpTrajectories.begin();
         it!=theTmpTrajectories.end(); it++){
       if( it->isValid() ) {
         it->setSeedRef(collseed->refAt(j));
         // Store trajectory
         rawResult.push_back(std::move(*it));
         // Tell seed cleaner which hits this trajectory used.
             //TO BE FIXED: this cut should be configurable via cfi file
             if (theSeedCleaner && rawResult.back().foundHits()>3) theSeedCleaner->add( &rawResult.back() );
             //if (theSeedCleaner ) theSeedCleaner->add( & (*it) );
       }
     }
 
         theTmpTrajectories.clear();
         
     LogDebug("CkfPattern") << "rawResult trajectories found so far = " << rawResult.size();
 
     if ( maxSeedsBeforeCleaning_ >0 && rawResult.size() > maxSeedsBeforeCleaning_+lastCleanResult) {
           theTrajectoryCleaner->clean(rawResult);
           rawResult.erase(std::remove_if(rawResult.begin()+lastCleanResult,rawResult.end(),
                      std::not1(std::mem_fun_ref(&Trajectory::isValid))),
               rawResult.end());
           lastCleanResult=rawResult.size();
         }
 
       }
       // end of loop over seeds
       
       if (theSeedCleaner) theSeedCleaner->done();
    
       // std::cout << "VICkfPattern " << "rawResult trajectories found = " << rawResult.size() << std::endl;
 
    
       // Step E: Clean the results to avoid duplicate tracks
       // Rejected ones just flagged as invalid.
       theTrajectoryCleaner->clean(rawResult);
 
       LogDebug("CkfPattern") << "======== Final cleaning of entire event found " << rawResult.size() 
                              << " valid/invalid trajectories ======="<<endl
                  <<PrintoutHelper::dumpCandidates(rawResult);
 
       LogDebug("CkfPattern") << "removing invalid trajectories.";
 
       vector<Trajectory> & unsmoothedResult(rawResult);
       unsmoothedResult.erase(std::remove_if(unsmoothedResult.begin(),unsmoothedResult.end(),
                         std::not1(std::mem_fun_ref(&Trajectory::isValid))),
                  unsmoothedResult.end());
       
       // If requested, reverse the trajectories creating a new 1-hit seed on the last measurement of the track
       if (reverseTrajectories) {
         for (auto it = unsmoothedResult.begin(), ed = unsmoothedResult.end(); it != ed; ++it) {
           // reverse the trajectory only if it has valid hit on the last measurement (should happen)
           if (it->lastMeasurement().updatedState().isValid() && 
               it->lastMeasurement().recHit().get() != 0     &&
               it->lastMeasurement().recHit()->isValid()) {
             // I can't use reverse in place, because I want to change the seed
             // 1) reverse propagation direction
             PropagationDirection direction = it->direction();
             if (direction == alongMomentum)           direction = oppositeToMomentum;
             else if (direction == oppositeToMomentum) direction = alongMomentum;
             // 2) make a seed
             TrajectoryStateOnSurface const & initState = it->lastMeasurement().updatedState();
             auto                    initId = it->lastMeasurement().recHitR().rawId();
             PTrajectoryStateOnDet && state = trajectoryStateTransform::persistentState( initState, initId);
             TrajectorySeed::recHitContainer hits; 
             hits.push_back(it->lastMeasurement().recHit()->hit()->clone());
             boost::shared_ptr<const TrajectorySeed> seed(new TrajectorySeed(state, std::move(hits), direction));
             // 3) make a trajectory
             Trajectory trajectory(seed, direction);
         trajectory.setNLoops(it->nLoops());
             trajectory.setSeedRef(it->seedRef());
             // 4) push states in reversed order
             Trajectory::DataContainer &meas = it->measurements();
             for (auto itmeas = meas.rbegin(), endmeas = meas.rend(); itmeas != endmeas; ++itmeas) {
               trajectory.push(std::move(*itmeas));
             }
             // replace
             (*it)= std::move(trajectory); 
           } else {
             edm::LogWarning("CkfPattern_InvalidLastMeasurement") << "Last measurement of the trajectory is invalid, cannot reverse it";
           }     
         }
       }
 
    
       int viTotHits=0;   
    
       if (theTrackCandidateOutput){
     // Step F: Convert to TrackCandidates
        output->reserve(unsmoothedResult.size());
        Traj2TrackHits t2t(theTrajectoryBuilder->hitBuilder(),true);
 
        for (vector<Trajectory>::const_iterator it = unsmoothedResult.begin();
         it != unsmoothedResult.end(); ++it) {
     
      LogDebug("CkfPattern") << "copying "<<(useSplitting?"splitted":"un-splitted")<<" hits from trajectory";
      edm::OwnVector<TrackingRecHit> recHits;
          if(it->direction() != alongMomentum) LogDebug("CkfPattern") << "not along momentum... " << std::endl;
          t2t(*it,recHits,useSplitting);
 
          viTotHits+=recHits.size();        
 
      LogDebug("CkfPattern") << "getting initial state.";
      const bool doBackFit = (!doSeedingRegionRebuilding) & (!reverseTrajectories);
      std::pair<TrajectoryStateOnSurface, const GeomDet*> && initState = theInitialState->innerState( *it , doBackFit);
 
      // temporary protection againt invalid initial states
      if ( !initState.first.isValid() || initState.second == nullptr || edm::isNotFinite(initState.first.globalPosition().x())) {
        //cout << "invalid innerState, will not make TrackCandidate" << endl;
        continue;
      }
      
      PTrajectoryStateOnDet state;
      if(useSplitting && (initState.second != recHits.front().det()) && recHits.front().det() ){  
        LogDebug("CkfPattern") << "propagating to hit front in case of splitting.";
        TrajectoryStateOnSurface && propagated = thePropagator->propagate(initState.first,recHits.front().det()->surface());
        if (!propagated.isValid()) continue;
        state = trajectoryStateTransform::persistentState(propagated,
                                       recHits.front().rawId());
      }
      else state = trajectoryStateTransform::persistentState( initState.first,
                                      initState.second->geographicalId().rawId());
      LogDebug("CkfPattern") << "pushing a TrackCandidate.";
      output->emplace_back(recHits,it->seed(),state,it->seedRef(),it->nLoops());
        }
       }//output trackcandidates
 
       edm::ESHandle<TrackerGeometry> tracker;
       es.get<TrackerDigiGeometryRecord>().get(tracker);            
       LogTrace("CkfPattern|TrackingRegressionTest") << "========== CkfTrackCandidateMaker Info =========="
                             << "number of Seed: " << collseed->size()<<endl
                                 <<PrintoutHelper::regressionTest(*tracker,unsmoothedResult);
 
       assert(viTotHits>=0); // just to use it...
       // std::cout << "VICkfPattern result " << output->size() << " " << viTotHits << std::endl;
      
       if (theTrajectoryOutput){ outputT->swap(unsmoothedResult);}
 
     }// end of ((*collseed).size()>0)
     
     // method for debugging
     deleteAssocDebugger();
 
     // Step G: write output to file
     if (theTrackCandidateOutput){ e.put(output);}
     if (theTrajectoryOutput){e.put(outputT);}
   }

void cms::CkfTrackCandidateMakerBase::setEventSetup ( const edm::EventSetup & es )

private

Initialize EventSetup objects at each event.

Definition at line 124 of file CkfTrackCandidateMakerBase.cc.

References edm::EventSetup::get(), edm::ESHandle< class >::product(), theGeomSearchTracker, theMagField, theMagFieldName, theNavigationSchool, theNavigationSchoolName, theTrajectoryBuilder, theTrajectoryCleaner, and theTrajectoryCleanerName.

Referenced by produceBase().

                                                                           {
 
     //services
     es.get<TrackerRecoGeometryRecord>().get( theGeomSearchTracker );
     es.get<IdealMagneticFieldRecord>().get(theMagFieldName, theMagField );
     //    edm::ESInputTag mfESInputTag(mfName);
     //    es.get<IdealMagneticFieldRecord>().get(mfESInputTag,theMagField );
 
     edm::ESHandle<TrajectoryCleaner> trajectoryCleanerH;
     es.get<TrajectoryCleaner::Record>().get(theTrajectoryCleanerName, trajectoryCleanerH);
     theTrajectoryCleaner= trajectoryCleanerH.product();
 
     edm::ESHandle<NavigationSchool> navigationSchoolH;
     es.get<NavigationSchoolRecord>().get(theNavigationSchoolName, navigationSchoolH);
     theNavigationSchool = navigationSchoolH.product();
     theTrajectoryBuilder->setNavigationSchool(theNavigationSchool);
   }