CandidateSeededTrackingRegionsProducer Class Reference

#include <CandidateSeededTrackingRegionsProducer.h>

Inheritance diagram for CandidateSeededTrackingRegionsProducer:

Public Types
enum	Mode { BEAM_SPOT_FIXED, BEAM_SPOT_SIGMA, VERTICES_FIXED, VERTICES_SIGMA }

Public Member Functions
	CandidateSeededTrackingRegionsProducer (const edm::ParameterSet &conf, edm::ConsumesCollector &&iC)
virtual std::vector < TrackingRegion * >	regions (const edm::Event &e, const edm::EventSetup &es) const
virtual	~CandidateSeededTrackingRegionsProducer ()
Public Member Functions inherited from TrackingRegionProducer
virtual	~TrackingRegionProducer ()

Private Attributes
float	m_deltaEta
float	m_deltaPhi
int	m_maxNRegions
int	m_maxNVertices
Mode	m_mode
float	m_nSigmaZBeamSpot
float	m_nSigmaZVertex
float	m_originRadius
bool	m_precise
float	m_ptMin
bool	m_searchOpt
RectangularEtaPhiTrackingRegion::UseMeasurementTracker	m_whereToUseMeasurementTracker
float	m_zErrorBeamSpot
float	m_zErrorVetex
edm::EDGetTokenT< reco::BeamSpot >	token_beamSpot
edm::EDGetTokenT < reco::CandidateView >	token_input
edm::EDGetTokenT < MeasurementTrackerEvent >	token_measurementTracker
edm::EDGetTokenT < reco::VertexCollection >	token_vertex

Detailed Description

class CandidateSeededTrackingRegionsProducer

eta-phi TrackingRegions producer in directions defined by Candidate-based objects of interest from a collection defined by the "input" parameter.

Four operational modes are supported ("mode" parameter):

BeamSpotFixed: origin is defined by the beam spot z-half-length is defined by a fixed zErrorBeamSpot parameter BeamSpotSigma: origin is defined by the beam spot z-half-length is defined by nSigmaZBeamSpot * beamSpot.sigmaZ VerticesFixed: origins are defined by vertices from VertexCollection (use maximum MaxNVertices of them) z-half-length is defined by a fixed zErrorVetex parameter VerticesSigma: origins are defined by vertices from VertexCollection (use maximum MaxNVertices of them) z-half-length is defined by nSigmaZVertex * vetex.zError

If, while using one of the "Vertices" modes, there's no vertices in an event, we fall back into either BeamSpotSigma or BeamSpotFixed mode, depending on the positiveness of nSigmaZBeamSpot.

Author

Vadim Khotilovich

Definition at line 44 of file CandidateSeededTrackingRegionsProducer.h.

Member Enumeration Documentation

enum CandidateSeededTrackingRegionsProducer::Mode

Enumerator
BEAM_SPOT_FIXED
BEAM_SPOT_SIGMA
VERTICES_FIXED
VERTICES_SIGMA

Definition at line 48 of file CandidateSeededTrackingRegionsProducer.h.

{BEAM_SPOT_FIXED, BEAM_SPOT_SIGMA, VERTICES_FIXED, VERTICES_SIGMA } Mode;

Constructor & Destructor Documentation

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

inlineexplicit

Definition at line 50 of file CandidateSeededTrackingRegionsProducer.h.

