DetIdAssociator.h

Go to the documentation of this file.

#ifndef TrackingTools_TrackAssociator_DetIdAssociator_h
#define TrackingTools_TrackAssociator_DetIdAssociator_h 1

// -*- C++ -*-
//
// Package:    TrackingTools/TrackAssociator
// Class:      DetIdAssociator
// 
//
// Original Author:  Dmytro Kovalskyi
//         Created:  Fri Apr 21 10:59:41 PDT 2006
//
//

#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/GeometryVector/interface/GlobalPoint.h"
#include "DataFormats/GeometrySurface/interface/Cylinder.h"
#include "DataFormats/GeometrySurface/interface/Plane.h"
#include "TrackingTools/GeomPropagators/interface/Propagator.h"
#include "TrackingTools/TrajectoryState/interface/TrajectoryStateOnSurface.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "TrackPropagation/SteppingHelixPropagator/interface/SteppingHelixStateInfo.h"
#include "TrackingTools/TrackAssociator/interface/FiducialVolume.h"
#include "Geometry/CommonDetUnit/interface/GeomDet.h"
#include "TrackingTools/Records/interface/DetIdAssociatorRecord.h"
#include <set>
#include <vector>

class DetIdAssociator{
 public:
   enum PropagationTarget { Barrel, ForwardEndcap, BackwardEndcap };
   struct MapRange {
      float dThetaPlus;
      float dThetaMinus;
      float dPhiPlus;
      float dPhiMinus;
   };
   typedef std::vector<GlobalPoint>::const_iterator const_iterator;
    
   DetIdAssociator(const int nPhi, const int nEta, const double etaBinSize);
   virtual ~DetIdAssociator(){}
   
   virtual std::set<DetId> getDetIdsCloseToAPoint(const GlobalPoint&,
                          const int iN = 0) const;
   virtual std::set<DetId> getDetIdsCloseToAPoint(const GlobalPoint& direction,
                          const unsigned int iNEtaPlus,
                          const unsigned int iNEtaMinus,
                          const unsigned int iNPhiPlus,
                          const unsigned int iNPhiMinus) const;
   virtual std::set<DetId> getDetIdsCloseToAPoint(const GlobalPoint& direction,
                          const MapRange& mapRange) const;
   virtual std::set<DetId> getDetIdsCloseToAPoint(const GlobalPoint& point,
                          const double d = 0) const;
   virtual std::set<DetId> getDetIdsCloseToAPoint(const GlobalPoint& point,
                          const double dThetaPlus,
                          const double dThetaMinus,
                          const double dPhiPlus,
                          const double dPhiMinus) const;
   virtual std::set<DetId> getDetIdsInACone(const std::set<DetId>&,
                        const std::vector<GlobalPoint>& trajectory,
                        const double dR) const;
   virtual std::vector<DetId> getCrossedDetIds(const std::set<DetId>&,
                           const std::vector<GlobalPoint>& trajectory) const;
   virtual std::vector<DetId> getCrossedDetIds(const std::set<DetId>&,
                           const std::vector<SteppingHelixStateInfo>& trajectory,
                           const double toleranceInSigmas = -1) const;
   virtual int iEta (const GlobalPoint&) const;
   virtual int iPhi (const GlobalPoint&) const;
   int nPhiBins() const { return nPhi_;}
   int nEtaBins() const { return nEta_;}
   double etaBinSize() const { return etaBinSize_;};
   virtual void buildMap();
   const FiducialVolume& volume() const;

   virtual void setGeometry(const DetIdAssociatorRecord&) = 0;
   virtual const GeomDet* getGeomDet(const DetId&) const = 0;

   virtual void setConditions(const DetIdAssociatorRecord&) {};

   virtual const char* name() const = 0;
   
 protected:
   virtual void check_setup() const;
   
   virtual void dumpMapContent( int, int ) const;
   virtual void dumpMapContent( int, int, int, int ) const;
   
   virtual GlobalPoint getPosition(const DetId&) const = 0;
   virtual const unsigned int getNumberOfSubdetectors() const { return 1;}
   virtual void getValidDetIds(unsigned int subDetectorIndex, std::vector<DetId>&) const = 0;
   virtual std::pair<const_iterator, const_iterator> getDetIdPoints(const DetId&, std::vector<GlobalPoint>&) const = 0;
   
   virtual bool insideElement(const GlobalPoint&, const DetId&) const = 0;
   virtual bool crossedElement(const GlobalPoint&, 
                   const GlobalPoint&, 
                   const DetId&,
                   const double toleranceInSigmas = -1,
                   const SteppingHelixStateInfo* = 0 ) const { return false; }
   virtual bool nearElement(const GlobalPoint& point, 
                const DetId& id, 
                const double distance) const;
   
   unsigned int index(unsigned int iEta, unsigned int iPhi) const {
     return iEta*nPhi_+iPhi;
   }
   void fillSet( std::set<DetId>& set, unsigned int iEta, unsigned int iPhi) const;

   // map parameters
   const int nPhi_;
   const int nEta_;
   // The first number in the pair points to the begging
   // of the DetId list for a given bin
   // The second number is the number of elements in a bin
   std::vector<std::pair<unsigned int,unsigned int> > lookupMap_;
   std::vector<DetId> container_;
   bool theMapIsValid_;
   const double etaBinSize_;
   double maxEta_;
   double minTheta_;
   
   // Detector fiducial volume 
   // approximated as a closed cylinder with non-zero width.
   // Parameters are extracted from the active detector elements.
   FiducialVolume volume_;
};
#endif