Inheritance diagram for GEMPadDigiClusterProducer:

Public Types
typedef std::map< GEMDetId, GEMPadDigiClusters >	GEMPadDigiClusterContainer

typedef std::vector< GEMPadDigiCluster >	GEMPadDigiClusters

Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType

Public Types inherited from edm::ProducerBase
template<typename T >
using	BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >

using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex > >

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
	GEMPadDigiClusterProducer (const edm::ParameterSet &ps)

void	produce (edm::StreamID, edm::Event &, const edm::EventSetup &) const override

	~GEMPadDigiClusterProducer () override

Public Member Functions inherited from edm::global::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

EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const noexcept final

bool	wantsGlobalRuns () const noexcept final

bool	wantsInputProcessBlocks () const noexcept final

bool	wantsProcessBlocks () const noexcept final

bool	wantsStreamLuminosityBlocks () const noexcept final

bool	wantsStreamRuns () const noexcept final

Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

	~EDProducerBase () override

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

std::vector< bool > const &	recordProvenanceList () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~ProducerBase () noexcept(false) override

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const *> const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

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

Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
GEMPadDigiClusterContainer	buildClusters (const GEMPadDigiCollection &pads, const GEMGeometry &) const

template<class T >
void	checkValid (const T &cluster, const GEMDetId &id) const

GEMPadDigiClusterCollection	selectClusters (const GEMPadDigiClusterContainer &in_clusters, const GEMGeometry &) const

Private Attributes
edm::ESGetToken< GEMGeometry, MuonGeometryRecord >	geom_token_

unsigned int	maxClusterSize_

unsigned int	maxClustersOHGE11_

unsigned int	maxClustersOHGE21_

unsigned int	maxClustersPartitionGE11_

unsigned int	maxClustersPartitionGE21_

unsigned int	nOHGE11_

unsigned int	nOHGE21_

unsigned int	nPartitionsGE11_

unsigned int	nPartitionsGE21_

edm::EDGetTokenT< GEMPadDigiCollection >	pad_token_
	Name of input digi Collection. More...

edm::InputTag	pads_

edm::EDPutTokenT< GEMPadDigiClusterCollection >	put_token_

bool	sendOverflowClusters_

Additional Inherited Members
Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto	produces (std::string instanceName) noexcept
	declare what type of product will make and with which optional label More...

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

template<Transition Tr = Transition::Event>
auto	produces () noexcept

ProducesCollector	producesCollector ()

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Produces GEM pad clusters from at most 8 adjacent GEM pads. Clusters are used downstream in the CSC local trigger to build GEM-CSC triggers and in the muon trigger to build EMTF tracks

Based on documentation provided by the GEM firmware architects

Author: Sven Dildick (TAMU), updated by Giovanni Mocellin (UCDavis)

** Notes on chambers and cluster packing algorithm **

Based on: https://gitlab.cern.ch/emu/0xbefe/-/tree/devel/gem/hdl/cluster_finding/README.org (Andrew Peck, 2020/06/26)

GE1/1 chamber has 8 iEta partitions and 1 OH GE2/1 chamber has 16 iEta partitions and 4 OH (one per module)

Both GE1/1 and GE2/1 have 384 strips = 192 pads per iEta partition

GE1/1 OH has 4 clustering partitions, each covering 2 iEta partitions GE2/1 OH has 4 clustering partitions, each covering 1 iEta partition

Each clustering partition finds up to 4 clusters per BX, which are then sent to the sorter. The sorting of the clusters favors lower eta partitions and lower pad numbers.

The first 8 clusters are selected and sent out through optical fibers.

Definition at line 60 of file GEMPadDigiClusterProducer.cc.

Member Typedef Documentation

◆ GEMPadDigiClusterContainer

typedef std::map<GEMDetId, GEMPadDigiClusters> GEMPadDigiClusterProducer::GEMPadDigiClusterContainer

Definition at line 63 of file GEMPadDigiClusterProducer.cc.

◆ GEMPadDigiClusters

typedef std::vector<GEMPadDigiCluster> GEMPadDigiClusterProducer::GEMPadDigiClusters

Definition at line 62 of file GEMPadDigiClusterProducer.cc.

Constructor & Destructor Documentation

◆ GEMPadDigiClusterProducer()

GEMPadDigiClusterProducer::GEMPadDigiClusterProducer ( const edm::ParameterSet & ps )

explicit

Definition at line 97 of file GEMPadDigiClusterProducer.cc.

