HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType > Class Template Reference

Inheritance diagram for HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >:

Public Member Functions
	HLTCaloObjInRegionsProducer (const edm::ParameterSet &ps)
void	produce (edm::Event &, const edm::EventSetup &) override
	~HLTCaloObjInRegionsProducer () override
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Private Member Functions
EtaPhiRegionDataBase *	createEtaPhiRegionData (const std::string &, const edm::ParameterSet &, edm::ConsumesCollector &&)

Static Private Member Functions
static std::unique_ptr< CaloObjCollType >	makeFilteredColl (const edm::Handle< CaloObjCollType > &inputColl, CaloGeometry const &caloGeomHandle, const std::vector< EtaPhiRegion > &regions)
static bool	validIDForGeom (const DetId &id)

Private Attributes
const edm::ESGetToken< CaloGeometry, CaloGeometryRecord >	caloGeometryToken_
std::vector< std::unique_ptr< EtaPhiRegionDataBase > >	etaPhiRegionData_
std::vector< edm::InputTag >	inputCollTags_
std::vector< edm::EDGetTokenT< CaloObjCollType > >	inputTokens_
std::vector< std::string >	outputProductNames_

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T... >
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Detailed Description

template<typename CaloObjType, typename CaloObjCollType = edm::SortedCollection<CaloObjType>>
class HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >

Definition at line 96 of file HLTCaloObjInRegionsProducer.cc.

Constructor & Destructor Documentation

HLTCaloObjInRegionsProducer()

template<typename CaloObjType , typename CaloObjCollType >

HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::HLTCaloObjInRegionsProducer

(

const edm::ParameterSet &

ps

)

Definition at line 120 of file HLTCaloObjInRegionsProducer.cc.

References deDxTools::esConsumes().

    : caloGeometryToken_{esConsumes()} {
  const std::vector<edm::ParameterSet> etaPhiRegions =
      para.getParameter<std::vector<edm::ParameterSet>>("etaPhiRegions");
  for (auto& pset : etaPhiRegions) {
    const std::string type = pset.getParameter<std::string>("type");
    etaPhiRegionData_.emplace_back(createEtaPhiRegionData(
        type,
        pset,
        consumesCollector()));  //meh I was going to use a factory but it was going to be overly complex for my needs
  }

  outputProductNames_ = para.getParameter<std::vector<std::string>>("outputProductNames");
  inputCollTags_ = para.getParameter<std::vector<edm::InputTag>>("inputCollTags");
  if (outputProductNames_.size() != inputCollTags_.size()) {
    throw cms::Exception("InvalidConfiguration")
        << " error outputProductNames and inputCollTags must be the same size, they are " << outputProductNames_.size()
        << " vs " << inputCollTags_.size();
  }
  for (unsigned int collNr = 0; collNr < inputCollTags_.size(); collNr++) {
    inputTokens_.push_back(consumes<CaloObjCollType>(inputCollTags_[collNr]));
    produces<CaloObjCollType>(outputProductNames_[collNr]);
  }
}

~HLTCaloObjInRegionsProducer()

template<typename CaloObjType , typename CaloObjCollType = edm::SortedCollection<CaloObjType>>

HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::~HLTCaloObjInRegionsProducer ( )

inlineoverride

Definition at line 99 of file HLTCaloObjInRegionsProducer.cc.

{}

Member Function Documentation

createEtaPhiRegionData()

template<typename CaloObjType , typename CaloObjCollType >

EtaPhiRegionDataBase * HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::createEtaPhiRegionData ( const std::string &  type, const edm::ParameterSet &  para, edm::ConsumesCollector &&  consumesColl  )

private

Definition at line 264 of file HLTCaloObjInRegionsProducer.cc.

References Exception.

                                                                                             {
  if (type == "L1EGamma") {
    return new EtaPhiRegionData<l1t::EGammaBxCollection>(para, consumesColl);
  } else if (type == "L1Jet") {
    return new EtaPhiRegionData<l1t::JetBxCollection>(para, consumesColl);
  } else if (type == "L1Muon") {
    return new EtaPhiRegionData<l1t::MuonBxCollection>(para, consumesColl);
  } else if (type == "L1Tau") {
    return new EtaPhiRegionData<l1t::TauBxCollection>(para, consumesColl);
  } else if (type == "RecoEcalCandidate") {
    return new EtaPhiRegionData<reco::RecoEcalCandidateCollection>(para, consumesColl);
  } else if (type == "RecoChargedCandidate") {
    return new EtaPhiRegionData<reco::RecoChargedCandidateCollection>(para, consumesColl);
  } else if (type == "Electron") {
    return new EtaPhiRegionData<reco::Electron>(para, consumesColl);
  } else {
    //this is a major issue and could lead to rather subtle efficiency losses, so if its incorrectly configured, we're aborting the job!
    throw cms::Exception("InvalidConfig")
        << " type " << type
        << " is not recognised, this means the rec-hit you think you are keeping may not be and you should fix this "
           "error as it can lead to hard to find efficiency loses"
        << std::endl;
  }
}

