l1tpf_impl::RegionMapper Class Reference

#include <RegionMapper.h>

Public Member Functions
void	addCalo (const l1t::PFCluster &t)
void	addCalo (const l1t::PFCluster &t, l1t::PFClusterRef ref)
void	addEmCalo (const l1t::PFCluster &t)
void	addEmCalo (const l1t::PFCluster &t, l1t::PFClusterRef ref)
void	addMuon (const l1t::Muon &t)
void	addMuon (const l1t::Muon &t, l1t::PFCandidate::MuonRef ref)
void	addMuon (const l1t::TkMuon &t)
void	addTrack (const l1t::PFTrack &t)
void	addTrack (const l1t::PFTrack &t, l1t::PFTrackRef ref)
void	clear ()
std::unique_ptr< l1t::PFCandidateCollection >	fetch (bool puppi=true, float ptMin=0.01) const
std::unique_ptr< l1t::PFCandidateCollection >	fetchCalo (float ptMin=0.01, bool emcalo=false) const
std::unique_ptr< l1t::PFCandidateCollection >	fetchTracks (float ptMin=0.01, bool fromPV=false) const
	RegionMapper (const edm::ParameterSet &)
std::vector< Region > &	regions ()
std::pair< unsigned, unsigned >	totAndMaxInput (int type) const
std::pair< unsigned, unsigned >	totAndMaxOutput (int type, bool puppi) const
std::unique_ptr< std::vector< unsigned > >	vecInput (int type) const
std::unique_ptr< std::vector< unsigned > >	vecOutput (int type, bool puppi) const

Protected Types
enum	TrackAssoMode { TrackAssoMode::atVertex, TrackAssoMode::atCalo, TrackAssoMode::any = 999 }

Protected Attributes
std::unordered_map< const l1t::PFCluster *, l1t::PFClusterRef >	clusterRefMap_
std::unordered_map< const l1t::Muon *, l1t::PFCandidate::MuonRef >	muonRefMap_
std::vector< Region >	regions_
std::unordered_map< const l1t::PFTrack *, l1t::PFTrackRef >	trackRefMap_
enum l1tpf_impl::RegionMapper::TrackAssoMode	trackRegionMode_
bool	useRelativeRegionalCoordinates_

Detailed Description

Definition at line 15 of file RegionMapper.h.

Member Enumeration Documentation

TrackAssoMode

enum l1tpf_impl::RegionMapper::TrackAssoMode

strongprotected

Enumerator
atVertex
atCalo
any

Definition at line 48 of file RegionMapper.h.

{ atVertex, atCalo, any = 999 } trackRegionMode_;

Constructor & Destructor Documentation

RegionMapper()

RegionMapper::RegionMapper

(

const edm::ParameterSet &

iConfig

)

