Belle II Software development
PXDUnpackerOldModule Class Reference

The PXDUnpacker module. More...

#include <PXDUnpackerOldModule.h>

Inheritance diagram for PXDUnpackerOldModule:
Module PathElement

Public Types

enum  EModulePropFlags {
  c_Input = 1 ,
  c_Output = 2 ,
  c_ParallelProcessingCertified = 4 ,
  c_HistogramManager = 8 ,
  c_InternalSerializer = 16 ,
  c_TerminateInAllProcesses = 32 ,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

 PXDUnpackerOldModule ()
 Constructor defining the parameters.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
virtual void beginRun ()
 Called when entering a new run.
 
virtual void endRun ()
 This method is called if the current run ends.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level.
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module.
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module.
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module.
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished.
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module.
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter.
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module.
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static int nr5bits (int i)
 helper function to "count" nr of set bits within lower 5 bits.
 
static void dump_dhp (void *data, unsigned int frame_len)
 dump to a file, helper function for debugging.
 
static void dump_roi (void *data, unsigned int frame_len)
 dump to a file, helper function for debugging.
 
static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python.
 
virtual void def_beginRun ()
 Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
 
virtual void def_event ()
 Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
 
virtual void def_endRun ()
 This method can receive that the current run ends as a call from the Python side.
 
virtual void def_terminate ()
 Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
 
void setDescription (const std::string &description)
 Sets the description of the module.
 
void setType (const std::string &type)
 Set the module type.
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
 Adds a new parameter to the module.
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module.
 
void setReturnValue (int value)
 Sets the return value for this module as integer.
 
void setReturnValue (bool value)
 Sets the return value for this module as bool.
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

void initialize () override final
 Initialize the module.
 
void event () override final
 do the unpacking
 
void terminate () override final
 Terminate the module.
 
void unpack_rawpxd (RawPXD &px, int inx)
 Unpack one event (several frames) stored in RawPXD object.
 
void unpack_dhc_frame (void *data, const int len, const int Frame_Number, const int Frames_in_event, PXDDAQPacketStatus &daqpktstat)
 Unpack one frame (within an event).
 
void unpack_dhp (void *data, unsigned int len, unsigned int dhe_first_readout_frame_lo, unsigned int dhe_ID, unsigned dhe_DHPport, unsigned dhe_reformat, VxdID vxd_id, PXDDAQPacketStatus &daqpktstat)
 Unpack DHP data within one DHE frame.
 
void unpack_dhp_raw (void *data, unsigned int len, unsigned int dhe_ID, unsigned dhe_DHPport, VxdID vxd_id)
 Unpack DHP RAW data within one DHE frame (pedestals, etc)
 
void unpack_fce (unsigned short *data, unsigned int length, VxdID vxd_id)
 Unpack DHP/FCE data within one DHE frame Not fully implemented as cluster format not 100% fixed.
 
std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

std::string m_RawPXDsName
 The name of the StoreArray of processed RawPXDs.
 
std::string m_PXDDAQEvtStatsName
 The name of the StoreObjPtr of PXDDAQStatus to be generated.
 
std::string m_PXDRawHitsName
 The name of the StoreArray of PXDRawHits to be generated.
 
std::string m_PXDRawAdcsName
 The name of the StoreArray of PXDRawAdcs to be generated.
 
std::string m_PXDRawROIsName
 The name of the StoreArray of PXDRawROIs to be generated.
 
bool m_doNotStore {false}
 Only unpack, but Do Not Store anything to file.
 
bool m_checkPaddingCRC {false}
 Check for susp.
 
bool m_forceMapping {false}
 Force Mapping even if DHH bit is not requesting it.
 
bool m_forceNoMapping {false}
 Force No Mapping even if DHH bit is requesting it.
 
unsigned int m_maxDHPFrameDiff {0}
 Maximum DHP frame difference until error is reported.
 
PXDError::PXDErrorFlags m_criticalErrorMask {}
 Critical error mask which defines return value of task.
 
PXDError::PXDErrorFlags m_suppressErrorMask {}
 Mask for suppressing selected error messages.
 
PXDError::PXDErrorFlags m_errorSkipPacketMask {}
 Mask for error which stop package unpacking directly.
 
unsigned long m_meta_event_nr {0}
 Event Number from MetaInfo.
 
unsigned long m_meta_run_nr {0}
 Run Number from MetaInfo.
 
unsigned long m_meta_subrun_nr {0}
 Subrun Number from MetaInfo.
 
unsigned long m_meta_experiment {0}
 Experiment from MetaInfo.
 
unsigned long long int m_meta_time {0}
 Time(Tag) from MetaInfo.
 
unsigned int m_meta_sec {0}
 Time(Tag) from MetaInfo, seconds (masked to lower bits)
 
unsigned int m_meta_ticks {0}
 Time(Tag) from MetaInfo, Ticks of 127MHz.
 
unsigned int m_unpackedEventsCount {0}
 Event counter.
 
unsigned int m_errorCounter [PXDError::ONSEN_MAX_TYPE_ERR] {}
 Error counters.
 
bool m_verbose {false}
 give verbose unpacking information
 
bool m_continueOnError {false}
 flag continue unpacking of frames even after error (for debugging)
 
StoreArray< RawPXDm_storeRawPXD
 Input array for PXD Raw.
 
StoreObjPtr< EventMetaDatam_eventMetaData
 Input ptr for EventMetaData.
 
StoreArray< PXDRawHitm_storeRawHits
 Output array for Raw Hits.
 
StoreArray< PXDRawROIsm_storeROIs
 Output array for Raw ROIs.
 
StoreObjPtr< PXDDAQStatusm_storeDAQEvtStats
 Output array for DAQ Status.
 
StoreArray< PXDRawAdcm_storeRawAdc
 Output array for Raw Adcs.
 
PXDError::PXDErrorFlags m_errorMask {0}
 Error Mask set per packet / frame.
 
PXDError::PXDErrorFlags m_errorMaskDHE {0}
 Error Mask set per packet / DHE.
 
PXDError::PXDErrorFlags m_errorMaskDHC {0}
 Error Mask set per packet / DHC.
 
PXDError::PXDErrorFlags m_errorMaskPacket {0}
 Error Mask set per packet / packet.
 
PXDError::PXDErrorFlags m_errorMaskEvent {0}
 Error Mask set per packet / event.
 
unsigned int m_notaccepted {0}
 counter for not accepted events... should not happen TODO discussion ongoing with DAQ group
 
unsigned int m_sendrois {0}
 counter for send debug rois
 
unsigned int m_sendunfiltered {0}
 counter for send unfiltered
 
bool m_formatBonnDAQ {false}
 flag ONSEN or BonnDAQ format
 
int m_last_dhp_readout_frame_lo [4] { -1}
 some workaround check for continouous frame ids
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

The PXDUnpacker module.

This module is responsible for unpacking the Raw PXD data to Pixels in v_cellID and u_cellID (global tracking coordinates system) Doing that, sophisticated error and consistency checking is done from the lowest data level on

Definition at line 38 of file PXDUnpackerOldModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ PXDUnpackerOldModule()

Constructor defining the parameters.

Definition at line 37 of file PXDUnpackerOldModule.cc.

37 :
38 Module(),
42{
43 //Set module properties
44 setDescription("Unpack Raw PXD Hits from ONSEN data stream");
46
47 addParam("RawPXDsName", m_RawPXDsName, "The name of the StoreArray of RawPXDs to be processed", std::string(""));
48 addParam("PXDRawHitsName", m_PXDRawHitsName, "The name of the StoreArray of generated PXDRawHits", std::string(""));
49 addParam("PXDDAQEvtStatsName", m_PXDDAQEvtStatsName, "The name of the StoreObjPtr of generated PXDDAQEvtStats", std::string(""));
50 addParam("PXDRawAdcsName", m_PXDRawAdcsName, "The name of the StoreArray of generated PXDRawAdcs", std::string(""));
51 addParam("PXDRawROIsName", m_PXDRawROIsName, "The name of the StoreArray of generated PXDRawROIs", std::string(""));
52 addParam("DoNotStore", m_doNotStore, "only unpack and check, but do not store", false);
53// addParam("CriticalErrorMask", m_criticalErrorMask, "Set error mask which stops processing by returning false by task", 0);
54 // m_criticalErrorMask not longer a aparameter
55 // the constructor default to zero anyway
56// addParam("SuppressErrorMask", m_suppressErrorMask, "Set mask for errors msgs which are not printed", getSilenceMask());
57 // m_suppressErrorMask not longer a aparameter
58 m_suppressErrorMask = getSilenceMask();
59 addParam("ForceMapping", m_forceMapping, "Force Mapping even if DHH bit is NOT requesting it", false);
60 addParam("ForceNoMapping", m_forceNoMapping, "Force NO Mapping even if DHH bit is requesting it", false);
61 addParam("CheckPaddingCRC", m_checkPaddingCRC, "Check for susp. padding (debug option, many false positive)", false);
62 addParam("MaxDHPFrameDiff", m_maxDHPFrameDiff, "Maximum DHP Frame Nr Difference w/o reporting error", 2u);
63 addParam("FormatBonnDAQ", m_formatBonnDAQ, "ONSEN or BonnDAQ format", false);
64 addParam("Verbose", m_verbose, "Turn on extra verbosity for log-level debug", false);
65 addParam("ContinueOnError", m_continueOnError, "Continue package depacking on error (for debugging)", false);
66// (
67// /*EPXDErrFlag::c_DHC_END | EPXDErrFlag::c_DHE_START | EPXDErrFlag::c_DATA_OUTSIDE |*/
68// EPXDErrFlag::c_FIX_SIZE | EPXDErrFlag::c_DHE_CRC | EPXDErrFlag::c_DHC_UNKNOWN | /*EPXDErrFlag::c_MERGER_CRC |*/
69// EPXDErrFlag::c_DHP_SIZE | /*EPXDErrFlag::c_DHP_PIX_WO_ROW | EPXDErrFlag::c_DHE_START_END_ID | EPXDErrFlag::c_DHE_START_ID |*/
70// EPXDErrFlag::c_DHE_START_WO_END | EPXDErrFlag::c_DHP_NOT_CONT
71// ));
72
73 // this is not really a parameter, it should be fixed.
74 m_errorSkipPacketMask[c_nrDHE_CRC] = true;
75 m_errorSkipPacketMask[c_nrFIX_SIZE] = true;
76}
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Module()
Constructor.
Definition: Module.cc:30
std::string m_PXDRawHitsName
The name of the StoreArray of PXDRawHits to be generated.
bool m_doNotStore
Only unpack, but Do Not Store anything to file.
bool m_forceNoMapping
Force No Mapping even if DHH bit is requesting it.
std::string m_PXDDAQEvtStatsName
The name of the StoreObjPtr of PXDDAQStatus to be generated.
PXDError::PXDErrorFlags m_suppressErrorMask
Mask for suppressing selected error messages.
bool m_formatBonnDAQ
flag ONSEN or BonnDAQ format
StoreArray< PXDRawROIs > m_storeROIs
Output array for Raw ROIs.
std::string m_RawPXDsName
The name of the StoreArray of processed RawPXDs.
StoreArray< PXDRawAdc > m_storeRawAdc
Output array for Raw Adcs.
PXDError::PXDErrorFlags m_errorSkipPacketMask
Mask for error which stop package unpacking directly.
std::string m_PXDRawAdcsName
The name of the StoreArray of PXDRawAdcs to be generated.
bool m_continueOnError
flag continue unpacking of frames even after error (for debugging)
unsigned int m_maxDHPFrameDiff
Maximum DHP frame difference until error is reported.
StoreArray< PXDRawHit > m_storeRawHits
Output array for Raw Hits.
bool m_forceMapping
Force Mapping even if DHH bit is not requesting it.
bool m_verbose
give verbose unpacking information
std::string m_PXDRawROIsName
The name of the StoreArray of PXDRawROIs to be generated.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void  )
inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented in ARICHBackgroundModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, EventsOfDoomBusterModule, CosmicsAlignmentValidationModule, EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, arichBtestModule, ARICHDigitizerModule, ARICHDQMModule, ARICHRateCalModule, ARICHReconstructorModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageSerializerModule, IPDQMModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDMVAModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, EvtGenDecayModule, EvtGenInputModule, OverrideGenerationFlagsModule, KKGenInputModule, CreateFieldMapModule, ExportGeometryModule, SoftwareTriggerModule, SoftwareTriggerHLTDQMModule, StatisticsTimingHLTDQMModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterAnaModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDigitTimeShifterModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, PXDBackgroundModule, PXDRawDQMChipsModule, PXDClustersFromTracksModule, PXDPerformanceModule, PXDClusterizerModule, Convert2RawDetModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0DQMModule, EventT0ValidationModule, DataWriterModule, ECLExpertModule, KLMExpertModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, MaterialScanModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsCheckModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, SVDDQMHitTimeModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDMaxStripTTreeModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPerformanceTTreeModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDMissingAPVsClusterCreatorModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDDigitizerModule, SVDEventInfoSetterModule, SVDTriggerQualityGeneratorModule, SVDSpacePointCreatorModule, SVDTimeGroupingModule, SVDUnpackerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelMaskerModule, TOPChannelT0MCModule, TOPDigitizerModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTimeRecalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, DQMHistoModuleBase, SVDEventT0EstimatorModule, ExtModule, FlipQualityModule, BeamSpotMonitorModule, KinkFinderModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, PXDROIFinderModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackCreatorModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TrackQualityEstimatorMVAModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, QualityEstimatorVXDModule, VXDQETrainingDataCollectorModule, VXDQualityEstimatorMVAModule, SectorMapBootstrapModule, SegmentNetworkProducerModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, CDCTriggerTSFModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, CDCTriggerUnpackerModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, VXDMisalignmentModule, DQMHistAnalysisARICHModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputRootFileModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTrackingHLTModule, DQMHistAnalysisTRGECLModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, DAQMonitorModule, DelayDQMModule, V0ObjectsDQMModule, ECLDQMInjectionModule, PyModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDDAQDQMModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDRawDQMCorrModule, PXDRawDQMModule, PXDROIDQMModule, PXDTrackClusterDQMModule, PXDDigitizerModule, PXDPackerModule, PXDUnpackerModule, TTDDQMModule, SVDDQMClustersOnTrackModule, SVDDQMDoseModule, SVDDQMExpressRecoModule, SVDDQMInjectionModule, SVDUnpackerDQMModule, PXDclusterFilterModule, PXDdigiFilterModule, PXDROIFinderAnalysisModule, TrackingAbortDQMModule, VXDDQMExpressRecoModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisTRGModule, DQMHistInjectionModule, and DQMHistOutputToEPICSModule.

