CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes | Static Private Attributes
sistrip::SpyUnpackerModule Class Reference
Inheritance diagram for sistrip::SpyUnpackerModule:
edm::EDProducer edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

void produce (edm::Event &, const edm::EventSetup &) override
 Scope mode digis and event counter producer. Retrieves cabling map from EventSetup and FEDRawDataCollection from Event, creates a DetSetVector of SiStripRawDigis, uses the SiStripSpyUnpacker class to fill the DetSetVector, and attaches the container to the Event. More...
 
 SpyUnpackerModule (const edm::ParameterSet &)
 
 ~SpyUnpackerModule () override
 
- Public Member Functions inherited from edm::EDProducer
 EDProducer ()
 
SerialTaskQueueglobalLuminosityBlocksQueue ()
 
SerialTaskQueueglobalRunsQueue ()
 
ModuleDescription const & moduleDescription () const
 
 ~EDProducer () 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< ConsumesInfoconsumesInfo () const
 
void convertCurrentProcessAlias (std::string const &processName)
 Convert "@currentProcess" in InputTag process names to the actual current process name. More...
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase &&)=default
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
ESProxyIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
std::vector< ESProxyIndex > 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::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProxyIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Private Attributes

const bool allowIncompleteEvents_
 Allow inconsistent (by event count, APV address) event storage. More...
 
std::vector< uint32_t > fed_ids_
 Vector of FED IDs to examine (FEDs). More...
 
const edm::InputTag productLabel_
 The product label of the FEDRawDataCollection input. More...
 
edm::EDGetTokenT< FEDRawDataCollectionproductToken_
 
const bool storeCounters_
 True = store L1ID and TotalEventCount by FED key. More...
 
const bool storeScopeRawDigis_
 True = store the scope mode raw digis. More...
 
SpyUnpackerunpacker_
 
SpyUtilities utility_
 

Static Private Attributes

static const char * msgLb_ = "SiStripSpyUnpackerModule"
 

Additional Inherited Members

- Public Types inherited from edm::EDProducer
typedef EDProducer ModuleType
 
- Public Types inherited from edm::ProducerBase
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
 
- Static Public Member Functions inherited from edm::EDProducer
static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 
static bool wantsGlobalLuminosityBlocks ()
 
static bool wantsGlobalRuns ()
 
static bool wantsInputProcessBlocks ()
 
static bool wantsProcessBlocks ()
 
static bool wantsStreamLuminosityBlocks ()
 
static bool wantsStreamRuns ()
 
- Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType > produces ()
 declare what type of product will make and with which optional label More...
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
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)
 