Definition at line 5 of file RegionMapper.cc.

                                                         : useRelativeRegionalCoordinates_(false) {
  if (iConfig.existsAs<std::vector<edm::ParameterSet>>("regions")) {
    useRelativeRegionalCoordinates_ = iConfig.getParameter<bool>("useRelativeRegionalCoordinates");
    for (const edm::ParameterSet &preg : iConfig.getParameter<std::vector<edm::ParameterSet>>("regions")) {
      std::vector<double> etaBoundaries = preg.getParameter<std::vector<double>>("etaBoundaries");
      unsigned int phiSlices = preg.getParameter<uint32_t>("phiSlices");
      float etaExtra = preg.getParameter<double>("etaExtra");
      float phiExtra = preg.getParameter<double>("phiExtra");
      float phiWidth = 2 * M_PI / phiSlices;
      unsigned int ncalomax = 0, nemcalomax = 0, ntrackmax = 0, nmuonmax = 0, npfmax = 0, npuppimax = 0;
      if (preg.existsAs<uint32_t>("caloNMax"))
        ncalomax = preg.getParameter<uint32_t>("caloNMax");
      if (preg.existsAs<uint32_t>("emcaloNMax"))
        nemcalomax = preg.getParameter<uint32_t>("emcaloNMax");
      if (preg.existsAs<uint32_t>("trackNMax"))
        ntrackmax = preg.getParameter<uint32_t>("trackNMax");
      if (preg.existsAs<uint32_t>("muonNMax"))
        nmuonmax = preg.getParameter<uint32_t>("muonNMax");
      if (preg.existsAs<uint32_t>("pfNMax"))
        npfmax = preg.getParameter<uint32_t>("pfNMax");
      if (preg.existsAs<uint32_t>("puppiNMax"))
        npuppimax = preg.getParameter<uint32_t>("puppiNMax");
      for (unsigned int ieta = 0, neta = etaBoundaries.size() - 1; ieta < neta; ++ieta) {
        for (unsigned int iphi = 0; iphi < phiSlices; ++iphi) {
          float phiCenter = (iphi + 0.5) * phiWidth - M_PI;
          regions_.push_back(Region(etaBoundaries[ieta],
                                    etaBoundaries[ieta + 1],
                                    phiCenter,
                                    phiWidth,
                                    etaExtra,
                                    phiExtra,
                                    useRelativeRegionalCoordinates_,
                                    ncalomax,
                                    nemcalomax,
                                    ntrackmax,
                                    nmuonmax,
                                    npfmax,
                                    npuppimax));
        }
      }
    }
    std::string trackRegionMode = "TrackAssoMode::any";
    if (iConfig.existsAs<std::string>("trackRegionMode"))
      trackRegionMode = iConfig.getParameter<std::string>("trackRegionMode");
    if (trackRegionMode == "atVertex")
      trackRegionMode_ = TrackAssoMode::atVertex;
    else if (trackRegionMode == "atCalo")
      trackRegionMode_ = TrackAssoMode::atCalo;
    else if (trackRegionMode == "any")
      trackRegionMode_ = TrackAssoMode::any;
    else
      throw cms::Exception(
          "Configuration",
          "Unsupported value for trackRegionMode: " + trackRegionMode + " (allowed are 'atVertex', 'atCalo', 'any')");
  } else {
    // start off with a dummy region
    unsigned int ncalomax = 0, nemcalomax = 0, ntrackmax = 0, nmuonmax = 0, npfmax = 0, npuppimax = 0;
    regions_.emplace_back(-5.5,
                          5.5,
                          0,
                          2 * M_PI,
                          0.5,
                          0.5,
                          useRelativeRegionalCoordinates_,
                          ncalomax,
                          nemcalomax,
                          ntrackmax,
                          nmuonmax,
                          npfmax,
                          npuppimax);
  }
}

References any, atCalo, atVertex, l1ParticleFlow_cff::etaBoundaries, l1ParticleFlow_cff::etaExtra, Exception, edm::ParameterSet::existsAs(), edm::ParameterSet::getParameter(), LEDCalibrationChannels::ieta, LEDCalibrationChannels::iphi, M_PI, neta, l1ParticleFlow_cff::phiExtra, l1ParticleFlow_cff::phiSlices, g4SimHits_cfi::Region, regions_, AlCaHLTBitMon_QueryRunRegistry::string, l1ParticleFlow_cff::trackRegionMode, trackRegionMode_, and useRelativeRegionalCoordinates_.

Member Function Documentation

addCalo() [1/2]

void RegionMapper::addCalo

(

const l1t::PFCluster &

t

)

Definition at line 153 of file RegionMapper.cc.

                                                {
  if (p.pt() == 0)
    return;
  for (Region &r : regions_) {
    if (r.contains(p.eta(), p.phi())) {
      CaloCluster calo;
      calo.fill(p.pt(), p.emEt(), p.ptError(), r.localEta(p.eta()), r.localPhi(p.phi()), p.isEM(), 0, &p);
      r.calo.push_back(calo);
    }
  }
}

References L1TowerCalibrationProducer_cfi::calo, AlCaHLTBitMon_ParallelJobs::p, alignCSCRings::r, and regions_.

Referenced by addCalo(), and L1TPFProducer::produce().

addCalo() [2/2]

void RegionMapper::addCalo	(	const l1t::PFCluster &	t,
		l1t::PFClusterRef	ref
	)

Definition at line 164 of file RegionMapper.cc.

                                                                     {
  addCalo(p);
  clusterRefMap_[&p] = ref;
}

References addCalo(), clusterRefMap_, and AlCaHLTBitMon_ParallelJobs::p.

addEmCalo() [1/2]

void RegionMapper::addEmCalo

(

const l1t::PFCluster &

t

)