Definition at line 147 of file Module.h.

147{};

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ dump_dhp()

void dump_dhp ( void *  data,
unsigned int  frame_len 
)
static

dump to a file, helper function for debugging.

Definition at line 405 of file PXDUnpackerOldModule.cc.

406{
407 // called only for debugging purpose, will never be called in normal running
408 unsigned int w = frame_len / 2;
409 ubig16_t* d = (ubig16_t*)data;
410
411 B2WARNING("HEADER -- $" << hex << d[0] << ",$" << hex << d[1] << ",$" << hex << d[2] << ",$" << hex << d[3] << " -- ");
412
413 auto dhp_header_type = (d[2] & 0xE000) >> 13;
414 auto dhp_reserved = (d[2] & 0x1F00) >> 8;
415 auto dhp_dhe_id = (d[2] & 0x00FC) >> 2;
416 auto dhp_dhp_id = d[2] & 0x0003;
417
418 B2WARNING("DHP type | $" << hex << dhp_header_type << " ( " << dec << dhp_header_type << " ) ");
419 B2WARNING("DHP reserved | $" << hex << dhp_reserved << " ( " << dec << dhp_reserved << " ) ");
420 B2WARNING("DHP DHE ID | $" << hex << dhp_dhe_id << " ( " << dec << dhp_dhe_id << " ) ");
421 B2WARNING("DHP DHP ID | $" << hex << dhp_dhp_id << " ( " << dec << dhp_dhp_id << " ) ");
422 for (unsigned int i = 4; i < w; i++) {
423 B2WARNING("DHP DATA $" << hex << d[i]);
424 }
425 B2WARNING("DHP CRC $" << hex << d[w] << ",$" << hex << d[w + 1]);
426}

◆ dump_roi()

void dump_roi ( void *  data,
unsigned int  frame_len 
)
static

dump to a file, helper function for debugging.

Definition at line 428 of file PXDUnpackerOldModule.cc.

429{
430 // called only for debugging purpose, will never be called in normal running
431 unsigned int w = frame_len / 4;
432 ubig32_t* d = (ubig32_t*)data;
433
434 B2WARNING("HEADER -- $" << hex << d[0] << ",$" << hex << d[1] << ",$" << hex << d[2] << ",$" << hex << d[3] << " -- Len $" << hex
435 << frame_len);
436
437 for (unsigned int i = 0; i < w; i++) {
438 B2WARNING("ROI DATA $" << hex << d[i]);
439 }
440 B2WARNING("ROI CRC $" << hex << d[w]);
441}

◆ endRun()

virtual void endRun ( void  )
inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Reimplemented in BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, AlignDQMModule, CosmicsAlignmentValidationModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, arichBtestModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, TPCStudyModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, Root2RawModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, EvtGenDecayModule, OverrideGenerationFlagsModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, AWESOMEBasicModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, Convert2RawDetModule, PrintDataModule, PrintEventRateModule, Root2BinaryModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0ValidationModule, DataWriterModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDTriggerQualityGeneratorModule, SVDUnpackerModule, TOPBackgroundModule, TOPChannelT0MCModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPWaveformQualityPlotterModule, TOPXTalkChargeShareSetterModule, ExtModule, GenfitVisModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, MCSlowPionPXDROICreatorModule, PXDROIFinderModule, SVDROIDQMModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, RT2SPTCConverterModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, NoKickCutsEvalModule, SectorMapBootstrapModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGGDLModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, PyModule, SVDUnpackerDQMModule, TrackSetEvaluatorHopfieldNNDEVModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisTRGModule, and DQMHistOutputToEPICSModule.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const
inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns
True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
finaloverrideprivatevirtual

do the unpacking

Reimplemented from Module.

Definition at line 125 of file PXDUnpackerOldModule.cc.

126{
127 m_storeDAQEvtStats.create();
128
129 m_errorMask = 0;
131
132 m_meta_event_nr = m_eventMetaData->getEvent();// used for error output below
133
134 if (!m_storeRawPXD) {// if no input, nothing to do
135 m_errorMask[c_nrNO_PXD] = true;
136 } else {
137 int nRaws = m_storeRawPXD.getEntries();
138 if (m_verbose) {
139 B2DEBUG(29, "PXD Unpacker --> RawPXD Objects in event: " << LogVar("Objects", nRaws));
140 };
141
142 m_meta_run_nr = m_eventMetaData->getRun();
143 m_meta_subrun_nr = m_eventMetaData->getSubrun();
144 m_meta_experiment = m_eventMetaData->getExperiment();
145 m_meta_time = m_eventMetaData->getTime();
146 m_meta_ticks = (unsigned int)std::round((m_meta_time % 1000000000ull) * 0.127216); // calculate ticks in 127MHz RF clock
147 m_meta_sec = (unsigned int)(m_meta_time / 1000000000ull) & 0x1FFFF;
148
149 int inx = 0; // count index for output objects
150 for (auto& it : m_storeRawPXD) {
151 if (m_verbose) {
152 B2DEBUG(29, "PXD Unpacker --> Unpack Objects: ");
153 };
154 unpack_rawpxd(it, inx++);
155 }
156
157 if (nRaws == 0) m_errorMask[c_nrNO_PXD] = true;
158 }
161
163 {
164 for (unsigned int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) {
165 if (m_errorMaskEvent[i]) m_errorCounter[i]++;
166 }
167 }
168
169 if ((PXDErrorFlags(m_criticalErrorMask) & m_errorMaskEvent) != PXDErrorFlags(0)) B2ERROR("Error in PXD unpacking" <<
170 LogVar("event nr", m_meta_event_nr));
171 setReturnValue(PXDErrorFlags(0) == (PXDErrorFlags(m_criticalErrorMask) & m_errorMaskEvent));
172}
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
unsigned long m_meta_experiment
Experiment from MetaInfo.
PXDError::PXDErrorFlags m_errorMaskEvent
Error Mask set per packet / event.
StoreObjPtr< PXDDAQStatus > m_storeDAQEvtStats
Output array for DAQ Status.
StoreArray< RawPXD > m_storeRawPXD
Input array for PXD Raw.
unsigned int m_errorCounter[PXDError::ONSEN_MAX_TYPE_ERR]
Error counters.
StoreObjPtr< EventMetaData > m_eventMetaData
Input ptr for EventMetaData.
unsigned long m_meta_subrun_nr
Subrun Number from MetaInfo.
unsigned long m_meta_event_nr
Event Number from MetaInfo.
unsigned long m_meta_run_nr
Run Number from MetaInfo.
unsigned int m_meta_sec
Time(Tag) from MetaInfo, seconds (masked to lower bits)
PXDError::PXDErrorFlags m_criticalErrorMask
Critical error mask which defines return value of task.
void unpack_rawpxd(RawPXD &px, int inx)
Unpack one event (several frames) stored in RawPXD object.
unsigned long long int m_meta_time
Time(Tag) from MetaInfo.
PXDError::PXDErrorFlags m_errorMask
Error Mask set per packet / frame.
unsigned int m_unpackedEventsCount
Event counter.
unsigned int m_meta_ticks
Time(Tag) from MetaInfo, Ticks of 127MHz.
Class to store variables with their name which were sent to the logging service.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const
inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const
inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).


Definition at line 113 of file Module.cc.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:511

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( bool  outputFiles)
inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

135 {
136 return std::vector<std::string>();
137 }

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ return std::list<ModulePtr>(); }

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

187{return m_name;}
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const
inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns
A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

Returns true if all specified property flags are available in this module.

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ if_false()

void if_false ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

86{
87 if_value("<1", path, afterConditionPath);
88}

◆ if_true()

void if_true ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

91{
92 if_value(">=1", path, afterConditionPath);
93}

◆ if_value()

void if_value ( const std::string &  expression,
const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

80{
81 m_conditions.emplace_back(expression, path, afterConditionPath);
82}

◆ initialize()

void initialize ( void  )
finaloverrideprivatevirtual

Initialize the module.

actually, later we do not want to store ROIs and raw ADC into output file ... aside from debugging

Reimplemented from Module.

Definition at line 78 of file PXDUnpackerOldModule.cc.

79{
80 // Required input
81 m_eventMetaData.isRequired();
82 // Optional input
83 m_storeRawPXD.isOptional(m_RawPXDsName);
84
85 //Register output collections
91
92 B2DEBUG(29, "ForceMapping: " << m_forceMapping);
93 B2DEBUG(29, "ForceNoMapping: " << m_forceNoMapping);
94 B2DEBUG(29, "CheckPaddingCRC: " << m_checkPaddingCRC);
95 B2DEBUG(29, "MaxDHPFrameDiff: " << m_maxDHPFrameDiff);
96
98 m_sendrois = 0;
99 m_notaccepted = 0;
101 for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) m_errorCounter[i] = 0;
102
103}
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition: DataStore.h:72
unsigned int m_sendunfiltered
counter for send unfiltered
unsigned int m_notaccepted
counter for not accepted events... should not happen TODO discussion ongoing with DAQ group
unsigned int m_sendrois
counter for send debug rois

◆ nr5bits()

int nr5bits ( int  i)
static

helper function to "count" nr of set bits within lower 5 bits.

It does not need the class object, thus static.

too lazy to count the bits myself, thus using a small lookup table

Definition at line 1440 of file PXDUnpackerOldModule.cc.

1441{
1443 const int lut[32] = {
1444 0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4,
1445 1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5
1446 };
1447 return lut[i & 0x1F];
1448}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

Note
The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.
Parameters
nameThe name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

void setParamPython ( const std::string &  name,
const boost::python::object &  pyObj 
)
privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary)
privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

49{
50 if (!m_type.empty())
51 B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
52 m_type = type;
53}

◆ terminate()

void terminate ( void  )
finaloverrideprivatevirtual

Terminate the module.

Reimplemented from Module.

Definition at line 105 of file PXDUnpackerOldModule.cc.

106{
107 int flag = 0;
108 string errstr = "Statistic ( ;";
109 errstr += to_string(m_unpackedEventsCount) + ";";
110 for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) { errstr += to_string(m_errorCounter[i]) + ";"; flag |= m_errorCounter[i];}
111 if (flag != 0) {
112 B2RESULT("PXD Unpacker --> Error Statistics (counted once per event!) in Events: " << m_unpackedEventsCount);
113 B2RESULT(errstr + " )");
114 for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) {
115 if (m_errorCounter[i]) {
116 B2RESULT(getPXDBitErrorName(i) << ": " << m_errorCounter[i]);
117 }
118 }
119 } else {
120 B2RESULT("PXD Unpacker --> No Error found in Events: " << m_unpackedEventsCount);
121 }
122 B2RESULT("Statistic 2: !Accepted: " << m_notaccepted << " SendROIs: " << m_sendrois << " Unfiltered: " << m_sendunfiltered);
123}

◆ unpack_dhc_frame()

void unpack_dhc_frame ( void *  data,
const int  len,
const int  Frame_Number,
const int  Frames_in_event,
PXDDAQPacketStatus daqpktstat 
)
private

Unpack one frame (within an event).

Parameters
datapointer to frame
lenlength of frame
Frame_Numbercurrent frame number
Frames_in_eventnumber of frames in PxdRaw object (subevent)
daqpktstatDaq Packet Status Object

The following STATIC variables are used to save some state or count some things while depacking the frames. they are in most cases (re)set on the first frame or ONSEN trg frame Most could put in as a class member, but they are only needed within this function

We reset the counters on the first event

invalid

TODO here we should check full(!) Event Number, Run Number, Subrun Nr and Exp Number of this frame against the one from MEta Event Info

refering to BelleII Note Nr 0010, the numbers run from ... to unsigned int layer, ladder, sensor; layer= vxdid.getLayerNumber();/// 1 ... 2 ladder= vxdid.getLadderNumber();/// 1 ... 8 and 1 ... 12 sensor= vxdid.getSensorNumber();/// 1 ... 2 dhe_id = ((layer-1)<<5) | ((ladder)<<1) | (sensor-1);

Attention: Firmware might be changed such, that ghostframe come for all DHPs, not only active ones...

TODO how to handle error flags set in in DHC_END?

invalid

TODO how to handle error flags set in in DHE_END?

invalid

CRC is without the DHC header, see reason in function

Check that ONSEN Trg is first Frame

Check that there is no other DHC Start

Check that DHC Start is first Frame

Check that there is no other DHC Start

Check that DHC End is last Frame

As we now have processed the whole event, we can do some more consistency checks!

Check that there is no other DHC End

Check that (if there is at least one active DHE) the second Frame is DHE Start, actually this is redundant if the other checks work

Definition at line 662 of file PXDUnpackerOldModule.cc.