fillDescriptions()

template<typename CaloObjType , typename CaloObjCollType >

void HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 146 of file HLTCaloObjInRegionsProducer.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), edm::ParameterSet::addParameter(), defaultModuleLabel(), submitPVResolutionJobs::desc, hgcalDigisL1Seeded_cfi::etaPhiRegions, ProducerED_cfi::InputTag, hgcalDigisL1Seeded_cfi::outputProductNames, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                {
  edm::ParameterSetDescription desc;
  std::vector<std::string> outputProductNames;
  outputProductNames.push_back("EcalRegionalRecHitsEB");
  desc.add<std::vector<std::string>>("outputProductNames", outputProductNames);
  std::vector<edm::InputTag> inputColls;
  inputColls.push_back(edm::InputTag("hltHcalDigis"));
  desc.add<std::vector<edm::InputTag>>("inputCollTags", inputColls);
  std::vector<edm::ParameterSet> etaPhiRegions;

  edm::ParameterSet ecalCandPSet;
  ecalCandPSet.addParameter<std::string>("type", "RecoEcalCandidate");
  ecalCandPSet.addParameter<double>("minEt", -1);
  ecalCandPSet.addParameter<double>("maxEt", -1);
  ecalCandPSet.addParameter<double>("maxDeltaR", 0.5);
  ecalCandPSet.addParameter<double>("maxDEta", 0.);
  ecalCandPSet.addParameter<double>("maxDPhi", 0.);
  ecalCandPSet.addParameter<edm::InputTag>("inputColl", edm::InputTag("hltEgammaCandidates"));
  etaPhiRegions.push_back(ecalCandPSet);

  edm::ParameterSetDescription etaPhiRegionDesc;
  etaPhiRegionDesc.add<std::string>("type");
  etaPhiRegionDesc.add<double>("minEt");
  etaPhiRegionDesc.add<double>("maxEt");
  etaPhiRegionDesc.add<double>("maxDeltaR");
  etaPhiRegionDesc.add<double>("maxDEta");
  etaPhiRegionDesc.add<double>("maxDPhi");
  etaPhiRegionDesc.add<edm::InputTag>("inputColl");
  desc.addVPSet("etaPhiRegions", etaPhiRegionDesc, etaPhiRegions);

  descriptions.add(defaultModuleLabel<HLTCaloObjInRegionsProducer<CaloObjType, CaloObjCollType>>(), desc);
}

makeFilteredColl()

template<typename CaloObjType , typename CaloObjCollType >

std::unique_ptr< CaloObjCollType > HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::makeFilteredColl ( const edm::Handle< CaloObjCollType > &  inputColl, CaloGeometry const &  caloGeomHandle, const std::vector< EtaPhiRegion > &  regions  )

staticprivate

Definition at line 208 of file HLTCaloObjInRegionsProducer.cc.

References PVValHelper::eta, CaloGeometry::getSubdetectorGeometry(), HLT_2023v12_cff::inputColl, Skims_PA_cff::name, getGTfromDQMFile::obj, hiSpikeCleaner_cfi::outputColl, PVValHelper::phi, HLT_2023v12_cff::region, and GeomDetEnumerators::subDetGeom.

                                            {
  auto outputColl = std::make_unique<CaloObjCollType>();
  if (!inputColl->empty()) {
    const CaloSubdetectorGeometry* subDetGeom = caloGeomHandle.getSubdetectorGeometry(inputColl->begin()->id());
    if (!regions.empty()) {
      for (auto const& obj : *inputColl) {
        auto objGeom = subDetGeom->getGeometry(obj.id());
        if (objGeom == nullptr) {
          //wondering what to do here
          //something is very very wrong
          //given HLT should never crash or throw, decided to log an error
          //update: so turns out HCAL can pass through calibration channels in QIE11 so for that module, its an expected behaviour
          //so we check if the ID is valid
          if (validIDForGeom(obj.id())) {
            edm::LogError("HLTCaloObjInRegionsProducer")
                << "for an object of type " << typeid(CaloObjType).name() << " the geometry returned null for id "
                << DetId(obj.id()).rawId() << " with initial ID " << DetId(inputColl->begin()->id()).rawId()
                << " in HLTCaloObjsInRegion, this shouldnt be possible and something has gone wrong, auto accepting "
                   "hit";
          }
          outputColl->push_back(obj);
          continue;
        }
        float eta = objGeom->getPosition().eta();
        float phi = objGeom->getPosition().phi();

        for (const auto& region : regions) {
          if (region(eta, phi)) {
            outputColl->push_back(obj);
            break;
          }
        }
      }
    }  //end check of empty regions
  }    //end check of empty rec-hits
  return outputColl;
}