Definition at line 169 of file RegionMapper.cc.

                                                  {
  if (p.pt() == 0)
    return;
  for (Region &r : regions_) {
    if (r.contains(p.eta(), p.phi())) {
      CaloCluster calo;
      calo.fill(p.pt(), p.emEt(), p.ptError(), r.localEta(p.eta()), r.localPhi(p.phi()), p.isEM(), 0, &p);
      r.emcalo.push_back(calo);
    }
  }
}

References L1TowerCalibrationProducer_cfi::calo, AlCaHLTBitMon_ParallelJobs::p, alignCSCRings::r, and regions_.

Referenced by addEmCalo(), and L1TPFProducer::produce().

addEmCalo() [2/2]

void RegionMapper::addEmCalo	(	const l1t::PFCluster &	t,
		l1t::PFClusterRef	ref
	)

Definition at line 180 of file RegionMapper.cc.

                                                                       {
  addEmCalo(p);
  clusterRefMap_[&p] = ref;
}

References addEmCalo(), clusterRefMap_, and AlCaHLTBitMon_ParallelJobs::p.

addMuon() [1/3]

void RegionMapper::addMuon

(

const l1t::Muon &

t

)

Definition at line 124 of file RegionMapper.cc.

                                            {
  // now let's be optimistic and make things very simple
  // we don't propagate anything
  for (Region &r : regions_) {
    if (r.contains(mu.eta(), mu.phi())) {
      Muon prop;
      prop.fill(mu.pt(), r.localEta(mu.eta()), r.localPhi(mu.phi()), mu.charge(), mu.hwQual(), &mu);
      r.muon.push_back(prop);
    }
  }
}

References amptDefaultParameters_cff::mu, alignCSCRings::r, and regions_.

Referenced by addMuon(), and L1TPFProducer::produce().

addMuon() [2/3]

void RegionMapper::addMuon	(	const l1t::Muon &	t,
		l1t::PFCandidate::MuonRef	ref
	)

Definition at line 148 of file RegionMapper.cc.

                                                                       {
  addMuon(mu);
  muonRefMap_[&mu] = ref;
}

References addMuon(), amptDefaultParameters_cff::mu, and muonRefMap_.

addMuon() [3/3]

void RegionMapper::addMuon

(

const l1t::TkMuon &

t

)

Definition at line 136 of file RegionMapper.cc.

                                              {
  // now let's be optimistic and make things very simple
  // we don't propagate anything
  for (Region &r : regions_) {
    if (r.contains(mu.eta(), mu.phi())) {
      Muon prop;
      prop.fill(mu.pt(), r.localEta(mu.eta()), r.localPhi(mu.phi()), mu.charge(), mu.hwQual());
      r.muon.push_back(prop);
    }
  }
}

References amptDefaultParameters_cff::mu, alignCSCRings::r, and regions_.

addTrack() [1/2]

void RegionMapper::addTrack

(

const l1t::PFTrack &

t

)

Definition at line 86 of file RegionMapper.cc.

                                               {
  // now let's be optimistic and make things very simple
  // we propagate in floating point the track to the calo
  // we add the track to the region corresponding to its vertex (eta,phi) coordinates AND its (eta,phi) calo coordinates
  for (Region &r : regions_) {
    bool inside = true;
    switch (trackRegionMode_) {
      case TrackAssoMode::atVertex:
        inside = r.contains(t.eta(), t.phi());
        break;
      case TrackAssoMode::atCalo:
        inside = r.contains(t.caloEta(), t.caloPhi());
        break;
      case TrackAssoMode::any:
        inside = r.contains(t.eta(), t.phi()) || r.contains(t.caloEta(), t.caloPhi());
        break;
    }
    if (inside) {
      PropagatedTrack prop;
      prop.fillInput(t.pt(), r.localEta(t.eta()), r.localPhi(t.phi()), t.charge(), t.vertex().Z(), t.quality(), &t);
      prop.fillPropagated(t.pt(),
                          t.trkPtError(),
                          t.caloPtError(),
                          r.localEta(t.caloEta()),
                          r.localPhi(t.caloPhi()),
                          t.quality(),
                          t.isMuon());
      prop.hwStubs = t.nStubs();
      prop.hwChi2 = round(t.chi2() * 10);
      r.track.push_back(prop);
    }
  }
}