References BEAM_SPOT_FIXED, BEAM_SPOT_SIGMA, edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), m_deltaEta, m_deltaPhi, m_maxNRegions, m_maxNVertices, m_mode, m_nSigmaZBeamSpot, m_nSigmaZVertex, m_originRadius, m_precise, m_ptMin, m_searchOpt, m_whereToUseMeasurementTracker, m_zErrorBeamSpot, m_zErrorVetex, AlCaHLTBitMon_QueryRunRegistry::string, token_beamSpot, token_input, token_measurementTracker, token_vertex, VERTICES_FIXED, and VERTICES_SIGMA.

  {
    edm::ParameterSet regPSet = conf.getParameter<edm::ParameterSet>("RegionPSet");

    // operation mode
    std::string modeString       = regPSet.getParameter<std::string>("mode");
    if      (modeString == "BeamSpotFixed") m_mode = BEAM_SPOT_FIXED;
    else if (modeString == "BeamSpotSigma") m_mode = BEAM_SPOT_SIGMA;
    else if (modeString == "VerticesFixed") m_mode = VERTICES_FIXED;
    else if (modeString == "VerticesSigma") m_mode = VERTICES_SIGMA;
    else  edm::LogError ("CandidateSeededTrackingRegionsProducer")<<"Unknown mode string: "<<modeString;

    // basic inputs
    token_input        = iC.consumes<reco::CandidateView>(regPSet.getParameter<edm::InputTag>("input"));
    m_maxNRegions      = regPSet.getParameter<int>("maxNRegions");
    token_beamSpot     = iC.consumes<reco::BeamSpot>(regPSet.getParameter<edm::InputTag>("beamSpot"));
    m_maxNVertices     = 1;
    if (m_mode == VERTICES_FIXED || m_mode == VERTICES_SIGMA)
    {
      token_vertex       = iC.consumes<reco::VertexCollection>(regPSet.getParameter<edm::InputTag>("vertexCollection"));
      m_maxNVertices     = regPSet.getParameter<int>("maxNVertices");
    }

    // RectangularEtaPhiTrackingRegion parameters:
    m_ptMin            = regPSet.getParameter<double>("ptMin");
    m_originRadius     = regPSet.getParameter<double>("originRadius");
    m_zErrorBeamSpot   = regPSet.getParameter<double>("zErrorBeamSpot");
    m_deltaEta         = regPSet.getParameter<double>("deltaEta");
    m_deltaPhi         = regPSet.getParameter<double>("deltaPhi");
    m_precise          = regPSet.getParameter<bool>("precise");
    m_whereToUseMeasurementTracker = RectangularEtaPhiTrackingRegion::UseMeasurementTracker::kForSiStrips;
    if (regPSet.exists("measurementTrackerName"))
    {
      // FIXME: when next time altering the configuration of this
      // class, please change the types of the following parameters:
      // - whereToUseMeasurementTracker to at least int32 or to a string
      //   corresponding to the UseMeasurementTracker enumeration
      // - measurementTrackerName to InputTag
      if (regPSet.exists("whereToUseMeasurementTracker"))
        m_whereToUseMeasurementTracker = RectangularEtaPhiTrackingRegion::doubleToUseMeasurementTracker(regPSet.getParameter<double>("whereToUseMeasurementTracker"));
      if(m_whereToUseMeasurementTracker != RectangularEtaPhiTrackingRegion::UseMeasurementTracker::kNever)
        token_measurementTracker = iC.consumes<MeasurementTrackerEvent>(regPSet.getParameter<std::string>("measurementTrackerName"));
    }
    m_searchOpt = false;
    if (regPSet.exists("searchOpt")) m_searchOpt = regPSet.getParameter<bool>("searchOpt");

    // mode-dependent z-halflength of tracking regions
    if (m_mode == VERTICES_SIGMA)  m_nSigmaZVertex   = regPSet.getParameter<double>("nSigmaZVertex");
    if (m_mode == VERTICES_FIXED)  m_zErrorVetex     = regPSet.getParameter<double>("zErrorVetex");
    m_nSigmaZBeamSpot = -1.;
    if (m_mode == BEAM_SPOT_SIGMA)
    {
      m_nSigmaZBeamSpot = regPSet.getParameter<double>("nSigmaZBeamSpot");
      if (m_nSigmaZBeamSpot < 0.)
        edm::LogError ("CandidateSeededTrackingRegionsProducer")<<"nSigmaZBeamSpot must be positive for BeamSpotSigma mode!";
    }
  }

virtual CandidateSeededTrackingRegionsProducer::~CandidateSeededTrackingRegionsProducer ( )

inlinevirtual

Definition at line 109 of file CandidateSeededTrackingRegionsProducer.h.

{}

Member Function Documentation

virtual std::vector<TrackingRegion* > CandidateSeededTrackingRegionsProducer::regions ( const edm::Event &  e, const edm::EventSetup &  es  ) const

inlinevirtual

Implements TrackingRegionProducer.

Definition at line 112 of file CandidateSeededTrackingRegionsProducer.h.

