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
 
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)
 
 ~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 const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
ESProxyIndex const * esGetTokenIndices (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
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
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 wantsStreamLuminosityBlocks ()
 
static bool wantsStreamRuns ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
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 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<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
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)
 

Detailed Description

Definition at line 57 of file SiStripSpyUnpackerModule.cc.

Constructor & Destructor Documentation

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

Definition at line 89 of file SiStripSpyUnpackerModule.cc.

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

89  :
90  fed_ids_( pset.getParameter< std::vector<uint32_t> >("FEDIDs")),
91  productLabel_(pset.getParameter<edm::InputTag>("InputProductLabel")),
92  allowIncompleteEvents_(pset.getParameter<bool>("AllowIncompleteEvents")),
93  storeCounters_(pset.getParameter<bool>("StoreCounters")),
94  storeScopeRawDigis_(pset.getParameter<bool>("StoreScopeRawDigis")),
95  unpacker_(nullptr)
96  {
97  productToken_ = consumes<FEDRawDataCollection>(productLabel_);
98 
99  if ((fed_ids_.empty())) {
100  LogInfo(msgLb_) << "No FED IDs specified, so will try to unpack all FEDs with data" << std::endl;
102  for ( uint32_t ifed = FEDNumbering::MINSiStripFEDID; ifed <= FEDNumbering::MAXSiStripFEDID; ifed++ ) {
103  fed_ids_.push_back( ifed );
104  }
105  } // end of FED ID specified check.
106 
107  if ( edm::isDebugEnabled() ) LogTrace(msgLb_) << "["<< __func__ << "]:" << " Constructing object...";
108 
110 
111  if (storeScopeRawDigis_) produces< edm::DetSetVector<SiStripRawDigi> >("ScopeRawDigis");
112 
113  if (storeCounters_) {
114  produces< std::vector<uint32_t> >("L1ACount");
115  produces< std::vector<uint32_t> >("TotalEventCount");
116  }
117 
118  produces<uint32_t>("GlobalRunNumber");
119 
120  } // end of SpyUnpackerModule constructor.
std::vector< uint32_t > fed_ids_
Vector of FED IDs to examine (FEDs).
T getParameter(std::string const &) const
bool isDebugEnabled()
edm::EDGetTokenT< FEDRawDataCollection > productToken_
const bool storeScopeRawDigis_
True = store the scope mode raw digis.
Unpacks spy channel data into scope mode-like digis.
const bool allowIncompleteEvents_
Allow inconsistent (by event count, APV address) event storage.
const bool storeCounters_
True = store L1ID and TotalEventCount by FED key.
#define LogTrace(id)
const edm::InputTag productLabel_
The product label of the FEDRawDataCollection input.
sistrip::SpyUnpackerModule::~SpyUnpackerModule ( )
override

Definition at line 122 of file SiStripSpyUnpackerModule.cc.

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

122  {
123  if ( unpacker_ ) { delete unpacker_; }
124  if ( edm::isDebugEnabled() ) {
125  LogTrace("SiStripSpyUnpacker")
126  << "[sistrip::SpyUnpackerModule::" << __func__ << "]"
127  << " Destructing object...";
128  }
129  }
bool isDebugEnabled()
#define LogTrace(id)

Member Function Documentation

void sistrip::SpyUnpackerModule::produce ( edm::Event event,
const edm::EventSetup setup 
)
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.

Definition at line 137 of file SiStripSpyUnpackerModule.cc.

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

Referenced by JSONExport.JsonExport::export(), HTMLExport.HTMLExport::export(), and HTMLExport.HTMLExportStatic::export().

137  {
138 
139 
140  const SiStripFedCabling* lCabling = utility_.getCabling( setup );
141 
142  //retrieve FED raw data (by label, which is "source" by default)
144  event.getByToken( productToken_, buffers );
145 
146  //create container for digis
147  std::unique_ptr< edm::DetSetVector<SiStripRawDigi> > digis(new edm::DetSetVector<SiStripRawDigi>);
148 
149  //if necessary, create container for event counters
150  std::unique_ptr< std::vector<uint32_t> > pTotalCounts(new std::vector<uint32_t>);
151  std::unique_ptr< std::vector<uint32_t> > pL1ACounts(new std::vector<uint32_t>);
152  //and for run number
153  std::unique_ptr<uint32_t> pGlobalRun(new uint32_t);
154  //create digis
155  // Using FED IDs...
156  unpacker_->createDigis(*lCabling,
157  *buffers,
158  digis.get(),
159  fed_ids_,
160  pTotalCounts.get(),
161  pL1ACounts.get(),
162  pGlobalRun.get()
163  );
164 
165  // Add digis to event
166  if (storeScopeRawDigis_) event.put(std::move(digis), "ScopeRawDigis" );
167 
168  //add counters to event
169  if (storeCounters_) {
170  event.put(std::move(pTotalCounts), "TotalEventCount");
171  event.put(std::move(pL1ACounts), "L1ACount");
172  }
173 
174  //add global run to the event
175  event.put(std::move(pGlobalRun), "GlobalRunNumber");
176 
177  } // end of SpyUnpackerModule::produce method.
std::vector< uint32_t > fed_ids_
Vector of FED IDs to examine (FEDs).
edm::EDGetTokenT< FEDRawDataCollection > productToken_
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.
const bool storeScopeRawDigis_
True = store the scope mode raw digis.
const bool storeCounters_
True = store L1ID and TotalEventCount by FED key.
const SiStripFedCabling * getCabling(const edm::EventSetup &)
Updates the cabling object from the DB.
Contains cabling info at the device level, including DetId, APV pair numbers, hardware addresses...
def move(src, dest)
Definition: eostools.py:511

Member Data Documentation

const bool sistrip::SpyUnpackerModule::allowIncompleteEvents_
private

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

Definition at line 72 of file SiStripSpyUnpackerModule.cc.

Referenced by SpyUnpackerModule().

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

Vector of FED IDs to examine (FEDs).

Definition at line 69 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

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

Definition at line 64 of file SiStripSpyUnpackerModule.cc.

Referenced by SpyUnpackerModule().

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

The product label of the FEDRawDataCollection input.

Definition at line 70 of file SiStripSpyUnpackerModule.cc.

Referenced by SpyUnpackerModule().

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

Definition at line 71 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

const bool sistrip::SpyUnpackerModule::storeCounters_
private

True = store L1ID and TotalEventCount by FED key.

Definition at line 73 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

const bool sistrip::SpyUnpackerModule::storeScopeRawDigis_
private

True = store the scope mode raw digis.

Definition at line 74 of file SiStripSpyUnpackerModule.cc.

Referenced by produce(), and SpyUnpackerModule().

SpyUnpacker* sistrip::SpyUnpackerModule::unpacker_
private

Definition at line 76 of file SiStripSpyUnpackerModule.cc.

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

SpyUtilities sistrip::SpyUnpackerModule::utility_
private

Definition at line 79 of file SiStripSpyUnpackerModule.cc.

Referenced by produce().