664{
668 static unsigned int eventNrOfOnsenTrgFrame = 0;
669 static int countedBytesInDHC = 0;
670 static bool cancheck_countedBytesInDHC = false;
671 static int countedBytesInDHE = 0;
672 static bool cancheck_countedBytesInDHE = false;
673 static int countedDHEStartFrames = 0;
674 static int countedDHEEndFrames = 0;
675 static int mask_active_dhe = 0;// DHE mask (5 bit)
676 static int nr_active_dhe =
677 0;// TODO just count the active DHEs. Until now, it is not possible to check for the bit mask. we would need the info on which DHE connects to which DHC at which port from gearbox/geometry?
678 static int mask_active_dhp = 0;// DHP active mask, 4 bit, per current DHE
679 static int found_mask_active_dhp = 0;// mask which DHP send data and check on DHE END frame if it matches
680 static unsigned int dhe_first_readout_frame_id_lo = 0;
681 // cppcheck-suppress variableScope
682 static unsigned int dhe_first_triggergate = 0;
683 static unsigned int currentDHCID = 0xFFFFFFFF;
684 static unsigned int currentDHEID = 0xFFFFFFFF;
685 static unsigned int currentVxdId = 0;
686 static bool isFakedData_event = false;
687 static bool isUnfiltered_event = false;
688
689
690 if (Frame_Number == 0) {
691 // We reset the counters on the first event
692 // we do this before any other check is done
693 eventNrOfOnsenTrgFrame = 0;
694 countedDHEStartFrames = 0;
695 countedDHEEndFrames = 0;
696 countedBytesInDHC = 0;
697 cancheck_countedBytesInDHC = false;
698 countedBytesInDHE = 0;
699 cancheck_countedBytesInDHE = false;
700 currentDHCID = 0xFFFFFFFF;
701 currentDHEID = 0xFFFFFFFF;
702 currentVxdId = 0;
703 isUnfiltered_event = false;
704 isFakedData_event = false;
705 mask_active_dhe = 0;
706 nr_active_dhe = 0;
707 mask_active_dhp = 0;
708 found_mask_active_dhp = 0;
709 }
710
712
713 dhc_frames dhc;
714 dhc.set(data, hw->getFrameType(), len);
715
716 {
717 // if a fixed size frame has a different length, how can we rely on its content???
718 // AND we could by typecasting access memory beyond end of data (but very unlikely)
719 // for that reason this we have to check before any CRC and stop unpacking the frame
720 int s = dhc.getFixedSize();
721 if (len != s && s != 0) {
722 if (!(m_suppressErrorMask[c_nrFIX_SIZE])) {
723 B2WARNING("Fixed frame type size does not match specs" << LogVar("expected length",
724 len) << LogVar("length in data", s));
725 }
726 m_errorMask[c_nrFIX_SIZE] = true;
727 if (!m_continueOnError) return;
728 }
729 }
730
731 // What do we do with wrong checksum frames? As we do not know WHAT is wrong, we have to skip them alltogether.
732 // As they might contain HEADER Info, we might better skip the processing of the full package, too.
733 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
734 if (!m_continueOnError && m_errorMask[c_nrDHE_CRC]) {
735 // if CRC is wrong, we cannot rely on the content of the frame, thus skipping is the best option
736 return;
737 }
738
739 unsigned int eventNrOfThisFrame = dhc.getEventNrLo();
740 int frame_type = dhc.getFrameType();
741
742 if (Frame_Number == 0) {
743 if (m_formatBonnDAQ) {
744 if (frame_type != EDHCFrameHeaderDataType::c_DHC_START) {
745 if (!(m_suppressErrorMask[c_nrEVENT_STRUCT])) B2WARNING("This looks not like BonnDAQ format.");
746 m_errorMask[c_nrEVENT_STRUCT] = true;
747// if (!m_continueOnError) return; // requires more testing
748 }
749 } else {
750 if (frame_type == EDHCFrameHeaderDataType::c_DHC_START) {
751 if (!(m_suppressErrorMask[c_nrEVENT_STRUCT]))
752 B2WARNING("This looks like BonnDAQ or old Desy 2013/14 testbeam format. Please use formatBonnDAQ or the pxdUnpackerDesy1314 module.");
753 m_errorMask[c_nrEVENT_STRUCT] = true;
754// if (!m_continueOnError) return; // requires more testing
755 }
756 }
757 }
758
759 if (!m_formatBonnDAQ) {
760 if (Frame_Number == 1) {
761 if (frame_type == EDHCFrameHeaderDataType::c_DHC_START) {
762 isFakedData_event = dhc.data_dhc_start_frame->isFakedData();
763 }
764 }
765
766 // please check if this mask is suitable. At least here we are limited by the 16 bit trigger number in the DHH packet header.
767 // we can use more bits in the DHC and DHE START Frame
768 if ((eventNrOfThisFrame & 0xFFFF) != (m_meta_event_nr & 0xFFFF)) {
769 if (!isFakedData_event) {
770 if (!(m_suppressErrorMask[c_nrMETA_MM])) {
771 B2WARNING("Event Numbers do not match for this frame");
772 B2DEBUG(29, "Event Numbers do not match for this frame" <<
773 LogVar("Event nr in frame $", static_cast < std::ostringstream
774 && >(std::ostringstream() << hex << eventNrOfThisFrame).str()) <<
775 LogVar("Event nr in MetaInfo (bits masked) $",
776 static_cast < std::ostringstream && >(std::ostringstream() << hex << m_meta_event_nr).str()));
777 }
778 m_errorMask[c_nrMETA_MM] = true;
779// if (!m_continueOnError) return; // requires more testing
780 }
781 }
782
783 if (Frame_Number > 1 && Frame_Number < Frames_in_event - 1) {
784 if (countedDHEStartFrames != countedDHEEndFrames + 1)
785 if (frame_type != EDHCFrameHeaderDataType::c_ONSEN_ROI && frame_type != EDHCFrameHeaderDataType::c_DHE_START) {
786 if (!(m_suppressErrorMask[c_nrDATA_OUTSIDE])) B2WARNING("Data Frame outside a DHE START/END");
787 m_errorMask[c_nrDATA_OUTSIDE] = true;
788// if (!m_continueOnError) return; // requires more testing
789 }
790 }
791 }
792
793 // TODO How do we handle Frames where Error Bit is set in header?
794 // Currently there is no documentation what it actually means... only an error bit is set (below)
795 // the following errors must be "accepted", as all firmware sets it wrong from Ghost frames.
796 if (hw->getErrorFlag()) {
797 if (frame_type != EDHCFrameHeaderDataType::c_GHOST) {
798 if (!(m_suppressErrorMask[c_nrHEADER_ERR])) B2ERROR("Error Bit set in DHE Header");
799 m_errorMask[c_nrHEADER_ERR] = true;// TODO this should have some effect ... when does it mean something? documentation missing
800 }
801 } else {
802 if (frame_type == EDHCFrameHeaderDataType::c_GHOST) {
803 m_errorMask[c_nrHEADER_ERR_GHOST] = true;
804 }
805 }
806
807 switch (frame_type) {
808 case EDHCFrameHeaderDataType::c_DHP_RAW: {
809
811 if (currentDHEID != dhc.data_direct_readout_frame_raw->getDHEId()) {
812 if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
813 B2WARNING("DHE ID from DHE Start and this frame do not match");
814 B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
815 LogVar("DHEID in this frame $", static_cast < std::ostringstream
816 && >(std::ostringstream() << hex << dhc.data_direct_readout_frame_raw->getDHEId()).str()) <<
817 LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
818 }
819 m_errorMask[c_nrDHE_START_ID] = true;
820 }
821 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
822 found_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();
823
824 unpack_dhp_raw(data, len - 4,
827 currentVxdId);
828
829 break;
830 };
831 case EDHCFrameHeaderDataType::c_ONSEN_DHP:
832 // Set the counted size invalid if negativ, needs a large negative value because we are adding up to that
833 cancheck_countedBytesInDHC = false;
834 cancheck_countedBytesInDHE = false;
835 [[fallthrough]];
836 case EDHCFrameHeaderDataType::c_DHP_ZSD: {
837
839 if (isUnfiltered_event) {
840 if (frame_type == EDHCFrameHeaderDataType::c_ONSEN_DHP) m_errorMask[c_nrSENDALL_TYPE] = true;
841 } else {
842 if (frame_type == EDHCFrameHeaderDataType::c_DHP_ZSD) m_errorMask[c_nrNOTSENDALL_TYPE] = true;
843 }
844
845 //m_errorMask |= dhc.data_direct_readout_frame->check_error();
846
847 if (currentDHEID != dhc.data_direct_readout_frame_raw->getDHEId()) {
848 if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
849 B2WARNING("DHE ID from DHE Start and this frame do not match");
850 B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
851 LogVar("DHEID in this frame $", static_cast < std::ostringstream
852 && >(std::ostringstream() << hex << dhc.data_direct_readout_frame_raw->getDHEId()).str()) <<
853 LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
854 }
855 m_errorMask[c_nrDHE_START_ID] = true;
856 }
857 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
858 found_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();
859 if (m_checkPaddingCRC) dhc.check_padding(m_errorMask); // isUnfiltered_event
860
861
862 unpack_dhp(data, len - 4,
863 dhe_first_readout_frame_id_lo,
867 currentVxdId, daqpktstat);
868
869 break;
870 };
871 case EDHCFrameHeaderDataType::c_ONSEN_FCE:
872 // Set the counted size invalid if negativ, needs a large negative value because we are adding up to that
873 cancheck_countedBytesInDHC = false;
874 cancheck_countedBytesInDHE = false;
875 [[fallthrough]];
876 case EDHCFrameHeaderDataType::c_FCE_RAW: {
877 if (!(m_suppressErrorMask[c_nrUNEXPECTED_FRAME_TYPE])) B2WARNING("Unexpected Frame Type (Clustering FCE)");
878 m_errorMask[c_nrUNEXPECTED_FRAME_TYPE] = true;
879 if (m_verbose) hw->print();
880 if (isUnfiltered_event) {
881 if (frame_type == EDHCFrameHeaderDataType::c_ONSEN_FCE) {
882 // TODO add error message
883 m_errorMask[c_nrSENDALL_TYPE] = true;
884 }
885 } else {
886 if (frame_type == EDHCFrameHeaderDataType::c_FCE_RAW) {
887 // TODO add error message
888 m_errorMask[c_nrNOTSENDALL_TYPE] = true;
889 }
890 }
891
892 if (currentDHEID != dhc.data_direct_readout_frame_raw->getDHEId()) {
893 if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
894 B2WARNING("DHE ID from DHE Start and this frame do not match");
895 B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
896 LogVar("DHEID in this frame $", static_cast < std::ostringstream
897 && >(std::ostringstream() << hex << dhc.data_direct_readout_frame_raw->getDHEId()).str()) <<
898 LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
899 }
900 m_errorMask[c_nrDHE_START_ID] = true;
901 }
902 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
903 found_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();
904
905 B2DEBUG(29, "UNPACK FCE FRAME with len $" << hex << len);
906 unpack_fce((unsigned short*) data, len - 4, currentVxdId);
907
908 break;
909 };
910 case EDHCFrameHeaderDataType::c_COMMODE: {
911 // this frame type has up to now not been well defined, we do not expect it until
912 // the firmware supports clustering in hardware
913 if (!(m_suppressErrorMask[c_nrUNEXPECTED_FRAME_TYPE])) B2WARNING("Unexpected Frame Type (COMMODE)");
914 m_errorMask[c_nrUNEXPECTED_FRAME_TYPE] = true;
915
916 if (m_verbose) hw->print();
917 if (currentDHEID != dhc.data_commode_frame->getDHEId()) {
918 if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
919 B2WARNING("DHE ID from DHE Start and this frame do not match");
920 B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
921 LogVar("DHEID in this frame $", static_cast < std::ostringstream
922 && >(std::ostringstream() << hex << dhc.data_commode_frame->getDHEId()).str()) <<
923 LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
924 }
925 m_errorMask[c_nrDHE_START_ID] = true;
926 }
927 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
928 break;
929 };
930 case EDHCFrameHeaderDataType::c_DHC_START: {
931 countedBytesInDHC = 0;
932 cancheck_countedBytesInDHC = true;
933 if (isFakedData_event != dhc.data_dhc_start_frame->isFakedData()) {
934 if (!(m_suppressErrorMask[c_nrFAKE_NO_FAKE_DATA])) B2WARNING("DHC START mixed Fake/no Fake event.");
935 m_errorMask[c_nrFAKE_NO_FAKE_DATA] = true;
936 }
938 if (!(m_suppressErrorMask[c_nrFAKE_NO_DATA_TRIG])) B2WARNING("Faked DHC START Data -> trigger without Data!");
939 m_errorMask[c_nrFAKE_NO_DATA_TRIG] = true;
940 } else {
942 }
943
944// eventNrOfOnsenTrgFrame = eventNrOfThisFrame;
945 currentDHEID = 0xFFFFFFFF;
946 currentVxdId = 0;
947 currentDHCID = dhc.data_dhc_start_frame->get_dhc_id();
948 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
949
950 if (m_formatBonnDAQ) eventNrOfOnsenTrgFrame = eventNrOfThisFrame;
951
952 if (!isFakedData_event) {
956 if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_ERS])) {
957 B2WARNING("DHC-Meta Experiment number mismatch");
958 B2DEBUG(29, "DHC-Meta Experiment number mismatch" <<
959 LogVar("DHC exp nr",
961 LogVar("META exp nr", m_meta_experiment));
962 }
963 m_errorMask[c_nrMETA_MM_DHC_ERS] = true;
964 }
966 if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_ERS])) {
967 B2WARNING("DHC-Meta Run number mismatch");
968 B2DEBUG(29, "DHC-Meta Run number mismatch" <<
969 LogVar("DHC Run nr",
971 LogVar("META run nr", m_meta_run_nr));
972 }
973 m_errorMask[c_nrMETA_MM_DHC_ERS] = true;
974 }
976 if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_ERS])) {
977 B2WARNING("DHC-Meta Sub-Run number mismatch");
978 B2DEBUG(29, "DHC-Meta Sub-Run number mismatch" <<
979 LogVar("DHC subrun nr",
981 LogVar("META subrun nr", m_meta_subrun_nr));
982 }
983 m_errorMask[c_nrMETA_MM_DHC_ERS] = true;
984 }
985 if ((((unsigned int)dhc.data_dhc_start_frame->getEventNrHi() << 16) | dhc.data_dhc_start_frame->getEventNrLo()) !=
986 (m_meta_event_nr & 0xFFFFFFFF)) {
987 if (!(m_suppressErrorMask[c_nrMETA_MM_DHC])) {
988 B2WARNING("DHC-Meta 32 bit event number mismatch");
989 B2DEBUG(29, "DHC-Meta 32 bit event number mismatch" <<
990 LogVar("DHC trigger nr", (((unsigned int) dhc.data_dhc_start_frame->getEventNrHi() << 16) |
992 LogVar("META trigger nr", (unsigned int)(m_meta_event_nr & 0xFFFFFFFF)));
993 }
994 m_errorMask[c_nrMETA_MM_DHC] = true;
995 }
996 uint32_t trig_ticks = (((unsigned int)dhc.data_dhc_start_frame->time_tag_mid & 0x7FFF) << 12) | ((unsigned int)
998 uint32_t trig_sec = (dhc.data_dhc_start_frame->time_tag_hi * 2) ;
999 if (dhc.data_dhc_start_frame->time_tag_mid & 0x8000) trig_sec++;
1000
1001 if ((trig_ticks - m_meta_ticks) != 0 || (trig_sec - m_meta_sec) != 0) {
1002 m_errorMask[c_nrMETA_MM_DHC_TT] = true;
1003 if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_TT])) {
1004 B2WARNING("DHC-Meta TimeTag mismatch");
1005 B2DEBUG(29, "DHC-Meta TimeTag mismatch" <<
1006 LogVar("Header Time $", static_cast < std::ostringstream && >(std::ostringstream() <<
1007 hex << dhc.data_dhc_start_frame->time_tag_hi << "." <<
1008 dhc.data_dhc_start_frame->time_tag_mid << "." <<
1010 LogVar("Meta Time $", static_cast < std::ostringstream && >(std::ostringstream() << hex << m_meta_time).str()) <<
1011 LogVar("Trigger Type", static_cast < std::ostringstream
1012 && >(std::ostringstream() << hex << (dhc.data_dhc_start_frame->time_tag_lo_and_type & 0xF)).str()) <<
1013 LogVar("Meta seconds: $", static_cast < std::ostringstream && >(std::ostringstream() << hex << m_meta_sec).str()) <<
1014 LogVar("DHC seconds $", static_cast < std::ostringstream && >(std::ostringstream() << hex << trig_sec).str()) <<
1015 LogVar("Seconds difference $", static_cast < std::ostringstream
1016 && >(std::ostringstream() << hex << (trig_sec - m_meta_sec)).str()) <<
1017 LogVar("Meta ticks from 127MHz $", static_cast < std::ostringstream && >(std::ostringstream() << hex << m_meta_ticks).str()) <<
1018 LogVar("DHC ticks from 127MHz $", static_cast < std::ostringstream && >(std::ostringstream() << hex << trig_ticks).str()) <<
1019 LogVar("Tick difference $", static_cast < std::ostringstream
1020 && >(std::ostringstream() << hex << (trig_ticks - m_meta_ticks)).str()));
1021 }
1022 } else {
1023 B2DEBUG(29, "DHC TT: $" << hex << dhc.data_dhc_start_frame->time_tag_hi << "." << dhc.data_dhc_start_frame->time_tag_mid << "." <<
1024 dhc.data_dhc_start_frame->time_tag_lo_and_type << " META " << m_meta_time << " TRG Type " <<
1026 }
1027 }
1028 mask_active_dhe = dhc.data_dhc_start_frame->get_active_dhe_mask();
1029 nr_active_dhe = nr5bits(mask_active_dhe);
1030
1031 m_errorMaskDHC = m_errorMask; // forget about anything before this frame
1032 daqpktstat.newDHC(currentDHCID, m_errorMask);
1035
1036 break;
1037 };
1038 case EDHCFrameHeaderDataType::c_DHE_START: {
1039 countedBytesInDHE = 0;
1040 cancheck_countedBytesInDHE = true;
1046 dhe_first_readout_frame_id_lo = dhc.data_dhe_start_frame->getStartFrameNr();
1047 dhe_first_triggergate = dhc.data_dhe_start_frame->getTriggerGate();
1048 if (currentDHEID != 0xFFFFFFFF && (currentDHEID & 0xFFFF) >= dhc.data_dhe_start_frame->getDHEId()) {
1049 if (!(m_suppressErrorMask[c_nrDHE_WRONG_ID_SEQ])) {
1050 B2WARNING("DHH IDs are not in expected order");
1051 B2DEBUG(29, "DHH IDs are not in expected order" <<
1052 LogVar("Previous ID", (currentDHEID & 0xFFFF)) <<
1053 LogVar("Current ID", dhc.data_dhe_start_frame->getDHEId()));
1054 }
1055 m_errorMask[c_nrDHE_WRONG_ID_SEQ] = true;
1056 }
1057 currentDHEID = dhc.data_dhe_start_frame->getDHEId();
1058 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
1059
1060 if (countedDHEStartFrames > countedDHEEndFrames) {
1061 if (!(m_suppressErrorMask[c_nrDHE_START_WO_END])) B2WARNING("DHE_START without DHE_END");
1062 m_errorMask[c_nrDHE_START_WO_END] = true;
1063 }
1064 countedDHEStartFrames++;
1065
1066 found_mask_active_dhp = 0;
1067 mask_active_dhp = dhc.data_dhe_start_frame->getActiveDHPMask();
1068
1069 if ((((unsigned int)dhc.data_dhe_start_frame->getEventNrHi() << 16) | dhc.data_dhe_start_frame->getEventNrLo()) != (unsigned int)(
1070 m_meta_event_nr & 0xFFFFFFFF)) {
1071 if (!(m_suppressErrorMask[c_nrMETA_MM_DHE])) {
1072 B2WARNING("DHE START trigger mismatch in EVT32b/HI WORD");
1073 B2DEBUG(29, "DHE START trigger mismatch in EVT32b/HI WORD" <<
1074 LogVar("DHE Start trigger nr", (dhc.data_dhe_start_frame->getEventNrHi() << 16) | dhc.data_dhe_start_frame->getEventNrLo()) <<
1075 LogVar("Meta trigger nr", (m_meta_event_nr & 0xFFFFFFFF)));
1076 }
1077 m_errorMask[c_nrMETA_MM_DHE] = true;
1078 }
1079// B2WARNING("DHE TT: $" << hex << dhc.data_dhe_start_frame->dhe_time_tag_hi << "." << dhc.data_dhe_start_frame->dhe_time_tag_lo <<
1080// " META " << m_meta_time);
1081
1082 if (currentDHEID == 0) {
1083 if (!(m_suppressErrorMask[c_nrDHE_ID_INVALID])) B2WARNING("DHE ID is invalid=0 (not initialized)");
1084 m_errorMask[c_nrDHE_ID_INVALID] = true;
1085 }
1086 // calculate the VXDID for DHE and save them for DHP unpacking
1087 {
1094 unsigned short sensor, ladder, layer;
1095 sensor = (currentDHEID & 0x1) + 1;
1096 ladder = (currentDHEID & 0x1E) >> 1; // no +1
1097 layer = ((currentDHEID & 0x20) >> 5) + 1;
1098 currentVxdId = VxdID(layer, ladder, sensor);
1099 if (ladder == 0 || (layer == 1 && ladder > 8) || (layer == 2 && ladder > 12)) {
1100 if (!(m_suppressErrorMask[c_nrDHE_ID_INVALID])) {
1101 B2WARNING("DHE ID is invalid");
1102 B2DEBUG(29, "DHE ID is invalid" <<
1103 LogVar("DHE ID", currentDHEID) <<
1104 LogVar("Layer", layer) <<
1105 LogVar("Ladder", ladder) <<
1106 LogVar("Sensor", sensor));
1107 }
1108 m_errorMask[c_nrDHE_ID_INVALID] = true;
1109 }
1110 }
1111
1112 m_errorMaskDHE = m_errorMask; // forget about anything before this frame
1113 if (daqpktstat.dhc_size() > 0) {
1114 // if no DHC has been defined yet, do nothing!
1115 daqpktstat.dhc_back().newDHE(currentVxdId, currentDHEID, m_errorMask, dhe_first_triggergate, dhe_first_readout_frame_id_lo);
1116 }
1117 break;
1118 };
1119 case EDHCFrameHeaderDataType::c_GHOST:
1120 if (m_verbose) dhc.data_ghost_frame->print();
1121 if (currentDHEID != dhc.data_ghost_frame->getDHEId()) {
1122 if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
1123 B2WARNING("DHE ID from DHE Start and this frame do not match");
1124 B2DEBUG(29, "Start ID $" << hex << currentDHEID << " != $" << dhc.data_ghost_frame->getDHEId());
1125 }
1126 m_errorMask[c_nrDHE_START_ID] = true;
1127 }
1129 found_mask_active_dhp |= 1 << dhc.data_ghost_frame->getDHPPort();
1130
1131 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
1132
1133 break;
1134 case EDHCFrameHeaderDataType::c_DHC_END: {
1135 if (dhc.data_dhc_end_frame->isFakedData() != isFakedData_event) {
1136 if (!(m_suppressErrorMask[c_nrFAKE_NO_FAKE_DATA])) B2WARNING("DHC END mixed Fake/no Fake event.");
1137 m_errorMask[c_nrFAKE_NO_FAKE_DATA] = true;
1138 }
1139 if (dhc.data_dhc_end_frame->isFakedData()) {
1140 if (!(m_suppressErrorMask[c_nrFAKE_NO_DATA_TRIG])) B2WARNING("Faked DHC END Data -> trigger without Data!");
1141 m_errorMask[c_nrFAKE_NO_DATA_TRIG] = true;
1142 } else {
1144 }
1145
1146 if (!isFakedData_event) {
1147 if (dhc.data_dhc_end_frame->get_dhc_id() != currentDHCID) {
1148 if (!(m_suppressErrorMask[c_nrDHC_DHCID_START_END_MM])) {
1149 B2WARNING("DHC ID Mismatch between Start and End");
1150 B2DEBUG(29, "DHC ID Mismatch between Start and End $" << std::hex <<
1151 currentDHCID << "!=$" << dhc.data_dhc_end_frame->get_dhc_id());
1152 }
1153 m_errorMask[c_nrDHC_DHCID_START_END_MM] = true;
1154 }
1155 int w;
1156 w = dhc.data_dhc_end_frame->get_words() * 4;
1157 if (cancheck_countedBytesInDHC) {
1158 if (countedBytesInDHC != w) {
1159 if (!(m_suppressErrorMask[c_nrDHC_WIE])) {
1160 B2WARNING("Number of Words in DHC END does not match");
1161 B2DEBUG(29, "Number of Words in DHC END does not match: WIE $" << hex << countedBytesInDHC << " != DHC END $" << hex << w);
1162 }
1163 m_errorMask[c_nrDHC_WIE] = true;
1164 } else {
1165 if (m_verbose)
1166 B2DEBUG(29, "EVT END: WIE $" << hex << countedBytesInDHC << " == DHC END $" << hex << w);
1167 }
1168 // else ... processed data -> length invalid
1169 }
1170 }
1172 if (dhc.data_dhc_end_frame->getErrorInfo() != 0) {
1173 if (!(m_suppressErrorMask[c_nrDHH_END_ERRORBITS])) B2ERROR("DHC END Error Info set to $" << hex <<
1175 m_errorMask[c_nrDHH_END_ERRORBITS] = true;
1176 }
1177 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
1178 m_errorMaskDHC |= m_errorMask; // do latest updates
1179
1180 if (daqpktstat.dhc_size() > 0) {
1181 // only is we have a DHC object... or back() is undefined
1182 // Remark, if we have a broken data (DHC_START/END) structure, we might fill the
1183 // previous DHC object ... but then the data is junk anyway
1184 daqpktstat.dhc_back().setErrorMask(m_errorMaskDHC);
1185 //B2DEBUG(98,"** DHC "<<currentDHCID<<" Raw"<<dhc.data_dhc_end_frame->get_words() * 4 <<" Red"<<countedBytesInDHC);
1186 daqpktstat.dhc_back().setCounters(dhc.data_dhc_end_frame->get_words() * 4, countedBytesInDHC);
1188 }
1189 m_errorMaskDHC = 0;
1190 currentDHEID = 0xFFFFFFFF;
1191 currentDHCID = 0xFFFFFFFF;
1192 currentVxdId = 0;
1193 break;
1194 };
1195 case EDHCFrameHeaderDataType::c_DHE_END: {
1197 if (currentDHEID != dhc.data_dhe_end_frame->getDHEId()) {
1198 if (!(m_suppressErrorMask[c_nrDHE_START_END_ID])) {
1199 B2WARNING("DHE ID from DHE Start and this frame do not match");
1200 B2DEBUG(29, "DHE ID from DHE Start and this frame do not match $" << hex << currentDHEID << " != $" <<
1202 }
1203 m_errorMask[c_nrDHE_START_END_ID] = true;
1204 }
1206 if (dhc.data_dhe_end_frame->getErrorInfo() != 0) {
1207 if (!(m_suppressErrorMask[c_nrDHH_END_ERRORBITS])) {
1208 B2ERROR("DHE END Error Info set to $" << hex <<
1210 }
1211 m_errorMask[c_nrDHH_END_ERRORBITS] = true;
1212 }
1213 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
1214 if (found_mask_active_dhp != mask_active_dhp) {
1215 if (!(m_suppressErrorMask[c_nrDHP_ACTIVE])) {
1216 B2WARNING("DHE_END: DHP active mask differs from found data");
1217 B2DEBUG(29, "DHE_END: DHP active mask differs from found data $" << hex << mask_active_dhp << " != $" << hex <<
1218 found_mask_active_dhp
1219 << " mask of found dhp/ghost frames");
1220 }
1221 m_errorMask[c_nrDHP_ACTIVE] = true;
1222 }
1223 countedDHEEndFrames++;
1224 if (countedDHEStartFrames < countedDHEEndFrames) {
1225 // the other case is checked in Start
1226 if (!(m_suppressErrorMask[c_nrDHE_END_WO_START])) B2WARNING("DHE_END without DHE_START");
1227 m_errorMask[c_nrDHE_END_WO_START] = true;
1228 }
1229 {
1230 int w;
1231 w = dhc.data_dhe_end_frame->get_words() * 2;
1232 if (cancheck_countedBytesInDHE) {
1233 if (countedBytesInDHE != w) {
1234 if (!(m_suppressErrorMask[c_nrDHE_WIE])) {
1235 B2WARNING("Number of Words in DHE END does not match");
1236 B2DEBUG(29, "Number of Words in DHE END does not match: WIE $" << hex << countedBytesInDHE << " != DHE END $" << hex << w);
1237 }
1238 m_errorMask[c_nrDHE_WIE] = true;
1239 } else {
1240 if (m_verbose)
1241 B2DEBUG(29, "EVT END: WIE $" << hex << countedBytesInDHE << " == DHE END $" << hex << w);
1242 }
1243 // else ... processed data -> length invalid
1244 }
1245 }
1246 m_errorMaskDHE |= m_errorMask; // do latest updates
1247
1248 if (daqpktstat.dhc_size() > 0) {
1249 if (daqpktstat.dhc_back().dhe_size() > 0) {
1250 // only is we have a DHC and DHE object... or back() is undefined
1251 // Remark, if we have a broken data (DHE_START/END) structure, we might fill the
1252 // previous DHE object ... but then the data is junk anyway
1254 // B2DEBUG(98,"** DHC "<<currentDHEID<<" Raw "<<dhc.data_dhe_end_frame->get_words() * 2 <<" Red"<<countedBytesInDHE);
1255 daqpktstat.dhc_back().dhe_back().setCounters(dhc.data_dhe_end_frame->get_words() * 2, countedBytesInDHE);
1257 }
1258 }
1259 m_errorMaskDHE = 0;
1260 currentDHEID |= 0xFF000000;// differenciate from 0xFFFFFFFFF as initial value
1261 currentVxdId = 0;
1262 break;
1263 };
1264 case EDHCFrameHeaderDataType::c_ONSEN_ROI:
1266 dhc.data_onsen_roi_frame->check_error(m_errorMask, len, m_suppressErrorMask[c_nrROI_PACKET_INV_SIZE]);
1268 len - 4);
1269 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
1270 if (!m_doNotStore) {
1271 //dhc.data_onsen_roi_frame->save(m_storeROIs, len, (unsigned int*) data);
1272 // void save(StoreArray<PXDRawROIs>& sa, unsigned int length, unsigned int* data) const
1273 // 4 byte header, ROIS (n*8), 4 byte copy of inner CRC, 4 byte outer CRC
1274 if (len >= dhc.data_onsen_roi_frame->getMinSize()) {
1275 //if ((len - dhc.data_onsen_roi_frame->getMinSize()) % 8 != 0) {
1276 // error checking in check_error() above, this is only for dump-ing
1277 // dump_roi(data, len - 4); // dump ROI payload, minus CRC
1278 //}
1279 unsigned int l;
1280 l = (len - dhc.data_onsen_roi_frame->getMinSize()) / 8;
1281 // Endian swapping is done in Contructor of RawRoi object
1282 m_storeROIs.appendNew(l, &((unsigned int*) data)[1]);
1283 }
1284 }
1285 break;
1286 case EDHCFrameHeaderDataType::c_ONSEN_TRG:
1287 eventNrOfOnsenTrgFrame = eventNrOfThisFrame;
1288 if (dhc.data_onsen_trigger_frame->get_trig_nr1() != (unsigned int)(m_meta_event_nr & 0xFFFFFFFF)) {
1289 if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_HLT])) {
1290 B2WARNING("Trigger Frame HLT Trigger Nr mismatch");
1291 B2DEBUG(29, "Trigger Frame HLT Trigger Nr mismatch: HLT $" <<
1292 dhc.data_onsen_trigger_frame->get_trig_nr1() << " META " << (m_meta_event_nr & 0xFFFFFFFF));
1293 }
1294 m_errorMask[c_nrMETA_MM_ONS_HLT] = true;
1295 }
1299 if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_HLT])) {
1300 B2WARNING("Trigger Frame HLT Exp/Run/Subrun Nr mismatch");
1301 B2DEBUG(29, "Trigger Frame HLT Exp/Run/Subrun Nr mismatch: Exp HLT $" <<
1303 " Run HLT $" << dhc.data_onsen_trigger_frame->get_run1() << " META " << m_meta_run_nr <<
1304 " Subrun HLT $" << dhc.data_onsen_trigger_frame->get_subrun1() << " META " << m_meta_subrun_nr);
1305 }
1306 m_errorMask[c_nrMETA_MM_ONS_HLT] = true;
1307 }
1308
1310 if (dhc.data_onsen_trigger_frame->get_trig_nr2() != (unsigned int)(m_meta_event_nr & 0xFFFFFFFF)) {
1311 if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_DC])) {
1312 B2WARNING("Trigger Frame DATCON Trigger Nr mismatch");
1313 B2DEBUG(29, "Trigger Frame DATCON Trigger Nr mismatch: DC $" <<
1314 dhc.data_onsen_trigger_frame->get_trig_nr2() << " META " << (m_meta_event_nr & 0xFFFFFFFF));
1315 }
1316 m_errorMask[c_nrMETA_MM_ONS_DC] = true;
1317 }
1321 if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_DC])) {
1322 B2WARNING("Trigger Frame DATCON Exp/Run/Subrun Nr mismatch");
1323 B2DEBUG(29, "Trigger Frame DATCON Exp/Run/Subrun Nr mismatch: Exp DC $" <<
1325 " Run DC $" << dhc.data_onsen_trigger_frame->get_run2() << " META " << m_meta_run_nr <<
1326 " Subrun DC $" << dhc.data_onsen_trigger_frame->get_subrun2() << " META " << m_meta_subrun_nr);
1327 }
1328 m_errorMask[c_nrMETA_MM_ONS_DC] = true;
1329 }
1330 }
1331
1332// B2WARNING("TRG TAG HLT: $" << hex << dhc.data_onsen_trigger_frame->get_trig_tag1() << " DATCON $" << dhc.data_onsen_trigger_frame->get_trig_tag2() << " META " << m_meta_time);
1333
1336 m_suppressErrorMask[c_nrHLTROI_MAGIC],
1337 m_suppressErrorMask[c_nrMERGER_TRIGNR]);
1338 dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
1339 if (Frame_Number != 0) {
1340 if (!(m_suppressErrorMask[c_nrEVENT_STRUCT])) B2WARNING("ONSEN TRG Frame must be the first one.");
1341 m_errorMask[c_nrEVENT_STRUCT] = true;
1342 }
1343 isUnfiltered_event = dhc.data_onsen_trigger_frame->is_SendUnfiltered();
1344 if (isUnfiltered_event) m_sendunfiltered++;
1347 break;
1348 default:
1349 if (!(m_suppressErrorMask[c_nrDHC_UNKNOWN])) B2WARNING("UNKNOWN DHC frame type");
1350 m_errorMask[c_nrDHC_UNKNOWN] = true;
1351 if (m_verbose) hw->print();
1352 break;
1353 }
1354
1355 if (eventNrOfThisFrame != eventNrOfOnsenTrgFrame && !isFakedData_event) {
1356 if (!(m_suppressErrorMask[c_nrFRAME_TNR_MM])) {
1357 B2WARNING("Frame TrigNr != ONSEN Trig Nr");
1358 B2DEBUG(29, "Frame TrigNr != ONSEN Trig Nr $" << hex << eventNrOfThisFrame << " != $" << eventNrOfOnsenTrgFrame);
1359 }
1360 m_errorMask[c_nrFRAME_TNR_MM] = true;
1361 }
1362
1363 if (Frame_Number == 0) {
1365 if (frame_type != EDHCFrameHeaderDataType::c_ONSEN_TRG) {
1366 if (!m_formatBonnDAQ) {
1367 if (!(m_suppressErrorMask[c_nrONSEN_TRG_FIRST])) B2WARNING("First frame is not a ONSEN Trigger frame");
1368 m_errorMask[c_nrONSEN_TRG_FIRST] = true;
1369 }
1370 }
1371 } else { // (Frame_Number != 0 &&
1373 if (frame_type == EDHCFrameHeaderDataType::c_ONSEN_TRG) {
1374 if (!(m_suppressErrorMask[c_nrONSEN_TRG_FIRST])) B2WARNING("More than one ONSEN Trigger frame");
1375 m_errorMask[c_nrONSEN_TRG_FIRST] = true;
1376 }
1377 }
1378
1379 if (!m_formatBonnDAQ) {
1380 if (Frame_Number == 1) {
1382 if (frame_type != EDHCFrameHeaderDataType::c_DHC_START) {
1383 if (!(m_suppressErrorMask[c_nrDHC_START_SECOND])) B2WARNING("Second frame is not a DHC start of subevent frame");
1384 m_errorMask[c_nrDHC_START_SECOND] = true;
1385 }
1386 } else { // (Frame_Number != 0 &&
1388 if (frame_type == EDHCFrameHeaderDataType::c_DHC_START) {
1389 if (!(m_suppressErrorMask[c_nrDHC_START_SECOND])) B2WARNING("More than one DHC start of subevent frame");
1390 m_errorMask[c_nrDHC_START_SECOND] = true;
1391 }
1392 }
1393 }
1394
1395 if (Frame_Number == Frames_in_event - 1) {
1397 if (frame_type != EDHCFrameHeaderDataType::c_DHC_END) {
1398 if (!(m_suppressErrorMask[c_nrDHC_END_MISS])) B2WARNING("Last frame is not a DHC end of subevent frame");
1399 m_errorMask[c_nrDHC_END_MISS] = true;
1400 }
1401
1403 if (countedDHEStartFrames != countedDHEEndFrames || countedDHEStartFrames != nr_active_dhe) {
1404 if (!(m_suppressErrorMask[c_nrDHE_ACTIVE]) || !(m_suppressErrorMask[c_nrDHE_START_WO_END])
1405 || !(m_suppressErrorMask[c_nrDHE_END_WO_START])) {
1406 B2WARNING("The number of DHE Start/End does not match the number of active DHE in DHC Header!");
1407 B2DEBUG(29, "The number of DHE Start/End does not match the number of active DHE in DHC Header! Header: " << nr_active_dhe <<
1408 " Start: " << countedDHEStartFrames << " End: " << countedDHEEndFrames << " Mask: $" << hex << mask_active_dhe << " in Event Nr " <<
1409 eventNrOfThisFrame);
1410 }
1411 if (countedDHEStartFrames == countedDHEEndFrames) m_errorMask[c_nrDHE_ACTIVE] = true;
1412 if (countedDHEStartFrames > countedDHEEndFrames) m_errorMask[c_nrDHE_START_WO_END] = true;
1413 if (countedDHEStartFrames < countedDHEEndFrames) m_errorMask[c_nrDHE_END_WO_START] = true;
1414 }
1415
1416 } else { // (Frame_Number != Frames_in_event - 1 &&
1418 if (frame_type == EDHCFrameHeaderDataType::c_DHC_END) {
1419 if (!(m_suppressErrorMask[c_nrDHC_END_DBL])) B2WARNING("More than one DHC end of subevent frame");
1420 m_errorMask[c_nrDHC_END_DBL] = true;
1421 }
1422 }
1423
1424 if (!m_formatBonnDAQ) {
1426 if (Frame_Number == 2 && nr_active_dhe != 0 && frame_type != EDHCFrameHeaderDataType::c_DHE_START) {
1427 if (!(m_suppressErrorMask[c_nrDHE_START_THIRD])) B2WARNING("Third frame is not a DHE start frame");
1428 m_errorMask[c_nrDHE_START_THIRD] = true;
1429 }
1430 }
1431
1432 if (frame_type != EDHCFrameHeaderDataType::c_ONSEN_ROI && frame_type != EDHCFrameHeaderDataType::c_ONSEN_TRG) {
1433 // actually, they should not be withing Start and End, but better be sure.
1434 countedBytesInDHC += len;
1435 countedBytesInDHE += len;
1436 }
1437 B2DEBUG(29, "DHC/DHE $" << hex << countedBytesInDHC << ", $" << hex << countedBytesInDHE);
1438}
void setErrorMask(const PXDErrorFlags &mask)
Set Error bit mask This should be the OR of error masks of all sub-objects (DHC, DHE)
void setGatedFlag(bool gm)
set gating info from the DHC END
PXDDAQDHEStatus & newDHE(Args &&... params)
Add new DHE information.
void setGatedHER(bool isher)
set HER/LER gating info from the DHC END
PXDDAQDHEStatus & dhe_back()
Returns PXDDAQDHEStatus for last DHE.
void setEndErrorInfo(uint32_t e)
set errorinfo from the DHC END
size_t dhe_size() const
Returns number of DHEs.
void setCounters(uint32_t raw, uint32_t red)
Set Data counters for reduction calculation.
void setErrorMask(const PXDErrorFlags &mask)
Set Error bit mask.
void setEndErrorInfo(uint32_t e)
set erroinfo from the DHE END
void setCounters(uint32_t raw, uint32_t red)
Set Data counters for reduction calculation.
size_t dhc_size() const
Returns number of DHCs.
PXDDAQDHCStatus & dhc_back()
Returns PXDDAQDHCStatus for last DHC.
PXDDAQDHCStatus & newDHC(Args &&... params)
Add new DHC information.
PXDError::PXDErrorFlags m_errorMaskDHC
Error Mask set per packet / DHC.
void unpack_dhp(void *data, unsigned int len, unsigned int dhe_first_readout_frame_lo, unsigned int dhe_ID, unsigned dhe_DHPport, unsigned dhe_reformat, VxdID vxd_id, PXDDAQPacketStatus &daqpktstat)
Unpack DHP data within one DHE frame.
int m_last_dhp_readout_frame_lo[4]
some workaround check for continouous frame ids
static int nr5bits(int i)
helper function to "count" nr of set bits within lower 5 bits.
void unpack_fce(unsigned short *data, unsigned int length, VxdID vxd_id)
Unpack DHP/FCE data within one DHE frame Not fully implemented as cluster format not 100% fixed.
void unpack_dhp_raw(void *data, unsigned int len, unsigned int dhe_ID, unsigned dhe_DHPport, VxdID vxd_id)
Unpack DHP RAW data within one DHE frame (pedestals, etc)
PXDError::PXDErrorFlags m_errorMaskDHE
Error Mask set per packet / DHE.
DHC frame wrapper class.
const dhc_ghost_frame * data_ghost_frame
data_ghost_frame
unsigned int getEventNrLo(void) const
get event nr lo (from data)
const dhc_end_frame * data_dhc_end_frame
data_dhc_end_frame
unsigned int getFixedSize(void)
get fixed size
int getFrameType(void)
get type of frame
const dhc_dhe_start_frame * data_dhe_start_frame
data_dhe_start_frame
void set(const void *d, unsigned int t)
set data and type (and length to 0)
const dhc_start_frame * data_dhc_start_frame
data_dhc_start_frame
const dhc_direct_readout_frame * data_direct_readout_frame
data_direct_readout_frame
const dhc_dhe_end_frame * data_dhe_end_frame
data_dhe_end_frame
void check_padding(PXDErrorFlags &errormask)
check padding and return it
const dhc_onsen_roi_frame * data_onsen_roi_frame
data_onsen_roi_frame
const dhc_direct_readout_frame_raw * data_direct_readout_frame_raw
data_direct_readout_frame_raw
const dhc_commode_frame * data_commode_frame
data_commode_frame
void check_crc(PXDErrorFlags &errormask, bool ignore_crc_flag=false)
check crc and return it
const dhc_onsen_trigger_frame * data_onsen_trigger_frame
data_onsen_trigger_frame
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:33
unsigned int getDHEId(void) const
get DHE Id (from word0)
unsigned int get_words(void) const
get words
unsigned int getDHEId(void) const
get DHE Id
unsigned int getErrorInfo(void) const
get error info
unsigned int getDHEId(void) const
get DHE Id (from word0)
unsigned short getEventNrLo(void) const
get trigger_nr_lo
unsigned short getTriggerGate(void) const
trigger gate (updated to 8 bit, before 10!)
unsigned short getStartFrameNr(void) const
last DHP frame before trigger
unsigned short getEventNrHi(void) const
get trigger_nr_hi
unsigned int getActiveDHPMask(void) const
get Active DHP Mask (from word0)
bool getDataReformattedFlag(void) const
get DataReformattedFlag (from word0)
unsigned short getDHEId(void) const
get DHE Id (from word0)
unsigned short getDHPPort(void) const
get DHP Port (from word0)
void print(void) const
print
unsigned int get_words(void) const
get words
bool isFakedData(void) const
is faked data
unsigned int get_dhc_id(void) const
get dhc id (from word0)
unsigned int getErrorInfo(void) const
get error info
DHC frame header word data struct.
unsigned short getFrameType(void) const
get type of frame
unsigned short getErrorFlag(void) const
get error flag
unsigned short getDHEId(void) const
get DHE Id (from word0)
unsigned short getDHPPort(void) const
get DDHP port (from word0)
unsigned int check_inner_crc(PXDErrorFlags &, unsigned int) const
check inner crc (currently not implemented/needed)
void check_error(PXDErrorFlags &errormask, int length, bool ignore_inv_size_flag=false) const
check error and return error mask
int getMinSize(void) const
4 byte header, ROIS (n*8), 4 byte copy of inner CRC, 4 byte outer CRC
unsigned short get_subrun1(void) const
get subrun1 (from trigtag1)
unsigned int get_trig_nr1(void) const
get trignr1
bool is_SendUnfiltered(void) const
is sendUnfiltered
bool is_SendROIs(void) const
is sendROIs
void check_error(PXDErrorFlags &errormask, bool ignore_datcon_flag=false, bool ignore_hltroi_magic_flag=false, bool ignore_merger_mm_flag=false) const
check error and return error mask
unsigned short get_run2(void) const
get run2 (from trigtag2)
bool is_fake_datcon(void) const
is fake datcon
unsigned short get_experiment1(void) const
get experiment1 (from trigtag1)
unsigned int get_trig_nr2(void) const
get trignr2
unsigned short get_experiment2(void) const
get experiment2
unsigned short get_subrun2(void) const
get subrun2 (from trigtag2)
bool is_Accepted(void) const
is accepted
unsigned short get_run1(void) const
get run1 (from trigtag1)
void print(void) const
print
unsigned short get_gated_isher(void) const
get gated_isher (from word0)
unsigned short get_subrun(void) const
get subrun (from run_subrun)
unsigned short get_run(void) const
get run (from run_subrun)
unsigned short get_dhc_id(void) const
get dhc_id (from word0)
const ubig16_t time_tag_hi
time_tag_hi
const ubig16_t time_tag_mid
time_tag_mid
bool isFakedData(void) const
isFakedData
unsigned short getEventNrLo(void) const
get trigger_nr_lo
unsigned short get_experiment(void) const
get experiment (from exp_run)
unsigned short get_gated_flag(void) const
get gated_flag (from word0)
unsigned short get_active_dhe_mask(void) const
get active_dhe_mask (from word0)
const ubig16_t time_tag_lo_and_type
time_tag_lo_and_type
unsigned short getEventNrHi(void) const
get trigger_nr_hi