template<Transition B>
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 (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
ProducesCollector producesCollector ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B > consumes (edm::InputTag tag) noexcept
 
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 ProductType , BranchType B = InEvent>
void consumesMany ()
 
void consumesMany (const TypeToGet &id)
 
template<BranchType B>
void consumesMany (const TypeToGet &id)
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<Transition Tr = Transition::Event>
constexpr auto esConsumes () noexcept
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
template<Transition Tr = Transition::Event>
auto esConsumes (ESInputTag tag) noexcept
 
template<Transition Tr = Transition::Event>
ESGetTokenGeneric esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
 Used with EventSetupRecord::doGet. More...
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 

Detailed Description

Definition at line 59 of file SiStripSpyUnpackerModule.cc.

Constructor & Destructor Documentation

◆ SpyUnpackerModule()

sistrip::SpyUnpackerModule::SpyUnpackerModule ( const edm::ParameterSet pset)

Definition at line 91 of file SiStripSpyUnpackerModule.cc.

92  : fed_ids_(pset.getParameter<std::vector<uint32_t> >("FEDIDs")),
93  productLabel_(pset.getParameter<edm::InputTag>("InputProductLabel")),
94  allowIncompleteEvents_(pset.getParameter<bool>("AllowIncompleteEvents")),
95  storeCounters_(pset.getParameter<bool>("StoreCounters")),
96  storeScopeRawDigis_(pset.getParameter<bool>("StoreScopeRawDigis")),
97  unpacker_(nullptr) {
98  productToken_ = consumes<FEDRawDataCollection>(productLabel_);
99 
100  if ((fed_ids_.empty())) {
101  LogInfo(msgLb_) << "No FED IDs specified, so will try to unpack all FEDs with data" << std::endl;
103  for (uint32_t ifed = FEDNumbering::MINSiStripFEDID; ifed <= FEDNumbering::MAXSiStripFEDID; ifed++) {
104  fed_ids_.push_back(ifed);
105  }
106  } // end of FED ID specified check.
107 
108  if (edm::isDebugEnabled())
109  LogTrace(msgLb_) << "[" << __func__ << "]:"
110  << " Constructing object...";
111 
113 
115  produces<edm::DetSetVector<SiStripRawDigi> >("ScopeRawDigis");
116 
117  if (storeCounters_) {
118  produces<std::vector<uint32_t> >("L1ACount");
119  produces<std::vector<uint32_t> >("TotalEventCount");
120  }
121 
122  produces<uint32_t>("GlobalRunNumber");
123 
124  } // end of SpyUnpackerModule constructor.

References allowIncompleteEvents_, fed_ids_, edm::isDebugEnabled(), LogTrace, FEDNumbering::MAXSiStripFEDID, FEDNumbering::MINSiStripFEDID, msgLb_, productLabel_, productToken_, storeCounters_, storeScopeRawDigis_, and unpacker_.

◆ ~SpyUnpackerModule()

sistrip::SpyUnpackerModule::~SpyUnpackerModule ( )
override

Definition at line 126 of file SiStripSpyUnpackerModule.cc.

126  {
127  if (unpacker_) {
128  delete unpacker_;
129  }
130  if (edm::isDebugEnabled()) {
131  LogTrace("SiStripSpyUnpacker") << "[sistrip::SpyUnpackerModule::" << __func__ << "]"
132  << " Destructing object...";
133  }
134  }

References edm::isDebugEnabled(), LogTrace, and unpacker_.

Member Function Documentation

◆ produce()

void sistrip::SpyUnpackerModule::produce ( edm::Event event,
const edm::EventSetup setup 
)
overridevirtual

Scope mode digis and event counter producer. Retrieves cabling map from EventSetup and FEDRawDataCollection from Event, creates a DetSetVector of SiStripRawDigis, uses the SiStripSpyUnpacker class to fill the DetSetVector, and attaches the container to the Event.

Implements edm::EDProducer.

Definition at line 142 of file SiStripSpyUnpackerModule.cc.

142  {
143  const SiStripFedCabling* lCabling = utility_.getCabling(setup);
144 
145  //retrieve FED raw data (by label, which is "source" by default)
147  event.getByToken(productToken_, buffers);
148 
149  //create container for digis
150  std::unique_ptr<edm::DetSetVector<SiStripRawDigi> > digis(new edm::DetSetVector<SiStripRawDigi>);
151 
152  //if necessary, create container for event counters
153  std::unique_ptr<std::vector<uint32_t> > pTotalCounts(new std::vector<uint32_t>);
154  std::unique_ptr<std::vector<uint32_t> > pL1ACounts(new std::vector<uint32_t>);
155  //and for run number
156  std::unique_ptr<uint32_t> pGlobalRun(new uint32_t);
157  //create digis
158  // Using FED IDs...
160  *lCabling, *buffers, digis.get(), fed_ids_, pTotalCounts.get(), pL1ACounts.get(), pGlobalRun.get());
161 
162  // Add digis to event
164  event.put(std::move(digis), "ScopeRawDigis");
165 
166  //add counters to event
167  if (storeCounters_) {
168  event.put(std::move(pTotalCounts), "TotalEventCount");
169  event.put(std::move(pL1ACounts), "L1ACount");
170  }
171 
172  //add global run to the event
173  event.put(std::move(pGlobalRun), "GlobalRunNumber");
174 
175  } // end of SpyUnpackerModule::produce method.

References sistrip::SpyUnpacker::createDigis(), fed_ids_, sistrip::SpyUtilities::getCabling(), eostools::move(), productToken_, singleTopDQM_cfi::setup, storeCounters_, storeScopeRawDigis_, unpacker_, and utility_.

Member Data Documentation

◆ allowIncompleteEvents_

const bool sistrip::SpyUnpackerModule::allowIncompleteEvents_
private

Allow inconsistent (by event count, APV address) event storage.

Definition at line 74 of file SiStripSpyUnpackerModule.cc.

Referenced by SpyUnpackerModule().

◆ fed_ids_

std::vector<uint32_t> sistrip::SpyUnpackerModule::fed_ids_
private

Vector of FED IDs to examine (FEDs).

Definition at line 71 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

◆ msgLb_

const char * sistrip::SpyUnpackerModule::msgLb_ = "SiStripSpyUnpackerModule"
staticprivate

Definition at line 66 of file SiStripSpyUnpackerModule.cc.

Referenced by SpyUnpackerModule().

◆ productLabel_

const edm::InputTag sistrip::SpyUnpackerModule::productLabel_
private