References any, atCalo, atVertex, l1tpf_impl::InputTrack::hwChi2, l1tpf_impl::InputTrack::hwStubs, alignCSCRings::r, regions_, submitPVValidationJobs::t, and trackRegionMode_.

Referenced by addTrack(), and L1TPFProducer::produce().

addTrack() [2/2]

void RegionMapper::addTrack	(	const l1t::PFTrack &	t,
		l1t::PFTrackRef	ref
	)

Definition at line 119 of file RegionMapper.cc.

                                                                  {
  addTrack(t);
  trackRefMap_[&t] = ref;
}

References addTrack(), submitPVValidationJobs::t, and trackRefMap_.

clear()

void RegionMapper::clear

(

void

)

Definition at line 78 of file RegionMapper.cc.

                         {
  for (Region &r : regions_)
    r.zero();
  clusterRefMap_.clear();
  trackRefMap_.clear();
  muonRefMap_.clear();
}

References clusterRefMap_, muonRefMap_, alignCSCRings::r, regions_, and trackRefMap_.

Referenced by L1TPFProducer::produce().

fetch()

std::unique_ptr< l1t::PFCandidateCollection > RegionMapper::fetch	(	bool	puppi = true,
		float	ptMin = 0.01
	)		const

Definition at line 185 of file RegionMapper.cc.

                                                                                         {
  auto ret = std::make_unique<l1t::PFCandidateCollection>();
  for (const Region &r : regions_) {
    for (const PFParticle &p : (puppi ? r.puppi : r.pf)) {
      bool inside = true;
      switch (trackRegionMode_) {
        case TrackAssoMode::atVertex:
          inside = r.fiducialLocal(p.floatVtxEta(), p.floatVtxPhi());
          break;
        case TrackAssoMode::atCalo:
          inside = r.fiducialLocal(p.floatEta(), p.floatPhi());
          break;
        case TrackAssoMode::any:
          inside = r.fiducialLocal(p.floatVtxEta(), p.floatVtxPhi());
          break;  // WARNING: this may not be the best choice
      }
      if (!inside)
        continue;
      if (p.floatPt() > ptMin) {
        reco::Particle::PolarLorentzVector p4(
            p.floatPt(), r.globalEta(p.floatVtxEta()), r.globalPhi(p.floatVtxPhi()), 0.13f);
        ret->emplace_back(l1t::PFCandidate::ParticleType(p.hwId), p.intCharge(), p4, p.floatPuppiW());
        ret->back().setVertex(reco::Particle::Point(0, 0, p.floatDZ()));
        ret->back().setStatus(p.hwStatus);
        if (p.cluster.src) {
          auto match = clusterRefMap_.find(p.cluster.src);
          if (match == clusterRefMap_.end()) {
            throw cms::Exception("CorruptData") << "Invalid cluster pointer in PF candidate id " << p.hwId << " pt "
                                                << p4.pt() << " eta " << p4.eta() << " phi " << p4.phi();
          }
          ret->back().setPFCluster(match->second);
        }
        if (p.track.src) {
          auto match = trackRefMap_.find(p.track.src);
          if (match == trackRefMap_.end()) {
            throw cms::Exception("CorruptData") << "Invalid track pointer in PF candidate id " << p.hwId << " pt "
                                                << p4.pt() << " eta " << p4.eta() << " phi " << p4.phi();
          }
          ret->back().setPFTrack(match->second);
        }
        if (p.muonsrc) {
          auto match = muonRefMap_.find(p.muonsrc);
          if (match == muonRefMap_.end()) {
            throw cms::Exception("CorruptData") << "Invalid muon pointer in PF candidate id " << p.hwId << " pt "
                                                << p4.pt() << " eta " << p4.eta() << " phi " << p4.phi();
          }
          ret->back().setMuon(match->second);
        }
      }
    }
  }
  return ret;
}

References any, atCalo, atVertex, clusterRefMap_, Exception, f, match(), muonRefMap_, AlCaHLTBitMon_ParallelJobs::p, p4, ptMin, alignCSCRings::r, regions_, runTheMatrix::ret, trackRefMap_, and trackRegionMode_.

Referenced by L1TPFProducer::produce().

fetchCalo()