◆ unpack_dhp()

void unpack_dhp ( void *  data,
unsigned int  len,
unsigned int  dhe_first_readout_frame_lo,
unsigned int  dhe_ID,
unsigned  dhe_DHPport,
unsigned  dhe_reformat,
VxdID  vxd_id,
PXDDAQPacketStatus daqpktstat 
)
private

Unpack DHP data within one DHE frame.

Parameters
datapointer to dhp data
lenlength of dhp data
dhe_first_readout_frame_lo16 bit of the first readout frame from DHE Start
dhe_IDraw DHE ID from DHC frame
dhe_DHPportraw DHP port from DHC frame
dhe_reformatflag if DHE did reformatting
vxd_idvertex Detector ID
daqpktstatDaq Packet Status Object

FIXME TODO set an error bit ... but define one first

Definition at line 443 of file PXDUnpackerOldModule.cc.

446{
447 unsigned int nr_words = frame_len / 2; // frame_len in bytes (excl. CRC)!!!
448 ubig16_t* dhp_pix = (ubig16_t*)data;
449
450 unsigned int dhp_readout_frame_lo = 0;
451 unsigned int dhp_header_type = 0;
452 unsigned int dhp_reserved = 0;
453 unsigned int dhp_dhe_id = 0;
454 unsigned int dhp_dhp_id = 0;
455
456 // cppcheck-suppress unreadVariable
457 unsigned int dhp_row = 0, dhp_col = 0, dhp_adc = 0, dhp_cm = 0;
458// unsigned int dhp_offset = 0;
459 bool rowflag = false;
460 bool pixelflag = true; // just for first row start
461
462 if (nr_words < 4) {
463 if (!(m_suppressErrorMask[c_nrDHP_SIZE])) B2WARNING("DHP frame size error (too small)" << LogVar("Nr words", nr_words));
464 m_errorMask[c_nrDHP_SIZE] = true;
465 return;
466 }
467
468 B2DEBUG(29, "HEADER -- $" << hex << dhp_pix[0] << hex << dhp_pix[1] << hex << dhp_pix[2] << hex << dhp_pix[3] << " -- ");
469
470 B2DEBUG(29, "DHP Header | $" << hex << dhp_pix[2] << " ( " << dec << dhp_pix[2] << " ) ");
471 dhp_header_type = (dhp_pix[2] & 0xE000) >> 13;
472 dhp_reserved = (dhp_pix[2] & 0x1F00) >> 8;
473 dhp_dhe_id = (dhp_pix[2] & 0x00FC) >> 2;
474 dhp_dhp_id = dhp_pix[2] & 0x0003;
475
476 B2DEBUG(29, "DHP type | $" << hex << dhp_header_type << " ( " << dec << dhp_header_type << " ) ");
477 B2DEBUG(29, "DHP reserved | $" << hex << dhp_reserved << " ( " << dec << dhp_reserved << " ) ");
478 B2DEBUG(29, "DHP DHE ID | $" << hex << dhp_dhe_id << " ( " << dec << dhp_dhe_id << " ) ");
479 B2DEBUG(29, "DHP DHP ID | $" << hex << dhp_dhp_id << " ( " << dec << dhp_dhp_id << " ) ");
480
481 if (dhe_ID != dhp_dhe_id) {
482 if (!(m_suppressErrorMask[c_nrDHE_DHP_DHEID])) {
483 B2WARNING("DHE ID in DHE and DHP header differ");
484 B2DEBUG(29, "DHE ID in DHE and DHP header differ $" << hex << dhe_ID << " != $" << dhp_dhe_id);
485 }
486 m_errorMask[c_nrDHE_DHP_DHEID] = true;
487 }
488 if (dhe_DHPport != dhp_dhp_id) {
489 if (!(m_suppressErrorMask[c_nrDHE_DHP_PORT])) {
490 B2WARNING("DHP ID (Chip/Port) in DHE and DHP header differ");
491 B2DEBUG(29, "DHP ID (Chip/Port) in DHE and DHP header differ $" << hex << dhe_DHPport << " != $" << dhp_dhp_id);
492 }
493 m_errorMask[c_nrDHE_DHP_PORT] = true;
494 }
495
496 if (dhp_header_type != EDHPFrameHeaderDataType::c_ZSD) {
497 if (!(m_suppressErrorMask[c_nrHEADERTYPE_INV])) {
498 B2WARNING("Header type invalid for this kind of DHE frame");
499 B2DEBUG(29, "Header type invalid for this kind of DHE frame: $" << hex << dhp_header_type);
500 }
501 m_errorMask[c_nrHEADERTYPE_INV] = true;
502 return;
503 }
504
505// static int offtab[4] = {0, 64, 128, 192};
506// dhp_offset = offtab[dhp_dhp_id];
507
508 dhp_readout_frame_lo = dhp_pix[3] & 0xFFFF;
509 B2DEBUG(29, "DHP Frame Nr | $" << hex << dhp_readout_frame_lo << " ( " << dec << dhp_readout_frame_lo << " ) ");
510
511 /* // TODO removed because data format error is not to be fixed soon
512 if (((dhp_readout_frame_lo - dhe_first_readout_frame_id_lo) & 0x3F) > m_maxDHPFrameDiff) {
513 if (!m_suppressErrorMask[c_nrDHP_DHE_FRAME_DIFFER]) B2WARNING("DHP Frame Nr differ from DHE Frame Nr by >1 DHE " <<
514 dhe_first_readout_frame_id_lo << " != DHP " << (dhp_readout_frame_lo & 0x3F) << " delta " << ((
515 dhp_readout_frame_lo - dhe_first_readout_frame_id_lo) & 0x3F));
516 m_errorMask[c_nrDHP_DHE_FRAME_DIFFER] = true;
517 }
518 */
519 /* // TODO removed because data format error is not to be fixed soon
520 if (m_last_dhp_readout_frame_lo[dhp_dhp_id] != -1) {
521 if (((dhp_readout_frame_lo - m_last_dhp_readout_frame_lo[dhp_dhp_id]) & 0xFFFF) > m_maxDHPFrameDiff) {
522 if(!m_suppressErrorMask&c_DHP_NOT_CONT ) B2WARNING("Two DHP Frames per sensor which frame number differ more than one! " << m_last_dhp_readout_frame_lo[dhp_dhp_id] << ", " <<
523 dhp_readout_frame_lo);
524 m_errorMask[c_nrDHP_NOT_CONT] = true;
525 }
526 }
527 */
528
529 if (daqpktstat.dhc_size() > 0) {
530 if (daqpktstat.dhc_back().dhe_size() > 0) {
531 // only is we have a DHC and DHE object... or back() is undefined
532 // Remark, if we have a broken data (DHE_START/END) structure, we might fill the
533 // previous DHE object ... but then the data is junk anyway
534 daqpktstat.dhc_back().dhe_back().newDHP(dhp_dhp_id, dhp_readout_frame_lo);
535 }
536 }
537
538 /* // TODO removed because the data is not ordered as expected in current firmware
539 for (auto j = 0; j < 4; j++) {
540 if (m_last_dhp_readout_frame_lo[j] != -1) {
541 if (((dhp_readout_frame_lo - m_last_dhp_readout_frame_lo[j]) & 0xFFFF) > m_maxDHPFrameDiff) {
542 if(!m_suppressErrorMask&c_DHP_DHP_FRAME_DIFFER ) B2WARNING("Two DHP Frames (different DHP) per sensor which frame number differ more than one! " << m_last_dhp_readout_frame_lo[j] <<
543 ", " <<
544 dhp_readout_frame_lo);
545 m_errorMask[c_nrDHP_DHP_FRAME_DIFFER] = true;
546 break;// give msg only once
547 }
548 }
549 }
550 */
551 m_last_dhp_readout_frame_lo[dhp_dhp_id] = dhp_readout_frame_lo;
552
553// TODO Please check if this can happen by accident with valid data!
554 if (dhp_pix[2] == dhp_pix[4] && dhp_pix[3] + 1 == dhp_pix[5]) {
555 // We see a second "header" with framenr+1 ...
556 if (!(m_suppressErrorMask[c_nrDHP_DBL_HEADER])) {
557 B2WARNING("DHP data: seems to be double header! skipping.");
558 B2DEBUG(29, "DHP data: seems to be double header! skipping." << LogVar("Length",
559 frame_len));
560 }
561 m_errorMask[c_nrDHP_DBL_HEADER] = true;
562 // dump_dhp(data, frame_len); print out guilty dhp packet
563 return;
564 }
565
566 // Start with offset 4, thus skipping header words
567 for (unsigned int i = 4; i < nr_words ; i++) {
568
569 B2DEBUG(29, "-- $" << hex << dhp_pix[i] << " -- " << dec << i);
570 {
571 if (((dhp_pix[i] & 0x8000) >> 15) == 0) {
572 rowflag = true;
573 if (!pixelflag) {
574 if (!(m_suppressErrorMask[c_nrDHP_ROW_WO_PIX])) B2WARNING("DHP Unpacking: Row w/o Pix");
575 m_errorMask[c_nrDHP_ROW_WO_PIX] = true;
576 }
577 pixelflag = false;
578 dhp_row = (dhp_pix[i] & 0xFFC0) >> 5;
579 dhp_cm = dhp_pix[i] & 0x3F;
580 if (dhp_cm == 63) { // fifo overflow
581 B2WARNING("DHP data loss (CM=63) in " << LogVar("DHE", dhe_ID) << LogVar("DHP", dhp_dhp_id));
583 m_errorMask[c_nrDHH_MISC_ERROR] = true;
584 }
585 if (daqpktstat.dhc_size() > 0) {
586 if (daqpktstat.dhc_back().dhe_size() > 0) {
587 PXDDAQDHPComMode cm(dhp_dhp_id, dhp_row, dhp_cm);
588 // only is we have a DHC and DHE object... or back() is undefined
589 // Remark, if we have a broken data (DHE_START/END) structure, we might fill the
590 // previous DHE object ... but then the data is junk anyway
591 daqpktstat.dhc_back().dhe_back().addCM(cm);
592 }
593 }
594 B2DEBUG(29, "SetRow: $" << hex << dhp_row << " CM $" << hex << dhp_cm);
595 } else {
596 if (!rowflag) {
597 if (!(m_suppressErrorMask[c_nrDHP_PIX_WO_ROW])) B2WARNING("DHP Unpacking: Pix without Row!!! skip dhp data ");
598 m_errorMask[c_nrDHP_PIX_WO_ROW] = true;
599 // dump_dhp(data, frame_len);// print out faulty dhp frame
600 return;
601 } else {
602 pixelflag = true;
603 dhp_row = (dhp_row & 0xFFE) | ((dhp_pix[i] & 0x4000) >> 14);
604 dhp_col = ((dhp_pix[i] & 0x3F00) >> 8);
605 unsigned int v_cellID, u_cellID;
606 v_cellID = dhp_row;// defaults for no mapping
607 if (dhp_row >= 768) {
608 if (!(m_suppressErrorMask[c_nrROW_OVERFLOW])) B2WARNING("DHP ROW Overflow " << LogVar("Row", dhp_row));
609 m_errorMask[c_nrROW_OVERFLOW] = true;
610 }
611 // we cannot do col overflow check before mapping :-(
612
613 if ((dhe_reformat == 0 && !m_forceNoMapping) || m_forceMapping) {
614 u_cellID = dhp_col;// defaults for no mapping
615 // data has not been pre-processed by DHH, thus we have to do the mapping ourselves
616 if ((dhe_ID & 0x21) == 0x00 || (dhe_ID & 0x21) == 0x21) {
617 // if IFOB
618 PXDMappingLookup::map_rc_to_uv_IF_OB(v_cellID, u_cellID, dhp_dhp_id, dhe_ID);
619 } else { // else OFIB
620 PXDMappingLookup::map_rc_to_uv_IB_OF(v_cellID, u_cellID, dhp_dhp_id, dhe_ID);
621 }
622 } else {
623 u_cellID = dhp_col + 64 * dhp_dhp_id; // defaults for already mapped
624 }
625 if (u_cellID >= 250) {
626 if (!(m_suppressErrorMask[c_nrCOL_OVERFLOW])) {
627 B2WARNING("DHP COL Overflow (unconnected drain lines)");
628 B2DEBUG(29, "DHP COL Overflow (unconnected drain lines) " << u_cellID << ", reformat " << dhe_reformat << ", dhpcol " << dhp_col <<
629 ", id " << dhp_dhp_id);
630 }
631 m_errorMask[c_nrCOL_OVERFLOW] = true;
632 }
633 dhp_adc = dhp_pix[i] & 0xFF;
634 B2DEBUG(29, "SetPix: Row $" << hex << dhp_row << " Col $" << hex << dhp_col << " ADC $" << hex << dhp_adc
635 << " CM $" << hex << dhp_cm);
636
637 if (dhp_adc == 0) {
638 // if !supress error flag
639 B2WARNING("DHE Event truncation in DHE " << dhe_ID << " DHP " << dhp_dhp_id);
640 // m_errorMask |= c_DHE_EVENT_TRUNC;
641 daqpktstat.dhc_back().dhe_back().dhp_back().setTruncated();
642 } else {
643 if (!m_doNotStore) m_storeRawHits.appendNew(vxd_id, v_cellID, u_cellID, dhp_adc,
644 (dhp_readout_frame_lo - dhe_first_readout_frame_id_lo) & 0x3F);
645 }
646 }
647 }
648 }
649 }
650
651 B2DEBUG(29, "(DHE) DHE_ID $" << hex << dhe_ID << " (DHE) DHP ID $" << hex << dhe_DHPport << " (DHP) DHE_ID $" << hex << dhp_dhe_id
652 << " (DHP) DHP ID $" << hex << dhp_dhp_id);
653 /*for (int i = 0; i < raw_nr_words ; i++) {
654 B2DEBUG(29, "RAW | " << hex << p_pix[i]);
655 printf("raw %08X | ", p_pix[i]);
656 B2DEBUG(29, "row " << hex << ((p_pix[i] >> 20) & 0xFFF) << dec << " ( " << ((p_pix[i] >> 20) & 0xFFF) << " ) " << " col " << hex << ((p_pix[i] >> 8) & 0xFFF)
657 << " ( " << dec << ((p_pix[i] >> 8) & 0xFFF) << " ) " << " adc " << hex << (p_pix[i] & 0xFF) << " ( " << (p_pix[i] & 0xFF) << " ) "
658 );
659 }*/
660}
PXDDAQDHPStatus & newDHP(Args &&... params)
New DHP information.
auto addCM(PXDDAQDHPComMode &daqcm)
Add Common Mode information.
PXDDAQDHPStatus & dhp_back()
Returns PXDDAQDHPStatus for the last DHP.
void setTruncated(void)
set Truncation
static void map_rc_to_uv_IF_OB(unsigned int &row_u, unsigned int &col_v, const unsigned int dhp_id, const unsigned int dhe_ID)
Maps row/col of inner forward (IF) and outer backward (OB) modules of the PXD to U/V cell.
static void map_rc_to_uv_IB_OF(unsigned int &row_u, unsigned int &col_v, const unsigned int dhp_id, const unsigned int dhe_ID)
Maps row/cols of inner backward (IB) and outer forward (OF) modules of the PXD to U/V cell.
std::tuple< uint8_t, uint16_t, uint8_t > PXDDAQDHPComMode
tuple of Chip ID (2 bit), Row (10 bit), Common Mode (6 bit)