References geom_token_, edm::ParameterSet::getParameter(), maxClusterSize_, maxClustersOHGE11_, maxClustersOHGE21_, maxClustersPartitionGE11_, maxClustersPartitionGE21_, nOHGE11_, nOHGE21_, nPartitionsGE11_, nPartitionsGE21_, pad_token_, pads_, put_token_, and sendOverflowClusters_.

                                                                               {
   pads_ = ps.getParameter<edm::InputTag>("InputCollection");
   nPartitionsGE11_ = ps.getParameter<unsigned int>("nPartitionsGE11");
   nPartitionsGE21_ = ps.getParameter<unsigned int>("nPartitionsGE21");
   maxClustersPartitionGE11_ = ps.getParameter<unsigned int>("maxClustersPartitionGE11");
   maxClustersPartitionGE21_ = ps.getParameter<unsigned int>("maxClustersPartitionGE21");
   nOHGE11_ = ps.getParameter<unsigned int>("nOHGE11");
   nOHGE21_ = ps.getParameter<unsigned int>("nOHGE21");
   maxClustersOHGE11_ = ps.getParameter<unsigned int>("maxClustersOHGE11");
   maxClustersOHGE21_ = ps.getParameter<unsigned int>("maxClustersOHGE21");
   maxClusterSize_ = ps.getParameter<unsigned int>("maxClusterSize");
   sendOverflowClusters_ = ps.getParameter<bool>("sendOverflowClusters");
 
   if (sendOverflowClusters_) {
     maxClustersOHGE11_ *= 2;
     maxClustersOHGE21_ *= 2;
   }
 
   pad_token_ = consumes<GEMPadDigiCollection>(pads_);
   geom_token_ = esConsumes<GEMGeometry, MuonGeometryRecord>();
 
   put_token_ = produces<GEMPadDigiClusterCollection>();
 }

◆ ~GEMPadDigiClusterProducer()

GEMPadDigiClusterProducer::~GEMPadDigiClusterProducer ( )

override

Definition at line 121 of file GEMPadDigiClusterProducer.cc.

121 {}

Member Function Documentation

◆ buildClusters()

GEMPadDigiClusterProducer::GEMPadDigiClusterContainer GEMPadDigiClusterProducer::buildClusters	(	const GEMPadDigiCollection &	pads,
		const GEMGeometry &	geometry
	)		const

private

Definition at line 152 of file GEMPadDigiClusterProducer.cc.

References checkValid(), haddnano::cl, ztail::d, maxClusterSize_, and nPart().

Referenced by produce().

                                                                              {
   GEMPadDigiClusterContainer proto_clusters;
 
   // construct clusters
   for (const auto& part : geometry.etaPartitions()) {
     // clusters are not build for ME0
     // -> ignore hits from station 0
     if (part->isME0())
       continue;
 
     GEMPadDigiClusters all_pad_clusters;
 
     auto pads = det_pads.get(part->id());
     std::vector<uint16_t> cl;
     int startBX = 99;
 
     for (auto d = pads.first; d != pads.second; ++d) {
       // check if the input pad is valid
       checkValid(*d, part->id());
 
       // number of eta partitions
       unsigned nPart = d->nPartitions();
 
       if (cl.empty()) {
         cl.push_back((*d).pad());
       } else {
         if ((*d).bx() == startBX and            // same bunch crossing
             (*d).pad() == cl.back() + 1         // pad difference is 1
             and cl.size() < maxClusterSize_) {  // max 8 in cluster
           cl.push_back((*d).pad());
         } else {
           // put the current cluster in the proto collection
           GEMPadDigiCluster pad_cluster(cl, startBX, part->subsystem(), nPart);
 
           // check if the output cluster is valid
           checkValid(pad_cluster, part->id());
 
           all_pad_clusters.emplace_back(pad_cluster);
 
           // start a new cluster
           cl.clear();
           cl.push_back((*d).pad());
         }
       }
       startBX = (*d).bx();
     }
 
     // put the last cluster in the proto collection
     if (pads.first != pads.second) {
       // number of eta partitions
       unsigned nPart = (pads.first)->nPartitions();
 
       GEMPadDigiCluster pad_cluster(cl, startBX, part->subsystem(), nPart);
 
       // check if the output cluster is valid
       checkValid(pad_cluster, part->id());
 
       all_pad_clusters.emplace_back(pad_cluster);
     }
     proto_clusters.emplace(part->id(), all_pad_clusters);
 
   }  // end of partition loop
   return proto_clusters;
 }

◆ checkValid()

template<class T >

void GEMPadDigiClusterProducer::checkValid	(	const T &	cluster,
		const GEMDetId &	id
	)		const

private

Definition at line 257 of file GEMPadDigiClusterProducer.cc.

References l1ctLayer2EG_cff::id, and cmsswSequenceInfo::tp.

Referenced by buildClusters(), and selectClusters().

                                                                                 {
   // check if the pad/cluster is valid
   // in principle, invalid pads/clusters can appear in the CMS raw data
   if (!tp.isValid()) {
     edm::LogWarning("GEMPadDigiClusterProducer") << "Invalid " << tp << " in " << id;
   }
 }

◆ fillDescriptions()