std::unique_ptr< l1t::PFCandidateCollection > RegionMapper::fetchCalo	(	float	ptMin = 0.01,
		bool	emcalo = false
	)		const

Definition at line 239 of file RegionMapper.cc.

                                                                                              {
  auto ret = std::make_unique<l1t::PFCandidateCollection>();
  for (const Region &r : regions_) {
    for (const CaloCluster &p : (emcalo ? r.emcalo : r.calo)) {
      if (!r.fiducialLocal(p.floatEta(), p.floatPhi()))
        continue;
      if (p.floatPt() > ptMin) {
        reco::Particle::PolarLorentzVector p4(p.floatPt(), r.globalEta(p.floatEta()), r.globalPhi(p.floatPhi()), 0.13f);
        l1t::PFCandidate::ParticleType kind =
            (p.isEM || emcalo) ? l1t::PFCandidate::Photon : l1t::PFCandidate::NeutralHadron;
        ret->emplace_back(kind, 0, p4);
        if (p.src) {
          auto match = clusterRefMap_.find(p.src);
          if (match == clusterRefMap_.end()) {
            throw cms::Exception("CorruptData")
                << "Invalid cluster pointer in cluster pt " << p4.pt() << " eta " << p4.eta() << " phi " << p4.phi();
          }
          ret->back().setPFCluster(match->second);
        }
      }
    }
  }
  return ret;
}

References clusterRefMap_, Exception, f, CalibrationSummaryClient_cfi::kind, match(), l1t::PFCandidate::NeutralHadron, AlCaHLTBitMon_ParallelJobs::p, p4, l1t::PFCandidate::Photon, ptMin, alignCSCRings::r, regions_, and runTheMatrix::ret.

Referenced by L1TPFProducer::produce().

fetchTracks()

std::unique_ptr< l1t::PFCandidateCollection > RegionMapper::fetchTracks	(	float	ptMin = 0.01,
		bool	fromPV = false
	)		const

Definition at line 264 of file RegionMapper.cc.

                                                                                                {
  auto ret = std::make_unique<l1t::PFCandidateCollection>();
  for (const Region &r : regions_) {
    for (const PropagatedTrack &p : r.track) {
      if (fromPV && !p.fromPV)
        continue;
      bool inside = true;
      switch (trackRegionMode_) {
        case TrackAssoMode::atVertex:
          inside = r.fiducialLocal(p.floatVtxEta(), p.floatVtxPhi());
          break;
        case TrackAssoMode::atCalo:
          inside = r.fiducialLocal(p.floatEta(), p.floatPhi());
          break;
        case TrackAssoMode::any:
          inside = r.fiducialLocal(p.floatVtxEta(), p.floatVtxPhi());
          break;  // WARNING: this may not be the best choice
      }
      if (!inside)
        continue;
      if (p.floatPt() > ptMin) {
        reco::Particle::PolarLorentzVector p4(
            p.floatVtxPt(), r.globalEta(p.floatVtxEta()), r.globalPhi(p.floatVtxPhi()), 0.13f);
        l1t::PFCandidate::ParticleType kind = p.muonLink ? l1t::PFCandidate::Muon : l1t::PFCandidate::ChargedHadron;
        ret->emplace_back(kind, p.intCharge(), p4);
        ret->back().setVertex(reco::Particle::Point(0, 0, p.floatDZ()));
        if (p.src) {
          auto match = trackRefMap_.find(p.src);
          if (match == trackRefMap_.end()) {
            throw cms::Exception("CorruptData")
                << "Invalid track pointer in PF track  pt " << p4.pt() << " eta " << p4.eta() << " phi " << p4.phi();
          }
          ret->back().setPFTrack(match->second);
        }
      }
    }
  }
  return ret;
}

References any, atCalo, atVertex, l1t::PFCandidate::ChargedHadron, Exception, f, isotracks_cff::fromPV, CalibrationSummaryClient_cfi::kind, match(), l1t::PFCandidate::Muon, AlCaHLTBitMon_ParallelJobs::p, p4, ptMin, alignCSCRings::r, regions_, runTheMatrix::ret, trackRefMap_, and trackRegionMode_.

Referenced by L1TPFProducer::produce().

regions()

std::vector<Region>& l1tpf_impl::RegionMapper::regions ( )

inline