◆ unpack_dhp_raw()

void unpack_dhp_raw ( void *  data,
unsigned int  len,
unsigned int  dhe_ID,
unsigned  dhe_DHPport,
VxdID  vxd_id 
)
private

Unpack DHP RAW data within one DHE frame (pedestals, etc)

Parameters
datapointer to dhp data
lenlength of dhp data
dhe_IDraw DHE ID from DHC frame
dhe_DHPportraw DHP port from DHC frame
vxd_idvertex Detector ID

Important Remark: Up to now the format for Raw frames as well as size etc is not well defined. It will most likely change! E.g. not the whole mem is dumped, but only a part of it.


Endian Swapping is done in Contructors of Raw Objects!

Definition at line 299 of file PXDUnpackerOldModule.cc.

301{
302// unsigned int nr_words = frame_len / 2; // frame_len in bytes (excl. CRC)!!!
303 ubig16_t* dhp_pix = (ubig16_t*)data;
304
311
312 // Size: 64*768 + 8 bytes for a full frame readout
313 if (frame_len != 0xC008) {
314 if (!(m_suppressErrorMask[c_nrFIX_SIZE])) B2WARNING("Frame size unsupported for RAW ADC frame! $" <<
315 LogVar("size [bytes] $", static_cast < std::ostringstream && >(std::ostringstream() << hex << frame_len).str())
316 << LogVar("DHE", dhe_ID) << LogVar("DHP", dhe_DHPport));
317 m_errorMask[c_nrFIX_SIZE] = true;
318 return;
319 }
320 unsigned int dhp_header_type = 0;
321// unsigned int dhp_reserved = 0;
322 unsigned int dhp_dhe_id = 0;
323 unsigned int dhp_dhp_id = 0;
324
325 dhp_header_type = (dhp_pix[2] & 0xE000) >> 13;
326// dhp_reserved = (dhp_pix[2] >> 8) & 0x1F;
327 dhp_dhe_id = (dhp_pix[2] & 0x00FC) >> 2;
328 dhp_dhp_id = dhp_pix[2] & 0x0003;
329
330 if (dhe_ID != dhp_dhe_id) {
331 if (!(m_suppressErrorMask[c_nrDHE_DHP_DHEID])) {
332 B2WARNING("DHE ID in DHE and DHP header differ");
333 B2DEBUG(29, "DHE ID in DHE and DHP header differ $" << hex << dhe_ID << " != $" << dhp_dhe_id);
334 }
335 m_errorMask[c_nrDHE_DHP_DHEID] = true;
336 }
337 if (dhe_DHPport != dhp_dhp_id) {
338 if (!(m_suppressErrorMask[c_nrDHE_DHP_PORT])) {
339 B2WARNING("DHP ID (Chip/Port) in DHE and DHP header differ");
340 B2DEBUG(29, "DHP ID (Chip/Port) in DHE and DHP header differ $" << hex << dhe_DHPport << " != $" << dhp_dhp_id);
341 }
342 m_errorMask[c_nrDHE_DHP_PORT] = true;
343 }
344
345 if (dhp_header_type != EDHPFrameHeaderDataType::c_RAW) {
346 if (!(m_suppressErrorMask[c_nrHEADERTYPE_INV])) {
347 B2WARNING("Header type invalid for this kind of DHE frame");
348 B2DEBUG(29, "Header type invalid for this kind of DHE frame: $" << hex << dhp_header_type);
349 }
350 m_errorMask[c_nrHEADERTYPE_INV] = true;
351 return;
352 }
353
355 B2DEBUG(29, "Raw ADC Data");
356 // size checked already above
357 m_storeRawAdc.appendNew(vxd_id, data, frame_len);
358};