produce()

template<typename CaloObjType , typename CaloObjCollType >

void HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::produce ( edm::Event &  event, const edm::EventSetup &  setup  )

override

Definition at line 181 of file HLTCaloObjInRegionsProducer.cc.

References edmPickEvents::event, input, HLT_2023v12_cff::inputColl, eostools::move(), Skims_PA_cff::name, hiSpikeCleaner_cfi::outputColl, and singleTopDQM_cfi::setup.

                                                                                                    {
  // get the collection geometry:
  auto const& caloGeom = setup.getData(caloGeometryToken_);

  std::vector<EtaPhiRegion> regions;
  std::for_each(etaPhiRegionData_.begin(),
                etaPhiRegionData_.end(),
                [&event, &regions](const std::unique_ptr<EtaPhiRegionDataBase>& input) {
                  input->getEtaPhiRegions(event, regions);
                });

  for (size_t inputCollNr = 0; inputCollNr < inputTokens_.size(); inputCollNr++) {
    edm::Handle<CaloObjCollType> inputColl;
    event.getByToken(inputTokens_[inputCollNr], inputColl);

    if (!(inputColl.isValid())) {
      edm::LogError("ProductNotFound") << "could not get a handle on the " << typeid(CaloObjCollType).name()
                                       << " named " << inputCollTags_[inputCollNr].encode() << std::endl;
      continue;
    }
    auto outputColl = makeFilteredColl(inputColl, caloGeom, regions);
    event.put(std::move(outputColl), outputProductNames_[inputCollNr]);
  }
}

validIDForGeom()

template<typename CaloObjType , typename CaloObjCollType >

bool HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::validIDForGeom ( const DetId &  id )

staticprivate

Definition at line 254 of file HLTCaloObjInRegionsProducer.cc.

References DetId::Hcal, HcalEmpty, and HcalOther.

                                                                                              {
  if (id.det() == DetId::Hcal) {
    if (id.subdetId() == HcalSubdetector::HcalEmpty || id.subdetId() == HcalSubdetector::HcalOther) {
      return false;
    }
  }
  return true;
}

Member Data Documentation

caloGeometryToken_

template<typename CaloObjType , typename CaloObjCollType = edm::SortedCollection<CaloObjType>>

const edm::ESGetToken<CaloGeometry, CaloGeometryRecord> HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::caloGeometryToken_

private

Definition at line 116 of file HLTCaloObjInRegionsProducer.cc.

etaPhiRegionData_

template<typename CaloObjType , typename CaloObjCollType = edm::SortedCollection<CaloObjType>>

std::vector<std::unique_ptr<EtaPhiRegionDataBase> > HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::etaPhiRegionData_

private

Definition at line 115 of file HLTCaloObjInRegionsProducer.cc.

inputCollTags_

template<typename CaloObjType , typename CaloObjCollType = edm::SortedCollection<CaloObjType>>

std::vector<edm::InputTag> HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::inputCollTags_

private

Definition at line 113 of file HLTCaloObjInRegionsProducer.cc.

inputTokens_

template<typename CaloObjType , typename CaloObjCollType = edm::SortedCollection<CaloObjType>>

std::vector<edm::EDGetTokenT<CaloObjCollType> > HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::inputTokens_

private

Definition at line 114 of file HLTCaloObjInRegionsProducer.cc.

outputProductNames_

template<typename CaloObjType , typename CaloObjCollType = edm::SortedCollection<CaloObjType>>

std::vector<std::string> HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::outputProductNames_

private

Definition at line 112 of file HLTCaloObjInRegionsProducer.cc.