Definition at line 34 of file RegionMapper.h.

{ return regions_; }

References regions_.

Referenced by L1TPFProducer::produce().

totAndMaxInput()

std::pair< unsigned, unsigned > RegionMapper::totAndMaxInput

(

int

type

)

const

Definition at line 304 of file RegionMapper.cc.

                                                                       {
  unsigned ntot = 0, nmax = 0;
  for (const auto &r : regions_) {
    unsigned int ni = r.nInput(Region::InputType(type));
    ntot += ni;
    nmax = std::max(nmax, ni);
  }
  return std::make_pair(ntot, nmax);
}

References SiStripPI::max, gpuPixelDoublets::ntot, alignCSCRings::r, and regions_.

Referenced by L1TPFProducer::produce().

totAndMaxOutput()

std::pair< unsigned, unsigned > RegionMapper::totAndMaxOutput	(	int	type,
		bool	puppi
	)		const

Definition at line 323 of file RegionMapper.cc.

                                                                                    {
  unsigned ntot = 0, nmax = 0;
  for (const auto &r : regions_) {
    unsigned int ni = r.nOutput(Region::OutputType(type), puppi);
    ntot += ni;
    nmax = std::max(nmax, ni);
  }
  return std::make_pair(ntot, nmax);
}

References SiStripPI::max, gpuPixelDoublets::ntot, alignCSCRings::r, and regions_.

Referenced by L1TPFProducer::produce().

vecInput()

std::unique_ptr< std::vector< unsigned > > RegionMapper::vecInput

(

int

type

)

const

Definition at line 314 of file RegionMapper.cc.

                                                                        {
  auto v = std::make_unique<std::vector<unsigned>>();
  for (const auto &r : regions_) {
    unsigned ni = r.nInput(Region::InputType(type));
    v->push_back(ni);
  }
  return v;
}

References alignCSCRings::r, regions_, and findQualityFiles::v.

Referenced by L1TPFProducer::produce().

vecOutput()

std::unique_ptr< std::vector< unsigned > > RegionMapper::vecOutput	(	int	type,
		bool	puppi
	)		const

Definition at line 333 of file RegionMapper.cc.

                                                                                     {
  auto v = std::make_unique<std::vector<unsigned>>();
  for (const auto &r : regions_) {
    unsigned ni = r.nOutput(Region::OutputType(type), puppi);
    v->push_back(ni);
  }
  return v;
}

References alignCSCRings::r, regions_, and findQualityFiles::v.

Referenced by L1TPFProducer::produce().

Member Data Documentation

clusterRefMap_

std::unordered_map<const l1t::PFCluster *, l1t::PFClusterRef> l1tpf_impl::RegionMapper::clusterRefMap_

protected

Definition at line 51 of file RegionMapper.h.

Referenced by addCalo(), addEmCalo(), clear(), fetch(), and fetchCalo().

muonRefMap_

std::unordered_map<const l1t::Muon *, l1t::PFCandidate::MuonRef> l1tpf_impl::RegionMapper::muonRefMap_

protected

Definition at line 53 of file RegionMapper.h.

Referenced by addMuon(), clear(), and fetch().

regions_

std::vector<Region> l1tpf_impl::RegionMapper::regions_

protected

Definition at line 46 of file RegionMapper.h.

Referenced by addCalo(), addEmCalo(), addMuon(), addTrack(), clear(), fetch(), fetchCalo(), fetchTracks(), RegionMapper(), regions(), totAndMaxInput(), totAndMaxOutput(), vecInput(), and vecOutput().

trackRefMap_

std::unordered_map<const l1t::PFTrack *, l1t::PFTrackRef> l1tpf_impl::RegionMapper::trackRefMap_

protected

Definition at line 52 of file RegionMapper.h.

Referenced by addTrack(), clear(), fetch(), and fetchTracks().

trackRegionMode_

enum l1tpf_impl::RegionMapper::TrackAssoMode l1tpf_impl::RegionMapper::trackRegionMode_

protected

Referenced by addTrack(), fetch(), fetchTracks(), and RegionMapper().

useRelativeRegionalCoordinates_

bool l1tpf_impl::RegionMapper::useRelativeRegionalCoordinates_

protected

Definition at line 47 of file RegionMapper.h.

Referenced by RegionMapper().