References BEAM_SPOT_FIXED, BEAM_SPOT_SIGMA, first, edm::Event::getByToken(), i, edm::EDGetTokenT< T >::isUninitialized(), edm::HandleBase::isValid(), j, m_deltaEta, m_deltaPhi, m_maxNRegions, m_maxNVertices, m_mode, m_nSigmaZBeamSpot, m_nSigmaZVertex, m_originRadius, m_precise, m_ptMin, m_searchOpt, m_whereToUseMeasurementTracker, m_zErrorBeamSpot, m_zErrorVetex, edm::Handle< T >::product(), query::result, edm::second(), token_beamSpot, token_input, token_measurementTracker, token_vertex, findQualityFiles::v, VERTICES_FIXED, VERTICES_SIGMA, x, detailsBasic3DVector::y, and detailsBasic3DVector::z.

  {
    std::vector<TrackingRegion* > result;

    // pick up the candidate objects of interest
    edm::Handle< reco::CandidateView > objects;
    e.getByToken( token_input, objects );
    size_t n_objects = objects->size();
    if (n_objects == 0) return result;

    // always need the beam spot (as a fall back strategy for vertex modes)
    edm::Handle< reco::BeamSpot > bs;
    e.getByToken( token_beamSpot, bs );
    if( !bs.isValid() ) return result;

    // this is a default origin for all modes
    GlobalPoint default_origin( bs->x0(), bs->y0(), bs->z0() );

    // vector of origin & halfLength pairs:
    std::vector< std::pair< GlobalPoint, float > > origins;

    // fill the origins and halfLengths depending on the mode
    if (m_mode == BEAM_SPOT_FIXED || m_mode == BEAM_SPOT_SIGMA)
    {
      origins.push_back( std::make_pair(
          default_origin,
          (m_mode == BEAM_SPOT_FIXED) ? m_zErrorBeamSpot : m_nSigmaZBeamSpot*bs->sigmaZ()
      ));
    }
    else if (m_mode == VERTICES_FIXED || m_mode == VERTICES_SIGMA)
    {
      edm::Handle< reco::VertexCollection > vertices;
      e.getByToken( token_vertex, vertices );
      int n_vert = 0;
      for (reco::VertexCollection::const_iterator v = vertices->begin(); v != vertices->end() && n_vert < m_maxNVertices; ++v)
      {
        if ( v->isFake() || !v->isValid() ) continue;

        origins.push_back( std::make_pair(
            GlobalPoint( v->x(), v->y(), v->z() ),
            (m_mode == VERTICES_FIXED) ? m_zErrorVetex : m_nSigmaZVertex*v->zError()
        ));
        ++n_vert;
      }
      // no-vertex fall-back case:
      if (origins.empty())
      {
        origins.push_back( std::make_pair(
            default_origin,
            (m_nSigmaZBeamSpot > 0.) ? m_nSigmaZBeamSpot*bs->z0Error() : m_zErrorBeamSpot
        ));
      }
    }
    
    const MeasurementTrackerEvent *measurementTracker = nullptr;
    if(!token_measurementTracker.isUninitialized()) {
      edm::Handle<MeasurementTrackerEvent> hmte;
      e.getByToken(token_measurementTracker, hmte);
      measurementTracker = hmte.product();
    }

    // create tracking regions (maximum MaxNRegions of them) in directions of the
    // objects of interest (we expect that the collection was sorted in decreasing pt order)
    int n_regions = 0;
    for(size_t i = 0; i < n_objects && n_regions < m_maxNRegions; ++i )
    {
      const reco::Candidate & object = (*objects)[i];
      GlobalVector direction( object.momentum().x(), object.momentum().y(), object.momentum().z() );

      for (size_t  j=0; j<origins.size() && n_regions < m_maxNRegions; ++j)
      {
        result.push_back( new RectangularEtaPhiTrackingRegion(
          direction,
          origins[j].first,
          m_ptMin,
          m_originRadius,
          origins[j].second,
          m_deltaEta,
          m_deltaPhi,
          m_whereToUseMeasurementTracker,
          m_precise,
          measurementTracker,
          m_searchOpt
        ));
        ++n_regions;
      }
    }
    //std::cout<<"n_seeded_regions = "<<n_regions<<std::endl;
    edm::LogInfo ("CandidateSeededTrackingRegionsProducer") << "produced "<<n_regions<<" regions";

    return result;
  }

Member Data Documentation

float CandidateSeededTrackingRegionsProducer::m_deltaEta

private

Definition at line 218 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_deltaPhi

private

Definition at line 219 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

int CandidateSeededTrackingRegionsProducer::m_maxNRegions

private

Definition at line 209 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

int CandidateSeededTrackingRegionsProducer::m_maxNVertices

private

Definition at line 213 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

Mode CandidateSeededTrackingRegionsProducer::m_mode

private

Definition at line 207 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_nSigmaZBeamSpot

private

Definition at line 227 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_nSigmaZVertex

private

Definition at line 225 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_originRadius

private

Definition at line 216 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

bool CandidateSeededTrackingRegionsProducer::m_precise

private

Definition at line 220 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_ptMin

private

Definition at line 215 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

bool CandidateSeededTrackingRegionsProducer::m_searchOpt

private

Definition at line 223 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

RectangularEtaPhiTrackingRegion::UseMeasurementTracker CandidateSeededTrackingRegionsProducer::m_whereToUseMeasurementTracker

private

Definition at line 222 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_zErrorBeamSpot

private

Definition at line 217 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

float CandidateSeededTrackingRegionsProducer::m_zErrorVetex

private

Definition at line 226 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

edm::EDGetTokenT<reco::BeamSpot> CandidateSeededTrackingRegionsProducer::token_beamSpot

private

Definition at line 211 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

edm::EDGetTokenT<reco::CandidateView> CandidateSeededTrackingRegionsProducer::token_input

private

Definition at line 212 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

edm::EDGetTokenT<MeasurementTrackerEvent> CandidateSeededTrackingRegionsProducer::token_measurementTracker

private

Definition at line 221 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().

edm::EDGetTokenT<reco::VertexCollection> CandidateSeededTrackingRegionsProducer::token_vertex

private

Definition at line 210 of file CandidateSeededTrackingRegionsProducer.h.

Referenced by CandidateSeededTrackingRegionsProducer(), and regions().