The product label of the FEDRawDataCollection input.

Definition at line 72 of file SiStripSpyUnpackerModule.cc.

Referenced by SpyUnpackerModule().

◆ productToken_

edm::EDGetTokenT<FEDRawDataCollection> sistrip::SpyUnpackerModule::productToken_
private

Definition at line 73 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

◆ storeCounters_

const bool sistrip::SpyUnpackerModule::storeCounters_
private

True = store L1ID and TotalEventCount by FED key.

Definition at line 75 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

◆ storeScopeRawDigis_

const bool sistrip::SpyUnpackerModule::storeScopeRawDigis_
private

True = store the scope mode raw digis.

Definition at line 76 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

◆ unpacker_

SpyUnpacker* sistrip::SpyUnpackerModule::unpacker_
private

Definition at line 78 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), SpyUnpackerModule(), and ~SpyUnpackerModule().

◆ utility_

SpyUtilities sistrip::SpyUnpackerModule::utility_
private

Definition at line 81 of file SiStripSpyUnpackerModule.cc.

Referenced by produce().

edm::DetSetVector< SiStripRawDigi >
sistrip::SpyUnpackerModule::productLabel_
const edm::InputTag productLabel_
The product label of the FEDRawDataCollection input.
Definition: SiStripSpyUnpackerModule.cc:72
sistrip::SpyUnpackerModule::storeCounters_
const bool storeCounters_
True = store L1ID and TotalEventCount by FED key.
Definition: SiStripSpyUnpackerModule.cc:75
sistrip::SpyUnpackerModule::msgLb_
static const char * msgLb_
Definition: SiStripSpyUnpackerModule.cc:66
sistrip::SpyUnpackerModule::unpacker_
SpyUnpacker * unpacker_
Definition: SiStripSpyUnpackerModule.cc:78
edm::LogInfo
Log< level::Info, false > LogInfo
Definition: MessageLogger.h:125
SiStripFedCabling
Contains cabling info at the device level, including DetId, APV pair numbers, hardware addresses,...
Definition: SiStripFedCabling.h:25
edm::Handle
Definition: AssociativeIterator.h:50
singleTopDQM_cfi.setup
setup
Definition: singleTopDQM_cfi.py:37
sistrip::SpyUnpacker
Unpacks spy channel data into scope mode-like digis.
Definition: SiStripSpyUnpacker.h:31
FEDNumbering::MAXSiStripFEDID
Definition: FEDNumbering.h:30
sistrip::SpyUnpackerModule::fed_ids_
std::vector< uint32_t > fed_ids_
Vector of FED IDs to examine (FEDs).
Definition: SiStripSpyUnpackerModule.cc:71
sistrip::SpyUnpackerModule::productToken_
edm::EDGetTokenT< FEDRawDataCollection > productToken_
Definition: SiStripSpyUnpackerModule.cc:73
sistrip::SpyUnpackerModule::storeScopeRawDigis_
const bool storeScopeRawDigis_
True = store the scope mode raw digis.
Definition: SiStripSpyUnpackerModule.cc:76
sistrip::SpyUtilities::getCabling
const SiStripFedCabling * getCabling(const edm::EventSetup &)
Updates the cabling object from the DB.
Definition: SiStripSpyUtilities.cc:37
sistrip::SpyUnpackerModule::utility_
SpyUtilities utility_
Definition: SiStripSpyUnpackerModule.cc:81
eostools.move
def move(src, dest)
Definition: eostools.py:511
sistrip::SpyUnpackerModule::allowIncompleteEvents_
const bool allowIncompleteEvents_
Allow inconsistent (by event count, APV address) event storage.
Definition: SiStripSpyUnpackerModule.cc:74
edm::isDebugEnabled
bool isDebugEnabled()
Definition: MessageLogger.cc:12
LogTrace
#define LogTrace(id)
Definition: MessageLogger.h:224
sistrip::SpyUnpacker::createDigis
void createDigis(const SiStripFedCabling &, const FEDRawDataCollection &, RawDigis *pDigis, const std::vector< uint32_t > &ids, Counters *pTotalEventCounts, Counters *pL1ACounts, uint32_t *aRunRef)
Creates the scope mode digis for the supplied FED IDs or detIds and stores event counters.
Definition: SiStripSpyUnpacker.cc:43
edm::InputTag
Definition: InputTag.h:15
muonDTDigis_cfi.pset
pset
Definition: muonDTDigis_cfi.py:27
FEDNumbering::MINSiStripFEDID
Definition: FEDNumbering.h:29