◆ unpack_fce()

void unpack_fce ( unsigned short *  data,
unsigned int  length,
VxdID  vxd_id 
)
private

Unpack DHP/FCE data within one DHE frame Not fully implemented as cluster format not 100% fixed.

Parameters
datapointer to dhp data
lengthlength of dhp data
vxd_idvertex Detector ID

Important Remark: Up to now the format for cluster is not well defined. We need to wait for the final hardware implementation. Then the following code must be re-checked TODO


Definition at line 360 of file PXDUnpackerOldModule.cc.

362{
369
370 B2WARNING("FCE (Cluster) Packet have not yet been tested with real HW clusters. Dont assume that this code is working!");
371 return;
372
373 // implement the unpacking here and not as a separate module ... when it is available in HW
374// ubig16_t* cluster = (ubig16_t*)data;
375// int nr_words; //words in dhp frame
376// unsigned int words_in_cluster = 0; //counts 16bit words in cluster
377// nr_words = length / 2;
378// ubig16_t sor;
379// sor = 0x0000;
380//
381// for (int i = 2 ; i < nr_words ; i++) {
382// if (i != 2) { //skip header
383// if ((((cluster[i] & 0x8000) == 0)
384// && ((cluster[i] & 0x4000) >> 14) == 1)) { //searches for start of row frame with start of cluster flag = 1 => new cluster
385// if (!m_doNotStore) m_storeRawCluster.appendNew(&data[i - words_in_cluster], words_in_cluster, vxd_id);
386// words_in_cluster = 0;
387// }
388// }
389// if ((cluster[i] & 0x8000) == 0) {
390// sor = cluster[i];
391// }
392// words_in_cluster++;
393//
394// if ((cluster[nr_words - 1] & 0xFFFF) == (sor &
395// 0xFFFF)) {//if frame is not 32bit aligned last word will be the last start of row word
396// cluster[nr_words - 1] = 0x0000;//overwrites the last redundant word with zero to make checking easier in PXDHardwareClusterUnpacker
397// }
398//
399// if (i == nr_words - 1) {
400// if (!m_doNotStore) m_storeRawCluster.appendNew(&data[i - words_in_cluster + 1], words_in_cluster, vxd_id);
401// }
402// }
403}