void GEMPadDigiClusterProducer::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 123 of file GEMPadDigiClusterProducer.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and ProducerED_cfi::InputTag.

                                                                                            {
   edm::ParameterSetDescription desc;
   desc.add<edm::InputTag>("InputCollection", edm::InputTag("simMuonGEMPadDigis"));
   desc.add<unsigned int>("nPartitionsGE11", 4);           // Number of clusterizer partitions per OH
   desc.add<unsigned int>("nPartitionsGE21", 4);           // Number of clusterizer partitions per OH
   desc.add<unsigned int>("maxClustersPartitionGE11", 4);  // Maximum number of clusters per clusterizer partition
   desc.add<unsigned int>("maxClustersPartitionGE21", 4);  // Maximum number of clusters per clusterizer partition
   desc.add<unsigned int>("nOHGE11", 1);                   // Number of OH boards per chamber
   desc.add<unsigned int>("nOHGE21", 4);                   // Number of OH boards per chamber
   desc.add<unsigned int>("maxClustersOHGE11", 8);         // Maximum number of clusters per OH
   desc.add<unsigned int>("maxClustersOHGE21", 8);         // Maximum number of clusters per OH
   desc.add<unsigned int>("maxClusterSize", 8);            // Maximum cluster size (number of pads)
   desc.add<bool>("sendOverflowClusters", false);
 
   descriptions.add("simMuonGEMPadDigiClustersDef", desc);
 }

◆ produce()

void GEMPadDigiClusterProducer::produce	(	edm::StreamID	,
		edm::Event &	e,
		const edm::EventSetup &	eventSetup
	)		const

overridevirtual

Implements edm::global::EDProducerBase.

Definition at line 140 of file GEMPadDigiClusterProducer.cc.

References buildClusters(), MillePedeFileConverter_cfg::e, options_cfi::eventSetup, geom_token_, pad_token_, put_token_, and selectClusters().

                                                                                                        {
   auto const& geometry = eventSetup.getData(geom_token_);
 
   auto const& pads = e.get(pad_token_);
 
   // build the proto clusters (per partition)
   GEMPadDigiClusterContainer proto_clusters = buildClusters(pads, geometry);
 
   // sort and select clusters per chamber, per OH, per partition number and per pad number
   e.emplace(put_token_, selectClusters(proto_clusters, geometry));
 }

◆ selectClusters()

GEMPadDigiClusterCollection GEMPadDigiClusterProducer::selectClusters	(	const GEMPadDigiClusterContainer &	in_clusters,
		const GEMGeometry &	geometry
	)		const

private

Definition at line 218 of file GEMPadDigiClusterProducer.cc.

References checkValid(), l1tPhase2CaloJetEmulator_cfi::iEta, maxClustersOHGE11_, maxClustersOHGE21_, maxClustersPartitionGE11_, maxClustersPartitionGE21_, nOHGE11_, nOHGE21_, nPartitionsGE11_, and nPartitionsGE21_.

Referenced by produce().

                                                                                                          {
   GEMPadDigiClusterCollection out_clusters;
   for (const auto& ch : geometry.chambers()) {
     const unsigned nOH = ch->id().isGE11() ? nOHGE11_ : nOHGE21_;
     const unsigned nPartitions = ch->id().isGE11() ? nPartitionsGE11_ : nPartitionsGE21_;
     const unsigned nEtaPerPartition = ch->nEtaPartitions() / (nPartitions * nOH);
     const unsigned maxClustersPart = ch->id().isGE11() ? maxClustersPartitionGE11_ : maxClustersPartitionGE21_;
     const unsigned maxClustersOH = ch->id().isGE11() ? maxClustersOHGE11_ : maxClustersOHGE21_;
 
     // loop over OH in this chamber
     for (unsigned int iOH = 0; iOH < nOH; iOH++) {
       unsigned int nClustersOH = 0;  // Up to 8 clusters per OH
                                      // loop over clusterizer partitions
       for (unsigned int iPart = 0; iPart < nPartitions; iPart++) {
         unsigned int nClustersPart = 0;  // Up to 4 clusters per clustizer partition
         // loop over the eta partitions for this clusterizer partition
         for (unsigned iEta = 1; iEta <= nEtaPerPartition; iEta++) {
           // get the clusters for this eta partition
           const GEMDetId& iEtaId =
               ch->etaPartition(iEta + iPart * nEtaPerPartition + iOH * nPartitions * nEtaPerPartition)->id();
           if (proto_clusters.find(iEtaId) != proto_clusters.end()) {
             for (const auto& cluster : proto_clusters.at(iEtaId)) {
               if (nClustersPart < maxClustersPart and nClustersOH < maxClustersOH) {
                 checkValid(cluster, iEtaId);
                 out_clusters.insertDigi(iEtaId, cluster);
                 nClustersPart++;
                 nClustersOH++;
               }
             }  // end of loop on clusters in eta
           }
         }  // end of eta partition loop
       }    // end of clusterizer partition loop
     }      // end of OH loop
   }        // end of chamber loop
   return out_clusters;
 }