◆ unpack_rawpxd()

void unpack_rawpxd ( RawPXD px,
int  inx 
)
private

Unpack one event (several frames) stored in RawPXD object.

Parameters
pxRawPXD data object
inxIndex of RawPXD packet

in bytes ... rounded up to next 32bit boundary

NEW format

len of frame in bytes

round up to next 32 bit boundary

no rounding needed

Definition at line 174 of file PXDUnpackerOldModule.cc.

175{
176 int Frames_in_event;
177 int fullsize;
178 int datafullsize;
179
180 m_errorMaskDHE = 0;
181 m_errorMaskDHC = 0;
183 PXDDAQPacketStatus& daqpktstat = m_storeDAQEvtStats->newPacket(inx);
184
185 if (px.size() <= 0 || px.size() > 16 * 1024 * 1024) {
186 if (!(m_suppressErrorMask[c_nrPACKET_SIZE])) {
187 B2WARNING("PXD Unpacker --> invalid packet size" <<
188 LogVar("size [32bit words] $", static_cast < std::ostringstream && >(std::ostringstream() << hex << px.size()).str()));
189 }
190 m_errorMask[c_nrPACKET_SIZE] = true;
191 return;
192 }
193 std::vector<unsigned int> data(px.size());
194 fullsize = px.size() * 4;
195 std::copy_n(px.data(), px.size(), data.begin());
196
197 if (fullsize < 8) {
198 if (!(m_suppressErrorMask[c_nrPACKET_SIZE])) {
199 B2WARNING("Data is to small to hold a valid Header! Will not unpack anything." << LogVar("size [32bit words] $",
200 static_cast < std::ostringstream && >(std::ostringstream() << hex << fullsize).str()));
201 }
202 m_errorMask[c_nrPACKET_SIZE] = true;
203 return;
204 }
205
206 if (data[0] != 0xCAFEBABE && data[0] != 0xBEBAFECA) {
207 if (!(m_suppressErrorMask[c_nrMAGIC])) {
208 B2WARNING("Magic invalid: Will not unpack anything. Header corrupted." <<
209 LogVar("Header Magic $", static_cast < std::ostringstream && >(std::ostringstream() << hex << data[0]).str()));
210 }
211 m_errorMask[c_nrMAGIC] = true;
212 return;
213 }
214
215
216 Frames_in_event = ((ubig32_t*)data.data())[1];
217 if (Frames_in_event < 0 || Frames_in_event > 256) {
218 if (!(m_suppressErrorMask[c_nrFRAME_NR])) {
219 B2WARNING("Number of Frames invalid: Will not unpack anything. Header corrupted!" << LogVar("Frames in event", Frames_in_event));
220 }
221 m_errorMask[c_nrFRAME_NR] = true;
222 return;
223 }
224 if (Frames_in_event < 3) {
225 if (!(m_suppressErrorMask[c_nrNR_FRAMES_TO_SMALL])) {
226 B2WARNING("Number of Frames too small: It cannot contain anything useful." << LogVar("Frames in event", Frames_in_event));
227 }
228 m_errorMask[c_nrNR_FRAMES_TO_SMALL] = true;
229 }
230
232 if (m_verbose) {
233 B2DEBUG(29, "PXD Unpacker --> data[0]: <-- Magic $" << hex << data[0]);
234 B2DEBUG(29, "PXD Unpacker --> data[1]: <-- #Frames $" << hex << data[1]);
235 if (data[1] >= 1 && fullsize < 12) B2DEBUG(29, "PXD Unpacker --> data[2]: <-- Frame 1 len $" << hex << data[2]);
236 if (data[1] >= 2 && fullsize < 16) B2DEBUG(29, "PXD Unpacker --> data[3]: <-- Frame 2 len $" << hex << data[3]);
237 if (data[1] >= 3 && fullsize < 20) B2DEBUG(29, "PXD Unpacker --> data[4]: <-- Frame 3 len $" << hex << data[4]);
238 if (data[1] >= 4 && fullsize < 24) B2DEBUG(29, "PXD Unpacker --> data[5]: <-- Frame 4 len $" << hex << data[5]);
239 };
240
241 unsigned int* tableptr;
242 tableptr = &data[2]; // skip header!!!
243
244 unsigned int* dataptr;
245 dataptr = &tableptr[Frames_in_event];
246 datafullsize = fullsize - 2 * 4 - Frames_in_event * 4; // Size is fullsize minus header minus table
247
248 int ll = 0; // Offset in dataptr in bytes
249 for (int j = 0; j < Frames_in_event; j++) {
250 int lo;
251
252 lo = ((ubig32_t*)tableptr)[j];
253 if (lo <= 0) {
254 if (!(m_suppressErrorMask[c_nrFRAME_SIZE])) {
255 B2WARNING("size of frame invalid");
256 B2DEBUG(29, "size of frame invalid: " << j << "size " << lo << " at byte offset in dataptr " << ll);
257 }
258 m_errorMask[c_nrFRAME_SIZE] = true;
259 return;
260 }
261 if (ll + lo > datafullsize) {
262 if (!(m_suppressErrorMask[c_nrFRAME_SIZE])) {
263 B2WARNING("Frames exceed packet size");
264 B2DEBUG(29, "Frames exceed packet size: " << j << " size " << lo << " at byte offset in dataptr " << ll << " of datafullsize " <<
265 datafullsize << " of fullsize " << fullsize);
266 }
267 m_errorMask[c_nrFRAME_SIZE] = true;
268 return;
269 }
270 if (lo & 0x3) {
271 if (!(m_suppressErrorMask[c_nrFRAME_SIZE])) {
272 B2WARNING("SKIP Frame with Data with not MOD 4 length");
273 B2DEBUG(29, "SKIP Frame with Data with not MOD 4 length " << " ( $" << hex << lo << " ) ");
274 }
275 ll += (lo + 3) & 0xFFFFFFFC;
276 m_errorMask[c_nrFRAME_SIZE] = true;
277 } else {
278 B2DEBUG(29, "unpack DHE(C) frame: " << j << " with size " << lo << " at byte offset in dataptr " << ll);
279 unpack_dhc_frame(ll + (char*)dataptr, lo, j, Frames_in_event, daqpktstat);
280 ll += lo;
281 }
286 m_errorMask = 0;
287
288 if (!m_continueOnError && (m_errorMaskPacket & PXDErrorFlags(m_errorSkipPacketMask)) != PXDErrorFlags(0)) {
289 // skip full package on error, recovery to next DHC/DHE Start might be possible in some cases
290 // But thats to hard to implement
291 // Remark: PXD data for broken events is removed in next PXDPostChecker module, thus skipping the
292 // unpacking is not strictly necessary here.
293 break;
294 }
295 }
297}
The PXD DAQ Packet Status class.
void setErrorMask(const PXDErrorFlags &mask)
Set Error bit mask This should be the OR of error masks of all sub-objects (DHC, DHE)
PXDError::PXDErrorFlags m_errorMaskPacket
Error Mask set per packet / packet.
void unpack_dhc_frame(void *data, const int len, const int Frame_Number, const int Frames_in_event, PXDDAQPacketStatus &daqpktstat)
Unpack one frame (within an event).
virtual int * data(void)
get pointer to data
Definition: RawPXD.cc:81
virtual int size() const
get size of buffer in 32 Bit words
Definition: RawPXD.cc:76

Member Data Documentation

◆ m_checkPaddingCRC

bool m_checkPaddingCRC {false}
private

Check for susp.

Padding/CRC, default off because of many false positive

Definition at line 62 of file PXDUnpackerOldModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_continueOnError

bool m_continueOnError {false}
private

flag continue unpacking of frames even after error (for debugging)

Definition at line 99 of file PXDUnpackerOldModule.h.

◆ m_criticalErrorMask

PXDError::PXDErrorFlags m_criticalErrorMask {}
private

Critical error mask which defines return value of task.

Definition at line 71 of file PXDUnpackerOldModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_doNotStore

bool m_doNotStore {false}
private

Only unpack, but Do Not Store anything to file.

Definition at line 60 of file PXDUnpackerOldModule.h.

◆ m_errorCounter

unsigned int m_errorCounter[PXDError::ONSEN_MAX_TYPE_ERR] {}
private

Error counters.

Definition at line 95 of file PXDUnpackerOldModule.h.

◆ m_errorMask

PXDError::PXDErrorFlags m_errorMask {0}
private

Error Mask set per packet / frame.

Definition at line 160 of file PXDUnpackerOldModule.h.

◆ m_errorMaskDHC

PXDError::PXDErrorFlags m_errorMaskDHC {0}
private

Error Mask set per packet / DHC.

Definition at line 164 of file PXDUnpackerOldModule.h.

◆ m_errorMaskDHE

PXDError::PXDErrorFlags m_errorMaskDHE {0}
private

Error Mask set per packet / DHE.

Definition at line 162 of file PXDUnpackerOldModule.h.

◆ m_errorMaskEvent

PXDError::PXDErrorFlags m_errorMaskEvent {0}
private

Error Mask set per packet / event.

Definition at line 168 of file PXDUnpackerOldModule.h.

◆ m_errorMaskPacket

PXDError::PXDErrorFlags m_errorMaskPacket {0}
private

Error Mask set per packet / packet.

Definition at line 166 of file PXDUnpackerOldModule.h.

◆ m_errorSkipPacketMask

PXDError::PXDErrorFlags m_errorSkipPacketMask {}
private

Mask for error which stop package unpacking directly.

Definition at line 75 of file PXDUnpackerOldModule.h.

◆ m_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData
private

Input ptr for EventMetaData.

Definition at line 104 of file PXDUnpackerOldModule.h.

◆ m_forceMapping

bool m_forceMapping {false}
private

Force Mapping even if DHH bit is not requesting it.

Definition at line 64 of file PXDUnpackerOldModule.h.

◆ m_forceNoMapping

bool m_forceNoMapping {false}
private

Force No Mapping even if DHH bit is requesting it.

Definition at line 66 of file PXDUnpackerOldModule.h.

◆ m_formatBonnDAQ

bool m_formatBonnDAQ {false}
private

flag ONSEN or BonnDAQ format

Definition at line 177 of file PXDUnpackerOldModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_last_dhp_readout_frame_lo

int m_last_dhp_readout_frame_lo[4] { -1}
private

some workaround check for continouous frame ids

Definition at line 180 of file PXDUnpackerOldModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_maxDHPFrameDiff

unsigned int m_maxDHPFrameDiff {0}
private

Maximum DHP frame difference until error is reported.

Definition at line 68 of file PXDUnpackerOldModule.h.

◆ m_meta_event_nr

unsigned long m_meta_event_nr {0}
private

Event Number from MetaInfo.

Definition at line 78 of file PXDUnpackerOldModule.h.

◆ m_meta_experiment

unsigned long m_meta_experiment {0}
private

Experiment from MetaInfo.

Definition at line 84 of file PXDUnpackerOldModule.h.

◆ m_meta_run_nr

unsigned long m_meta_run_nr {0}
private

Run Number from MetaInfo.

Definition at line 80 of file PXDUnpackerOldModule.h.

◆ m_meta_sec

unsigned int m_meta_sec {0}
private

Time(Tag) from MetaInfo, seconds (masked to lower bits)

Definition at line 88 of file PXDUnpackerOldModule.h.

◆ m_meta_subrun_nr

unsigned long m_meta_subrun_nr {0}
private

Subrun Number from MetaInfo.

Definition at line 82 of file PXDUnpackerOldModule.h.

◆ m_meta_ticks

unsigned int m_meta_ticks {0}
private

Time(Tag) from MetaInfo, Ticks of 127MHz.

Definition at line 90 of file PXDUnpackerOldModule.h.

◆ m_meta_time

unsigned long long int m_meta_time {0}
private

Time(Tag) from MetaInfo.

Definition at line 86 of file PXDUnpackerOldModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

◆ m_notaccepted

unsigned int m_notaccepted {0}
private

counter for not accepted events... should not happen TODO discussion ongoing with DAQ group

Definition at line 171 of file PXDUnpackerOldModule.h.

◆ m_package

std::string m_package
privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

◆ m_PXDDAQEvtStatsName

std::string m_PXDDAQEvtStatsName
private

The name of the StoreObjPtr of PXDDAQStatus to be generated.

Definition at line 54 of file PXDUnpackerOldModule.h.

◆ m_PXDRawAdcsName

std::string m_PXDRawAdcsName
private

The name of the StoreArray of PXDRawAdcs to be generated.

Definition at line 56 of file PXDUnpackerOldModule.h.

◆ m_PXDRawHitsName

std::string m_PXDRawHitsName
private

The name of the StoreArray of PXDRawHits to be generated.

Definition at line 55 of file PXDUnpackerOldModule.h.

◆ m_PXDRawROIsName

std::string m_PXDRawROIsName
private

The name of the StoreArray of PXDRawROIs to be generated.

Definition at line 57 of file PXDUnpackerOldModule.h.

◆ m_RawPXDsName

std::string m_RawPXDsName
private

The name of the StoreArray of processed RawPXDs.

Definition at line 53 of file PXDUnpackerOldModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_sendrois

unsigned int m_sendrois {0}
private

counter for send debug rois

Definition at line 173 of file PXDUnpackerOldModule.h.

◆ m_sendunfiltered

unsigned int m_sendunfiltered {0}
private

counter for send unfiltered

Definition at line 175 of file PXDUnpackerOldModule.h.

◆ m_storeDAQEvtStats

StoreObjPtr<PXDDAQStatus> m_storeDAQEvtStats
private

Output array for DAQ Status.

Definition at line 110 of file PXDUnpackerOldModule.h.

◆ m_storeRawAdc

StoreArray<PXDRawAdc> m_storeRawAdc
private

Output array for Raw Adcs.

Definition at line 112 of file PXDUnpackerOldModule.h.

◆ m_storeRawHits

StoreArray<PXDRawHit> m_storeRawHits
private

Output array for Raw Hits.

Definition at line 106 of file PXDUnpackerOldModule.h.

◆ m_storeRawPXD

StoreArray<RawPXD> m_storeRawPXD
private

Input array for PXD Raw.

Definition at line 102 of file PXDUnpackerOldModule.h.

◆ m_storeROIs

StoreArray<PXDRawROIs> m_storeROIs
private

Output array for Raw ROIs.

Definition at line 108 of file PXDUnpackerOldModule.h.

◆ m_suppressErrorMask

PXDError::PXDErrorFlags m_suppressErrorMask {}
private

Mask for suppressing selected error messages.

Definition at line 73 of file PXDUnpackerOldModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_unpackedEventsCount

unsigned int m_unpackedEventsCount {0}
private

Event counter.

Definition at line 93 of file PXDUnpackerOldModule.h.

◆ m_verbose

bool m_verbose {false}
private

give verbose unpacking information

Definition at line 97 of file PXDUnpackerOldModule.h.


The documentation for this class was generated from the following files: