The PXDUnpackerOT module. More...

#include <PXDUnpackerOTModule.h>

Inheritance diagram for PXDUnpackerOTModule:

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
	PXDUnpackerOTModule ()
	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.

LogConfig &	getLogConfig ()
	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 ModuleCondition *	getCondition () 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< Path >	getConditionPath () 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 ModuleParamList &	getParamList () 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< PathElement >	clone () 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< ModulePtr >	getModules () 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< RawPXD >	m_storeRawPXD
	Input array for PXD Raw.

StoreObjPtr< EventMetaData >	m_eventMetaData
	Input ptr for EventMetaData.

StoreArray< PXDRawHit >	m_storeRawHits
	Output array for Raw Hits.

StoreArray< PXDRawROIs >	m_storeROIs
	Output array for Raw ROIs.

StoreObjPtr< PXDDAQStatus >	m_storeDAQEvtStats
	Output array for DAQ Status.

StoreArray< PXDRawAdc >	m_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< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

The PXDUnpackerOT 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 PXDUnpackerOTModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

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.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

◆ PXDUnpackerOTModule()

PXDUnpackerOTModule ( )

Constructor defining the parameters.

Definition at line 39 of file PXDUnpackerOTModule.cc.

                                         :
  Module(),
  m_storeRawHits(),
  m_storeROIs(),
  m_storeRawAdc()
{
  //Set module properties
  setDescription("Unpack Raw PXD Hits from ONSEN data stream");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("RawPXDsName", m_RawPXDsName, "The name of the StoreArray of RawPXDs to be processed", std::string(""));
  addParam("PXDRawHitsName", m_PXDRawHitsName, "The name of the StoreArray of generated PXDRawHits", std::string(""));
  addParam("PXDDAQEvtStatsName", m_PXDDAQEvtStatsName, "The name of the StoreObjPtr of generated PXDDAQEvtStats", std::string(""));
  addParam("PXDRawAdcsName", m_PXDRawAdcsName, "The name of the StoreArray of generated PXDRawAdcs", std::string(""));
  addParam("PXDRawROIsName", m_PXDRawROIsName, "The name of the StoreArray of generated PXDRawROIs", std::string(""));
  addParam("DoNotStore", m_doNotStore, "only unpack and check, but do not store", false);
//   addParam("CriticalErrorMask", m_criticalErrorMask, "Set error mask which stops processing by returning false by task", 0);
  // m_criticalErrorMask not longer a aparameter
  // the constructor default to zero anyway
//   addParam("SuppressErrorMask", m_suppressErrorMask, "Set mask for errors msgs which are not printed", getSilenceMask());
  // m_suppressErrorMask not longer a aparameter
  m_suppressErrorMask = getSilenceMask();
  addParam("ForceMapping", m_forceMapping, "Force Mapping even if DHH bit is NOT requesting it", false);
  addParam("ForceNoMapping", m_forceNoMapping, "Force NO Mapping even if DHH bit is requesting it", false);
  addParam("CheckPaddingCRC", m_checkPaddingCRC, "Check for susp. padding (debug option, many false positive)", false);
  addParam("MaxDHPFrameDiff", m_maxDHPFrameDiff, "Maximum DHP Frame Nr Difference w/o reporting error", 2u);
  addParam("FormatBonnDAQ", m_formatBonnDAQ, "ONSEN or BonnDAQ format", false);
  addParam("Verbose", m_verbose, "Turn on extra verbosity for log-level debug", false);
  addParam("ContinueOnError", m_continueOnError, "Continue package depacking on error (for debugging)", false);
//   (
//              /*EPXDErrFlag::c_DHC_END | EPXDErrFlag::c_DHE_START | EPXDErrFlag::c_DATA_OUTSIDE |*/
//              EPXDErrFlag::c_FIX_SIZE | EPXDErrFlag::c_DHE_CRC | EPXDErrFlag::c_DHC_UNKNOWN | /*EPXDErrFlag::c_MERGER_CRC |*/
//              EPXDErrFlag::c_DHP_SIZE | /*EPXDErrFlag::c_DHP_PIX_WO_ROW | EPXDErrFlag::c_DHE_START_END_ID | EPXDErrFlag::c_DHE_START_ID |*/
//              EPXDErrFlag::c_DHE_START_WO_END | EPXDErrFlag::c_DHP_NOT_CONT
//            ));
 
  // this is not really a parameter, it should be fixed.
  m_errorSkipPacketMask[c_nrDHE_CRC] = true;
  m_errorSkipPacketMask[c_nrFIX_SIZE] = true;
}

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.

Definition at line 146 of file Module.h.

146{};

◆ 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.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

◆ 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 425 of file Module.h.

425{ beginRun(); }

◆ 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 438 of file Module.h.

438{ endRun(); }

◆ 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 431 of file Module.h.

431{ event(); }

◆ 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 419 of file Module.h.

419{ initialize(); }

◆ 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 444 of file Module.h.

444{ terminate(); }

◆ dump_dhp()

void dump_dhp	(	void *	data,
		unsigned int	frame_len )

static

dump to a file, helper function for debugging.

Definition at line 407 of file PXDUnpackerOTModule.cc.

{
  // called only for debugging purpose, will never be called in normal running
  unsigned int w = frame_len / 2;
  ubig16_t* d = (ubig16_t*)data;
 
  B2WARNING("HEADER --  $" << hex << d[0] << ",$" << hex << d[1] << ",$" << hex << d[2] << ",$" << hex << d[3] << " -- ");
 
  auto dhp_header_type  = (d[2] & 0xE000) >> 13;
  auto dhp_reserved     = (d[2] & 0x1F00) >> 8;
  auto dhp_dhe_id       = (d[2] & 0x00FC) >> 2;
  auto dhp_dhp_id       =  d[2] & 0x0003;
 
  B2WARNING("DHP type     | $" << hex << dhp_header_type << " ( " << dec << dhp_header_type << " ) ");
  B2WARNING("DHP reserved | $" << hex << dhp_reserved << " ( " << dec << dhp_reserved << " ) ");
  B2WARNING("DHP DHE ID   | $" << hex << dhp_dhe_id << " ( " << dec << dhp_dhe_id << " ) ");
  B2WARNING("DHP DHP ID   | $" << hex << dhp_dhp_id << " ( " << dec << dhp_dhp_id << " ) ");
  for (unsigned int i = 4; i < w; i++) {
    B2WARNING("DHP DATA $" << hex << d[i]);
  }
  B2WARNING("DHP CRC $" << hex << d[w] << ",$" << hex << d[w + 1]);
}

◆ dump_roi()

void dump_roi	(	void *	data,
		unsigned int	frame_len )

static

dump to a file, helper function for debugging.

Definition at line 430 of file PXDUnpackerOTModule.cc.

{
  // called only for debugging purpose, will never be called in normal running
  unsigned int w = frame_len / 4;
  ubig32_t* d = (ubig32_t*)data;
 
  B2WARNING("HEADER --  $" << hex << d[0] << ",$" << hex << d[1] << ",$" << hex << d[2] << ",$" << hex << d[3] << " -- Len $" << hex
            << frame_len);
 
  for (unsigned int i = 0; i < w; i++) {
    B2WARNING("ROI DATA $" << hex << d[i]);
  }
  B2WARNING("ROI CRC $" << hex << d[w]);
}

◆ 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.

Definition at line 165 of file Module.h.

165{};

◆ 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.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

◆ event()

void event ( void )

finaloverrideprivatevirtual

do the unpacking

Reimplemented from Module.

Definition at line 127 of file PXDUnpackerOTModule.cc.

{
  m_storeDAQEvtStats.create();
 
  m_errorMask = 0;
  m_errorMaskEvent = 0;
 
  m_meta_event_nr = m_eventMetaData->getEvent();// used for error output below
 
  if (!m_storeRawPXD) {// if no input, nothing to do
    m_errorMask[c_nrNO_PXD] = true;
  } else {
    int nRaws = m_storeRawPXD.getEntries();
    if (m_verbose) {
      B2DEBUG(29, "PXD Unpacker --> RawPXD Objects in event: " << LogVar("Objects", nRaws));
    };
 
    m_meta_run_nr = m_eventMetaData->getRun();
    m_meta_subrun_nr = m_eventMetaData->getSubrun();
    m_meta_experiment = m_eventMetaData->getExperiment();
    m_meta_time = m_eventMetaData->getTime();
    m_meta_ticks = (unsigned int)std::round((m_meta_time % 1000000000ull) * 0.127216); // calculate ticks in 127MHz RF clock
    m_meta_sec = (unsigned int)(m_meta_time / 1000000000ull) & 0x1FFFF;
 
    int inx = 0; // count index for output objects
    for (auto& it : m_storeRawPXD) {
      if (m_verbose) {
        B2DEBUG(29, "PXD Unpacker --> Unpack Objects: ");
      };
      unpack_rawpxd(it, inx++);
    }
 
    if (nRaws == 0) m_errorMask[c_nrNO_PXD] = true;
  }
  m_errorMaskEvent |= m_errorMask;
  m_storeDAQEvtStats->setErrorMask(m_errorMaskEvent);
 
  m_unpackedEventsCount++;
  {
    for (unsigned int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) {
      if (m_errorMaskEvent[i]) m_errorCounter[i]++;
    }
  }
 
  if ((PXDErrorFlags(m_criticalErrorMask) & m_errorMaskEvent) != PXDErrorFlags(0)) B2ERROR("Error in PXD unpacking" <<
        LogVar("event nr", m_meta_event_nr));
  setReturnValue(PXDErrorFlags(0) == (PXDErrorFlags(m_criticalErrorMask) & m_errorMaskEvent));
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional paths */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "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.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ 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.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

◆ 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.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 313 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

◆ 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.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

201{return m_description;}

◆ 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, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

505{ 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 186 of file Module.h.

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{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.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

◆ 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 380 of file Module.h.

380{ 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.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 310 of file Module.h.

310{ 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

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 377 of file Module.h.

377{ 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.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

◆ 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

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 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

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ 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 80 of file PXDUnpackerOTModule.cc.

{
  // Required input
  m_eventMetaData.isRequired();
  // Optional input
  m_storeRawPXD.isOptional(m_RawPXDsName);
 
  //Register output collections
  m_storeRawHits.registerInDataStore(m_PXDRawHitsName, DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
  m_storeRawAdc.registerInDataStore(m_PXDRawAdcsName, DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
  m_storeROIs.registerInDataStore(m_PXDRawROIsName, DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
  m_storeDAQEvtStats.registerInDataStore(m_PXDDAQEvtStatsName, DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
 
  B2DEBUG(29, "ForceMapping: " << m_forceMapping);
  B2DEBUG(29, "ForceNoMapping: " << m_forceNoMapping);
  B2DEBUG(29, "CheckPaddingCRC: " << m_checkPaddingCRC);
  B2DEBUG(29, "MaxDHPFrameDiff: " << m_maxDHPFrameDiff);
 
  m_sendunfiltered = 0;
  m_sendrois = 0;
  m_notaccepted = 0;
  m_unpackedEventsCount = 0;
  for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) m_errorCounter[i] = 0;
 
}

◆ 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 1468 of file PXDUnpackerOTModule.cc.

{
  const int lut[32] = {
    0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4,
    1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5
  };
  return lut[i & 0x1F];
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

◆ 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

name	The name of the module

Definition at line 213 of file Module.h.

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ 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

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ 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

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ 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

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ 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

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ 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.

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

◆ terminate()

void terminate ( void )

finaloverrideprivatevirtual

Terminate the module.

Reimplemented from Module.

Definition at line 107 of file PXDUnpackerOTModule.cc.

{
  int flag = 0;
  string errstr = "Statistic ( ;";
  errstr += to_string(m_unpackedEventsCount) + ";";
  for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) { errstr += to_string(m_errorCounter[i]) + ";"; flag |= m_errorCounter[i];}
  if (flag != 0) {
    B2RESULT("PXD Unpacker --> Error Statistics (counted once per event!) in Events: " << m_unpackedEventsCount);
    B2RESULT(errstr + " )");
    for (int i = 0; i < ONSEN_MAX_TYPE_ERR; i++) {
      if (m_errorCounter[i]) {
        B2RESULT(getPXDBitErrorName(i) << ": " << m_errorCounter[i]);
      }
    }
  } else {
    B2RESULT("PXD Unpacker --> No Error found in Events: " << m_unpackedEventsCount);
  }
  B2RESULT("Statistic 2: !Accepted: " << m_notaccepted << " SendROIs: " << m_sendrois << " Unfiltered: " << m_sendunfiltered);
}

◆ 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

data	pointer to frame
len	length of frame
Frame_Number	current frame number
Frames_in_event	number of frames in PxdRaw object (subevent)
daqpktstat	Daq 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

referring 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 671 of file PXDUnpackerOTModule.cc.

{
  static unsigned int eventNrOfOnsenTrgFrame = 0;
  static int countedBytesInDHC = 0;
  static bool cancheck_countedBytesInDHC = false;
  static int countedBytesInDHE = 0;
  static bool cancheck_countedBytesInDHE = false;
  static int countedDHEStartFrames = 0;
  static int countedDHEEndFrames = 0;
  static int mask_active_dhe = 0;// DHE mask (5 bit)
  static int nr_active_dhe =
    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?
  static int mask_active_dhp = 0;// DHP active mask, 4 bit, per current DHE
  static int found_mask_active_dhp = 0;// mask which DHP send data and check on DHE END frame if it matches
  static int found_good_mask_active_dhp = 0;// mask which DHP send useful data
  static unsigned int dhe_first_readout_frame_id_lo = 0;
  // cppcheck-suppress variableScope
  static unsigned int dhe_first_triggergate = 0;
  static unsigned int currentDHCID = 0xFFFFFFFF;
  static unsigned int currentDHEID = 0xFFFFFFFF;
  static unsigned int currentVxdId = 0;
  static bool isFakedData_event = false;
  static bool isUnfiltered_event = false;
 
 
  if (Frame_Number == 0) {
    // We reset the counters on the first event
    // we do this before any other check is done
    eventNrOfOnsenTrgFrame = 0;
    countedDHEStartFrames = 0;
    countedDHEEndFrames = 0;
    countedBytesInDHC = 0;
    cancheck_countedBytesInDHC = false;
    countedBytesInDHE = 0;
    cancheck_countedBytesInDHE = false;
    currentDHCID = 0xFFFFFFFF;
    currentDHEID = 0xFFFFFFFF;
    currentVxdId = 0;
    isUnfiltered_event = false;
    isFakedData_event = false;
    mask_active_dhe = 0;
    nr_active_dhe = 0;
    mask_active_dhp = 0;
    found_mask_active_dhp = 0;
    found_good_mask_active_dhp = 0;
  }
 
  dhc_frame_header_word0* hw = (dhc_frame_header_word0*)data;
 
  dhc_frames dhc;
  dhc.set(data, hw->getFrameType(), len);
 
  {
    // if a fixed size frame has a different length, how can we rely on its content???
    // AND we could by typecasting access memory beyond end of data (but very unlikely)
    // for that reason this we have to check before any CRC and stop unpacking the frame
    int s = dhc.getFixedSize();
    if (len != s && s != 0) {
      if (!(m_suppressErrorMask[c_nrFIX_SIZE])) {
        B2WARNING("Fixed frame type size does not match specs" << LogVar("expected length",
                  len) << LogVar("length in data", s));
      }
      m_errorMask[c_nrFIX_SIZE] = true;
      if (!m_continueOnError) return;
    }
  }
 
  // What do we do with wrong checksum frames? As we do not know WHAT is wrong, we have to skip them altogether.
  // As they might contain HEADER Info, we might better skip the processing of the full package, too.
  dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
  if (!m_continueOnError && m_errorMask[c_nrDHE_CRC]) {
    // if CRC is wrong, we cannot rely on the content of the frame, thus skipping is the best option
    return;
  }
 
  unsigned int eventNrOfThisFrame = dhc.getEventNrLo();
  int frame_type = dhc.getFrameType();
 
  if (Frame_Number == 0) { 
    if (m_formatBonnDAQ) {
      if (frame_type != EDHCFrameHeaderDataType::c_DHC_START) {
        if (!(m_suppressErrorMask[c_nrEVENT_STRUCT])) B2WARNING("This looks not like BonnDAQ format.");
        m_errorMask[c_nrEVENT_STRUCT] = true;
//         if (!m_continueOnError) return; // requires more testing
      }
    } else {
      if (frame_type == EDHCFrameHeaderDataType::c_DHC_START) {
        if (!(m_suppressErrorMask[c_nrEVENT_STRUCT]))
          B2WARNING("This looks like BonnDAQ or old Desy 2013/14 testbeam format. Please use formatBonnDAQ or the pxdUnpackerDesy1314 module.");
        m_errorMask[c_nrEVENT_STRUCT] = true;
//         if (!m_continueOnError) return; // requires more testing
      }
    }
  }
 
  if (!m_formatBonnDAQ) {
    if (Frame_Number == 1) {
      if (frame_type == EDHCFrameHeaderDataType::c_DHC_START) {
        isFakedData_event = dhc.data_dhc_start_frame->isFakedData();
      }
    }
 
    // please check if this mask is suitable. At least here we are limited by the 16 bit trigger number in the DHH packet header.
    // we can use more bits in the DHC and DHE START Frame
    if ((eventNrOfThisFrame & 0xFFFF) != (m_meta_event_nr & 0xFFFF)) {
      if (!isFakedData_event) {
        if (!(m_suppressErrorMask[c_nrMETA_MM])) {
          B2WARNING("Event Numbers do not match for this frame");
          B2DEBUG(29, "Event Numbers do not match for this frame" <<
                  LogVar("Event nr in frame $", static_cast < std::ostringstream
                         && >(std::ostringstream() << hex << eventNrOfThisFrame).str()) <<
                  LogVar("Event nr in MetaInfo (bits masked) $",
                         static_cast < std::ostringstream && >(std::ostringstream() << hex << m_meta_event_nr).str()));
        }
        m_errorMask[c_nrMETA_MM] = true;
//         if (!m_continueOnError) return; // requires more testing
      }
    }
 
    if (Frame_Number > 1 && Frame_Number < Frames_in_event - 1) {
      if (countedDHEStartFrames != countedDHEEndFrames + 1)
        if (frame_type != EDHCFrameHeaderDataType::c_ONSEN_ROI && frame_type != EDHCFrameHeaderDataType::c_DHE_START) {
          if (!(m_suppressErrorMask[c_nrDATA_OUTSIDE])) B2WARNING("Data Frame outside a DHE START/END");
          m_errorMask[c_nrDATA_OUTSIDE] = true;
//           if (!m_continueOnError) return; // requires more testing
        }
    }
  }
 
  // TODO How do we handle Frames where Error Bit is set in header?
  // Currently there is no documentation what it actually means... only an error bit is set (below)
  // the following errors must be "accepted", as all firmware sets it wrong from Ghost frames.
  if (hw->getErrorFlag()) {
    if (frame_type != EDHCFrameHeaderDataType::c_GHOST) {
      // We get ERROR bits in header even if only one module or DHP link is missing... thus
      // we better filter a bit more ... but how?
      if (!(m_suppressErrorMask[c_nrHEADER_ERR])) B2WARNING("Error Bit set in DHE Header");
      m_errorMask[c_nrHEADER_ERR] = true;// TODO this should have some effect ... when does it mean something? documentation missing
    }
  } else {
    if (frame_type == EDHCFrameHeaderDataType::c_GHOST) {
      m_errorMask[c_nrHEADER_ERR_GHOST] = true;
    }
  }
 
  switch (frame_type) {
    case EDHCFrameHeaderDataType::c_DHP_RAW: {
 
      if (m_verbose) dhc.data_direct_readout_frame_raw->print();
      if (currentDHEID != dhc.data_direct_readout_frame_raw->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
          B2WARNING("DHE ID from DHE Start and this frame do not match");
          B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
                  LogVar("DHEID in this frame $", static_cast < std::ostringstream
                         && >(std::ostringstream() << hex << dhc.data_direct_readout_frame_raw->getDHEId()).str()) <<
                  LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
        }
        m_errorMask[c_nrDHE_START_ID] = true;
      }
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      if ((found_mask_active_dhp & (1 << dhc.data_direct_readout_frame->getDHPPort())) != 0) {
        B2ERROR("Second DHP data packet (MEMDUMP) for " << LogVar("DHE", currentDHEID) << LogVar("DHP",
                dhc.data_direct_readout_frame->getDHPPort()));
      }
 
      found_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();
 
      unpack_dhp_raw(data, len - 4,
                     dhc.data_direct_readout_frame->getDHEId(),
                     dhc.data_direct_readout_frame->getDHPPort(),
                     currentVxdId);
 
      break;
    };
    case EDHCFrameHeaderDataType::c_ONSEN_DHP:
      // Set the counted size invalid if negative, needs a large negative value because we are adding up to that
      cancheck_countedBytesInDHC = false;
      cancheck_countedBytesInDHE = false;
      [[fallthrough]];
    case EDHCFrameHeaderDataType::c_DHP_ZSD: {
 
      if (m_verbose) dhc.data_direct_readout_frame->print();
      if (isUnfiltered_event) {
        if (frame_type == EDHCFrameHeaderDataType::c_ONSEN_DHP) m_errorMask[c_nrSENDALL_TYPE] = true;
      } else {
        if (frame_type == EDHCFrameHeaderDataType::c_DHP_ZSD) m_errorMask[c_nrNOTSENDALL_TYPE] = true;
      }
 
      //m_errorMask |= dhc.data_direct_readout_frame->check_error();
 
      if (currentDHEID != dhc.data_direct_readout_frame_raw->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
          B2WARNING("DHE ID from DHE Start and this frame do not match");
          B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
                  LogVar("DHEID in this frame $", static_cast < std::ostringstream
                         && >(std::ostringstream() << hex << dhc.data_direct_readout_frame_raw->getDHEId()).str()) <<
                  LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
        }
        m_errorMask[c_nrDHE_START_ID] = true;
      }
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      if ((found_mask_active_dhp & (1 << dhc.data_direct_readout_frame->getDHPPort())) != 0) {
        B2ERROR("Second DHP data packet for " << LogVar("DHE", currentDHEID) << LogVar("DHP", dhc.data_direct_readout_frame->getDHPPort()));
      }
      found_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();
      found_good_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();// only this frametype has useful data
      if (m_checkPaddingCRC) dhc.check_padding(m_errorMask); // isUnfiltered_event
 
 
      unpack_dhp(data, len - 4,
                 dhe_first_readout_frame_id_lo,
                 dhc.data_direct_readout_frame->getDHEId(),
                 dhc.data_direct_readout_frame->getDHPPort(),
                 dhc.data_direct_readout_frame->getDataReformattedFlag(),
                 currentVxdId, daqpktstat);
 
      break;
    };
    case EDHCFrameHeaderDataType::c_ONSEN_FCE:
      // Set the counted size invalid if negative, needs a large negative value because we are adding up to that
      cancheck_countedBytesInDHC = false;
      cancheck_countedBytesInDHE = false;
      [[fallthrough]];
    case EDHCFrameHeaderDataType::c_FCE_RAW: {
      if (!(m_suppressErrorMask[c_nrUNEXPECTED_FRAME_TYPE])) B2WARNING("Unexpected Frame Type (Clustering FCE)");
      m_errorMask[c_nrUNEXPECTED_FRAME_TYPE] = true;
      if (m_verbose) hw->print();
      if (isUnfiltered_event) {
        if (frame_type == EDHCFrameHeaderDataType::c_ONSEN_FCE) {
          // TODO add error message
          m_errorMask[c_nrSENDALL_TYPE] = true;
        }
      } else {
        if (frame_type == EDHCFrameHeaderDataType::c_FCE_RAW) {
          // TODO add error message
          m_errorMask[c_nrNOTSENDALL_TYPE] = true;
        }
      }
 
      if (currentDHEID != dhc.data_direct_readout_frame_raw->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
          B2WARNING("DHE ID from DHE Start and this frame do not match");
          B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
                  LogVar("DHEID in this frame $", static_cast < std::ostringstream
                         && >(std::ostringstream() << hex << dhc.data_direct_readout_frame_raw->getDHEId()).str()) <<
                  LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
        }
        m_errorMask[c_nrDHE_START_ID] = true;
      }
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      if ((found_mask_active_dhp & (1 << dhc.data_direct_readout_frame->getDHPPort())) != 0) {
        B2ERROR("Second DHP data packet (FCE) for " << LogVar("DHE", currentDHEID) << LogVar("DHP",
                dhc.data_direct_readout_frame->getDHPPort()));
      }
      found_mask_active_dhp |= 1 << dhc.data_direct_readout_frame->getDHPPort();
 
      B2DEBUG(29, "UNPACK FCE FRAME with len $" << hex << len);
      unpack_fce((unsigned short*) data, len - 4, currentVxdId);
 
      break;
    };
    case EDHCFrameHeaderDataType::c_COMMODE: {
      // this frame type has up to now not been well defined, we do not expect it until
      // the firmware supports clustering in hardware
      if (!(m_suppressErrorMask[c_nrUNEXPECTED_FRAME_TYPE])) B2WARNING("Unexpected Frame Type (COMMODE)");
      m_errorMask[c_nrUNEXPECTED_FRAME_TYPE] = true;
 
      if (m_verbose) hw->print();
      if (currentDHEID != dhc.data_commode_frame->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
          B2WARNING("DHE ID from DHE Start and this frame do not match");
          B2DEBUG(29, "DHE ID from DHE Start and this frame do not match" <<
                  LogVar("DHEID in this frame $", static_cast < std::ostringstream
                         && >(std::ostringstream() << hex << dhc.data_commode_frame->getDHEId()).str()) <<
                  LogVar("DHEID expected $", static_cast < std::ostringstream && >(std::ostringstream() << hex << currentDHEID).str()));
        }
        m_errorMask[c_nrDHE_START_ID] = true;
      }
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      break;
    };
    case EDHCFrameHeaderDataType::c_DHC_START: {
      countedBytesInDHC = 0;
      cancheck_countedBytesInDHC = true;
      if (isFakedData_event != dhc.data_dhc_start_frame->isFakedData()) {
        if (!(m_suppressErrorMask[c_nrFAKE_NO_FAKE_DATA])) B2WARNING("DHC START mixed Fake/no Fake event.");
        m_errorMask[c_nrFAKE_NO_FAKE_DATA] = true;
      }
      if (dhc.data_dhc_start_frame->isFakedData()) {
        if (!(m_suppressErrorMask[c_nrFAKE_NO_DATA_TRIG])) B2WARNING("Faked DHC START Data -> trigger without Data!");
        m_errorMask[c_nrFAKE_NO_DATA_TRIG] = true;
      } else {
        if (m_verbose) dhc.data_dhc_start_frame->print();
      }
 
//      eventNrOfOnsenTrgFrame = eventNrOfThisFrame;
      currentDHEID = 0xFFFFFFFF;
      currentVxdId = 0; 
      currentDHCID = dhc.data_dhc_start_frame->get_dhc_id();
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
 
      if (m_formatBonnDAQ) eventNrOfOnsenTrgFrame = eventNrOfThisFrame;
 
      if (!isFakedData_event) {
        if (dhc.data_dhc_start_frame->get_experiment() != m_meta_experiment) {
          if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_ERS])) {
            B2WARNING("DHC-Meta Experiment number mismatch");
            B2DEBUG(29, "DHC-Meta Experiment number mismatch" <<
                    LogVar("DHC exp nr",
                           dhc.data_dhc_start_frame->get_experiment()) <<
                    LogVar("META exp nr", m_meta_experiment));
          }
          m_errorMask[c_nrMETA_MM_DHC_ERS] = true;
        }
        if (dhc.data_dhc_start_frame->get_run() != m_meta_run_nr) {
          if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_ERS])) {
            B2WARNING("DHC-Meta Run number mismatch");
            B2DEBUG(29, "DHC-Meta Run number mismatch" <<
                    LogVar("DHC Run nr",
                           dhc.data_dhc_start_frame->get_run()) <<
                    LogVar("META run nr", m_meta_run_nr));
          }
          m_errorMask[c_nrMETA_MM_DHC_ERS] = true;
        }
        if (dhc.data_dhc_start_frame->get_subrun() != m_meta_subrun_nr) {
          if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_ERS])) {
            B2WARNING("DHC-Meta Sub-Run number mismatch");
            B2DEBUG(29, "DHC-Meta Sub-Run number mismatch" <<
                    LogVar("DHC subrun nr",
                           dhc.data_dhc_start_frame->get_subrun()) <<
                    LogVar("META subrun nr", m_meta_subrun_nr));
          }
          m_errorMask[c_nrMETA_MM_DHC_ERS] = true;
        }
        if ((((unsigned int)dhc.data_dhc_start_frame->getEventNrHi() << 16) | dhc.data_dhc_start_frame->getEventNrLo()) !=
            (m_meta_event_nr & 0xFFFFFFFF)) {
          if (!(m_suppressErrorMask[c_nrMETA_MM_DHC])) {
            B2WARNING("DHC-Meta 32 bit event number mismatch");
            B2DEBUG(29, "DHC-Meta 32 bit event number mismatch" <<
                    LogVar("DHC trigger nr", (((unsigned int) dhc.data_dhc_start_frame->getEventNrHi() << 16) |
                                              dhc.data_dhc_start_frame->getEventNrLo())) <<
                    LogVar("META trigger nr", (unsigned int)(m_meta_event_nr & 0xFFFFFFFF)));
          }
          m_errorMask[c_nrMETA_MM_DHC] = true;
        }
        uint32_t trig_ticks = (((unsigned int)dhc.data_dhc_start_frame->time_tag_mid & 0x7FFF) << 12) | ((unsigned int)
                              dhc.data_dhc_start_frame->time_tag_lo_and_type >> 4);
        uint32_t trig_sec = (dhc.data_dhc_start_frame->time_tag_hi * 2) ;
        if (dhc.data_dhc_start_frame->time_tag_mid & 0x8000) trig_sec++;
 
        if ((trig_ticks - m_meta_ticks) != 0 || (trig_sec - m_meta_sec) != 0) {
          m_errorMask[c_nrMETA_MM_DHC_TT] = true;
          if (!(m_suppressErrorMask[c_nrMETA_MM_DHC_TT])) {
            B2WARNING("DHC-Meta TimeTag mismatch");
            B2DEBUG(29, "DHC-Meta TimeTag mismatch" <<
                    LogVar("Header Time $", static_cast < std::ostringstream && >(std::ostringstream() <<
                           hex << dhc.data_dhc_start_frame->time_tag_hi << "." <<
                           dhc.data_dhc_start_frame->time_tag_mid << "." <<
                           dhc.data_dhc_start_frame->time_tag_lo_and_type).str()) <<
                    LogVar("Meta Time $", static_cast < std::ostringstream && >(std::ostringstream() << hex << m_meta_time).str()) <<
                    LogVar("Trigger Type",  static_cast < std::ostringstream
                           && >(std::ostringstream() << hex << (dhc.data_dhc_start_frame->time_tag_lo_and_type & 0xF)).str()) <<
                    LogVar("Meta seconds: $", static_cast < std::ostringstream && >(std::ostringstream() <<  hex << m_meta_sec).str()) <<
                    LogVar("DHC seconds $", static_cast < std::ostringstream && >(std::ostringstream() <<  hex << trig_sec).str()) <<
                    LogVar("Seconds difference $", static_cast < std::ostringstream
                           && >(std::ostringstream() << hex << (trig_sec - m_meta_sec)).str()) <<
                    LogVar("Meta ticks from 127MHz $", static_cast < std::ostringstream && >(std::ostringstream() <<  hex << m_meta_ticks).str()) <<
                    LogVar("DHC ticks from 127MHz $", static_cast < std::ostringstream && >(std::ostringstream() << hex << trig_ticks).str()) <<
                    LogVar("Tick difference $", static_cast < std::ostringstream
                           && >(std::ostringstream() << hex << (trig_ticks - m_meta_ticks)).str()));
          }
        } else {
          B2DEBUG(29, "DHC TT: $" << hex << dhc.data_dhc_start_frame->time_tag_hi << "." << dhc.data_dhc_start_frame->time_tag_mid << "." <<
                  dhc.data_dhc_start_frame->time_tag_lo_and_type << " META " << m_meta_time << " TRG Type " <<
                  (dhc.data_dhc_start_frame->time_tag_lo_and_type & 0xF));
        }
      }
      mask_active_dhe = dhc.data_dhc_start_frame->get_active_dhe_mask();
      nr_active_dhe = nr5bits(mask_active_dhe);
 
      m_errorMaskDHC = m_errorMask; // forget about anything before this frame
      daqpktstat.newDHC(currentDHCID, m_errorMask);
      daqpktstat.dhc_back().setGatedFlag(dhc.data_dhc_start_frame->get_gated_flag());
      daqpktstat.dhc_back().setGatedHER(dhc.data_dhc_start_frame->get_gated_isher());
 
      break;
    };
    case EDHCFrameHeaderDataType::c_DHE_START: {
      countedBytesInDHE = 0;
      cancheck_countedBytesInDHE = true;
      m_last_dhp_readout_frame_lo[0] = -1;
      m_last_dhp_readout_frame_lo[1] = -1;
      m_last_dhp_readout_frame_lo[2] = -1;
      m_last_dhp_readout_frame_lo[3] = -1;
      if (m_verbose) dhc.data_dhe_start_frame->print();
      dhe_first_readout_frame_id_lo = dhc.data_dhe_start_frame->getStartFrameNr();
      dhe_first_triggergate = dhc.data_dhe_start_frame->getTriggerGate();
      if (currentDHEID != 0xFFFFFFFF && (currentDHEID & 0xFFFF) >= dhc.data_dhe_start_frame->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_WRONG_ID_SEQ])) {
          B2WARNING("DHH IDs are not in expected order");
          B2DEBUG(29, "DHH IDs are not in expected order" <<
                  LogVar("Previous ID", (currentDHEID & 0xFFFF)) <<
                  LogVar("Current ID", dhc.data_dhe_start_frame->getDHEId()));
        }
        m_errorMask[c_nrDHE_WRONG_ID_SEQ] = true;
      }
      currentDHEID = dhc.data_dhe_start_frame->getDHEId();
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
 
      if (countedDHEStartFrames > countedDHEEndFrames) {
        if (!(m_suppressErrorMask[c_nrDHE_START_WO_END])) B2WARNING("DHE_START without DHE_END");
        m_errorMask[c_nrDHE_START_WO_END] = true;
      }
      countedDHEStartFrames++;
 
      found_mask_active_dhp = 0;
      found_good_mask_active_dhp = 0;
      mask_active_dhp = dhc.data_dhe_start_frame->getActiveDHPMask();
 
      if ((((unsigned int)dhc.data_dhe_start_frame->getEventNrHi() << 16) | dhc.data_dhe_start_frame->getEventNrLo()) != (unsigned int)(
            m_meta_event_nr & 0xFFFFFFFF)) {
        if (!(m_suppressErrorMask[c_nrMETA_MM_DHE])) {
          B2WARNING("DHE START trigger mismatch in EVT32b/HI WORD");
          B2DEBUG(29, "DHE START trigger mismatch in EVT32b/HI WORD" <<
                  LogVar("DHE Start trigger nr", (dhc.data_dhe_start_frame->getEventNrHi() << 16) | dhc.data_dhe_start_frame->getEventNrLo()) <<
                  LogVar("Meta trigger nr", (m_meta_event_nr & 0xFFFFFFFF)));
        }
        m_errorMask[c_nrMETA_MM_DHE] = true;
      }
//        B2WARNING("DHE TT: $" << hex << dhc.data_dhe_start_frame->dhe_time_tag_hi << "." << dhc.data_dhe_start_frame->dhe_time_tag_lo <<
//                " META " << m_meta_time);
 
      if (currentDHEID == 0) {
        if (!(m_suppressErrorMask[c_nrDHE_ID_INVALID])) B2WARNING("DHE ID is invalid=0 (not initialized)");
        m_errorMask[c_nrDHE_ID_INVALID] = true;
      }
      // calculate the VXDID for DHE and save them for DHP unpacking
      {
        unsigned short sensor, ladder, layer;
        sensor = (currentDHEID & 0x1) + 1;
        ladder = (currentDHEID & 0x1E) >> 1; // no +1
        layer = ((currentDHEID & 0x20) >> 5) + 1;
        currentVxdId = VxdID(layer, ladder, sensor);
        if (ladder == 0 || (layer == 1 && ladder > 8) || (layer == 2 && ladder > 12)) {
          if (!(m_suppressErrorMask[c_nrDHE_ID_INVALID])) {
            B2WARNING("DHE ID is invalid");
            B2DEBUG(29, "DHE ID is invalid" <<
                    LogVar("DHE ID", currentDHEID) <<
                    LogVar("Layer", layer) <<
                    LogVar("Ladder", ladder) <<
                    LogVar("Sensor", sensor));
          }
          m_errorMask[c_nrDHE_ID_INVALID] = true;
        }
      }
 
      m_errorMaskDHE = m_errorMask; // forget about anything before this frame
      if (daqpktstat.dhc_size() > 0) {
        // if no DHC has been defined yet, do nothing!
        daqpktstat.dhc_back().newDHE(currentVxdId, currentDHEID, m_errorMask, dhe_first_triggergate, dhe_first_readout_frame_id_lo);
      }
      break;
    };
    case EDHCFrameHeaderDataType::c_GHOST:
      if (m_verbose) dhc.data_ghost_frame->print();
      if (currentDHEID != dhc.data_ghost_frame->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_START_ID])) {
          B2WARNING("DHE ID from DHE Start and this frame do not match");
          B2DEBUG(29, "Start ID $" << hex << currentDHEID << " != $" << dhc.data_ghost_frame->getDHEId());
        }
        m_errorMask[c_nrDHE_START_ID] = true;
      }
      if ((found_mask_active_dhp & (1 << dhc.data_ghost_frame->getDHPPort())) != 0) {
        B2ERROR("Second DHP data packet (GHOST) for " << LogVar("DHE", currentDHEID) << LogVar("DHP", dhc.data_ghost_frame->getDHPPort()));
      }
      found_mask_active_dhp |= 1 << dhc.data_ghost_frame->getDHPPort();
 
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
 
      break;
    case EDHCFrameHeaderDataType::c_DHC_END: {
      if (dhc.data_dhc_end_frame->isFakedData() != isFakedData_event) {
        if (!(m_suppressErrorMask[c_nrFAKE_NO_FAKE_DATA])) B2WARNING("DHC END mixed Fake/no Fake event.");
        m_errorMask[c_nrFAKE_NO_FAKE_DATA] = true;
      }
      if (dhc.data_dhc_end_frame->isFakedData()) {
        if (!(m_suppressErrorMask[c_nrFAKE_NO_DATA_TRIG])) B2WARNING("Faked DHC END Data -> trigger without Data!");
        m_errorMask[c_nrFAKE_NO_DATA_TRIG] = true;
      } else {
        if (m_verbose) dhc.data_dhc_end_frame->print();
      }
 
      if (!isFakedData_event) {
        if (dhc.data_dhc_end_frame->get_dhc_id() != currentDHCID) {
          if (!(m_suppressErrorMask[c_nrDHC_DHCID_START_END_MM])) {
            B2WARNING("DHC ID Mismatch between Start and End");
            B2DEBUG(29, "DHC ID Mismatch between Start and End $" << std::hex <<
                    currentDHCID << "!=$" << dhc.data_dhc_end_frame->get_dhc_id());
          }
          m_errorMask[c_nrDHC_DHCID_START_END_MM] = true;
        }
        int w;
        w = dhc.data_dhc_end_frame->get_words() * 4;
        if (cancheck_countedBytesInDHC) {
          if (countedBytesInDHC != w) {
            if (!(m_suppressErrorMask[c_nrDHC_WIE])) {
              B2WARNING("Number of Words in DHC END does not match");
              B2DEBUG(29, "Number of Words in DHC END does not match: WIE $" << hex << countedBytesInDHC << " != DHC END $" << hex << w);
            }
            m_errorMask[c_nrDHC_WIE] = true;
          } else {
            if (m_verbose)
              B2DEBUG(29, "EVT END: WIE $" << hex << countedBytesInDHC << " == DHC END $" << hex << w);
          }
          // else ... processed data -> length invalid
        }
      }
      if (dhc.data_dhc_end_frame->getErrorInfo() != 0) {
        if (!(m_suppressErrorMask[c_nrDHH_END_ERRORBITS])) B2ERROR("DHC END Error Info set to $" << hex <<
                                                                     dhc.data_dhc_end_frame->getErrorInfo());
        m_errorMask[c_nrDHH_END_ERRORBITS] = true;
      }
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      m_errorMaskDHC |= m_errorMask; // do latest updates
 
      if (daqpktstat.dhc_size() > 0) {
        // only is we have a DHC object... or back() is undefined
        // Remark, if we have a broken data (DHC_START/END) structure, we might fill the
        // previous DHC object ... but then the data is junk anyway
        daqpktstat.dhc_back().setErrorMask(m_errorMaskDHC);
        //B2DEBUG(98,"** DHC "<<currentDHCID<<" Raw"<<dhc.data_dhc_end_frame->get_words() * 4 <<" Red"<<countedBytesInDHC);
        daqpktstat.dhc_back().setCounters(dhc.data_dhc_end_frame->get_words() * 4, countedBytesInDHC);
        daqpktstat.dhc_back().setEndErrorInfo(dhc.data_dhc_end_frame->getErrorInfo());
      }
      m_errorMaskDHC = 0;
      currentDHEID = 0xFFFFFFFF;
      currentDHCID = 0xFFFFFFFF;
      currentVxdId = 0; 
      break;
    };
    case EDHCFrameHeaderDataType::c_DHE_END: {
      if (m_verbose) dhc.data_dhe_end_frame->print();
      if (currentDHEID != dhc.data_dhe_end_frame->getDHEId()) {
        if (!(m_suppressErrorMask[c_nrDHE_START_END_ID])) {
          B2WARNING("DHE ID from DHE Start and this frame do not match");
          B2DEBUG(29, "DHE ID from DHE Start and this frame do not match $" << hex << currentDHEID << " != $" <<
                  dhc.data_dhe_end_frame->getDHEId());
        }
        m_errorMask[c_nrDHE_START_END_ID] = true;
      }
      if (dhc.data_dhe_end_frame->getErrorInfo() != 0) {
        if (!(m_suppressErrorMask[c_nrDHH_END_ERRORBITS])) {
          B2ERROR("DHE END Error Info set to $" << hex << dhc.data_dhe_end_frame->getErrorInfo());
        }
        m_errorMask[c_nrDHH_END_ERRORBITS] = true;
      }
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      if (found_mask_active_dhp != mask_active_dhp) {
        if (!(m_suppressErrorMask[c_nrDHP_ACTIVE])) {
          B2WARNING("DHE_END: DHP active mask differs from found data");
          B2DEBUG(29, "DHE_END: DHP active mask differs from found data $" << hex << mask_active_dhp << " != $" << hex <<
                  found_mask_active_dhp
                  << " mask of found dhp/ghost frames");
        }
        m_errorMask[c_nrDHP_ACTIVE] = true;
      }
      countedDHEEndFrames++;
      if (countedDHEStartFrames < countedDHEEndFrames) {
        // the other case is checked in Start
        if (!(m_suppressErrorMask[c_nrDHE_END_WO_START])) B2WARNING("DHE_END without DHE_START");
        m_errorMask[c_nrDHE_END_WO_START] = true;
      }
      {
        int w;
        w = dhc.data_dhe_end_frame->get_words() * 2;
        if (cancheck_countedBytesInDHE) {
          if (countedBytesInDHE != w) {
            if (!(m_suppressErrorMask[c_nrDHE_WIE])) {
              B2WARNING("Number of Words in DHE END does not match");
              B2DEBUG(29, "Number of Words in DHE END does not match: WIE $" << hex << countedBytesInDHE << " != DHE END $" << hex << w);
            }
            m_errorMask[c_nrDHE_WIE] = true;
          } else {
            if (m_verbose)
              B2DEBUG(29, "EVT END: WIE $" << hex << countedBytesInDHE << " == DHE END $" << hex << w);
          }
          // else ... processed data -> length invalid
        }
      }
      m_errorMaskDHE |= m_errorMask; // do latest updates
 
      if (daqpktstat.dhc_size() > 0) {
        if (daqpktstat.dhc_back().dhe_size() > 0) {
          // only is we have a DHC and DHE object... or back() is undefined
          // Remark, if we have a broken data (DHE_START/END) structure, we might fill the
          // previous DHE object ... but then the data is junk anyway
          daqpktstat.dhc_back().dhe_back().setErrorMask(m_errorMaskDHE);
          // B2DEBUG(98,"** DHC "<<currentDHEID<<" Raw "<<dhc.data_dhe_end_frame->get_words() * 2 <<" Red"<<countedBytesInDHE);
          daqpktstat.dhc_back().dhe_back().setCounters(dhc.data_dhe_end_frame->get_words() * 2, countedBytesInDHE);
          daqpktstat.dhc_back().dhe_back().setDHPFoundMask(found_good_mask_active_dhp);
          daqpktstat.dhc_back().dhe_back().setEndErrorInfo(dhc.data_dhe_end_frame->getErrorInfo());
        }
      }
      m_errorMaskDHE = 0;
      currentDHEID |= 0xFF000000;// differentiate from 0xFFFFFFFFF as initial value
      currentVxdId = 0; 
      break;
    };
    case EDHCFrameHeaderDataType::c_ONSEN_ROI:
      if (m_verbose) dhc.data_onsen_roi_frame->print();
      dhc.data_onsen_roi_frame->check_error(m_errorMask, len, m_suppressErrorMask[c_nrROI_PACKET_INV_SIZE]);
      dhc.data_onsen_roi_frame->check_inner_crc(m_errorMask, len - 4); 
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      if (!m_doNotStore) {
        //dhc.data_onsen_roi_frame->save(m_storeROIs, len, (unsigned int*) data);
        // void save(StoreArray<PXDRawROIs>& sa, unsigned int length, unsigned int* data) const
        // 4 byte header, ROIS (n*8), 4 byte copy of inner CRC, 4 byte outer CRC
        if (len >= dhc.data_onsen_roi_frame->getMinSize()) {
          //if ((len - dhc.data_onsen_roi_frame->getMinSize()) % 8 != 0) {
          // error checking in check_error() above, this is only for dump-ing
          // dump_roi(data, len - 4); // dump ROI payload, minus CRC
          //}
          unsigned int l;
          l = (len - dhc.data_onsen_roi_frame->getMinSize()) / 8;
          // Endian swapping is done in Constructor of RawRoi object
          m_storeROIs.appendNew(l, &((unsigned int*) data)[1]);
        }
      }
      break;
    case EDHCFrameHeaderDataType::c_ONSEN_TRG:
      eventNrOfOnsenTrgFrame = eventNrOfThisFrame;
      if (dhc.data_onsen_trigger_frame->get_trig_nr1() != (unsigned int)(m_meta_event_nr & 0xFFFFFFFF)) {
        if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_HLT])) {
          B2WARNING("Trigger Frame HLT Trigger Nr mismatch");
          B2DEBUG(29, "Trigger Frame HLT Trigger Nr mismatch: HLT $" <<
                  dhc.data_onsen_trigger_frame->get_trig_nr1() << " META " << (m_meta_event_nr & 0xFFFFFFFF));
        }
        m_errorMask[c_nrMETA_MM_ONS_HLT] = true;
      }
      if (dhc.data_onsen_trigger_frame->get_experiment1() != m_meta_experiment ||
          dhc.data_onsen_trigger_frame->get_run1() != m_meta_run_nr ||
          dhc.data_onsen_trigger_frame->get_subrun1() != m_meta_subrun_nr) {
        if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_HLT])) {
          B2WARNING("Trigger Frame HLT Exp/Run/Subrun Nr mismatch");
          B2DEBUG(29, "Trigger Frame HLT Exp/Run/Subrun Nr mismatch: Exp HLT $" <<
                  dhc.data_onsen_trigger_frame->get_experiment1() << " META " <<  m_meta_experiment <<
                  " Run HLT $" << dhc.data_onsen_trigger_frame->get_run1()  << " META " << m_meta_run_nr <<
                  " Subrun HLT $" << dhc.data_onsen_trigger_frame->get_subrun1() << " META " <<  m_meta_subrun_nr);
        }
        m_errorMask[c_nrMETA_MM_ONS_HLT] = true;
      }
 
      if (!dhc.data_onsen_trigger_frame->is_fake_datcon()) {
        if (dhc.data_onsen_trigger_frame->get_trig_nr2() != (unsigned int)(m_meta_event_nr & 0xFFFFFFFF)) {
          if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_DC])) {
            B2WARNING("Trigger Frame DATCON Trigger Nr mismatch");
            B2DEBUG(29, "Trigger Frame DATCON Trigger Nr mismatch: DC $" <<
                    dhc.data_onsen_trigger_frame->get_trig_nr2() << " META " << (m_meta_event_nr & 0xFFFFFFFF));
          }
          m_errorMask[c_nrMETA_MM_ONS_DC] = true;
        }
        if (dhc.data_onsen_trigger_frame->get_experiment2() != m_meta_experiment ||
            dhc.data_onsen_trigger_frame->get_run2() != m_meta_run_nr ||
            dhc.data_onsen_trigger_frame->get_subrun2() != m_meta_subrun_nr) {
          if (!(m_suppressErrorMask[c_nrMETA_MM_ONS_DC])) {
            B2WARNING("Trigger Frame DATCON Exp/Run/Subrun Nr mismatch");
            B2DEBUG(29, "Trigger Frame DATCON Exp/Run/Subrun Nr mismatch: Exp DC $" <<
                    dhc.data_onsen_trigger_frame->get_experiment2() << " META " <<  m_meta_experiment <<
                    " Run DC $" << dhc.data_onsen_trigger_frame->get_run2() << " META " <<  m_meta_run_nr <<
                    " Subrun DC $" << dhc.data_onsen_trigger_frame->get_subrun2() << " META " << m_meta_subrun_nr);
          }
          m_errorMask[c_nrMETA_MM_ONS_DC] = true;
        }
      }
 
//       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);
 
      if (m_verbose) dhc.data_onsen_trigger_frame->print();
      dhc.data_onsen_trigger_frame->check_error(m_errorMask, m_suppressErrorMask[c_nrNO_DATCON], m_suppressErrorMask[c_nrHLTROI_MAGIC],
                                                m_suppressErrorMask[c_nrMERGER_TRIGNR]);
      dhc.check_crc(m_errorMask, m_suppressErrorMask[c_nrDHE_CRC]);
      if (Frame_Number != 0) {
        if (!(m_suppressErrorMask[c_nrEVENT_STRUCT])) B2WARNING("ONSEN TRG Frame must be the first one.");
        m_errorMask[c_nrEVENT_STRUCT] = true;
      }
      isUnfiltered_event = dhc.data_onsen_trigger_frame->is_SendUnfiltered();
      if (isUnfiltered_event) m_sendunfiltered++;
      if (dhc.data_onsen_trigger_frame->is_SendROIs()) m_sendrois++;
      if (!dhc.data_onsen_trigger_frame->is_Accepted()) m_notaccepted++;
      break;
    default:
      if (!(m_suppressErrorMask[c_nrDHC_UNKNOWN])) B2WARNING("UNKNOWN DHC frame type");
      m_errorMask[c_nrDHC_UNKNOWN] = true;
      if (m_verbose) hw->print();
      break;
  }
 
  if (eventNrOfThisFrame != eventNrOfOnsenTrgFrame && !isFakedData_event) {
    if (!(m_suppressErrorMask[c_nrFRAME_TNR_MM])) {
      B2WARNING("Frame TrigNr != ONSEN Trig Nr");
      B2DEBUG(29, "Frame TrigNr != ONSEN Trig Nr $" << hex << eventNrOfThisFrame << " != $" << eventNrOfOnsenTrgFrame);
    }
    m_errorMask[c_nrFRAME_TNR_MM] = true;
  }
 
  if (Frame_Number == 0) {
    if (frame_type != EDHCFrameHeaderDataType::c_ONSEN_TRG) {
      if (!m_formatBonnDAQ) {
        if (!(m_suppressErrorMask[c_nrONSEN_TRG_FIRST])) B2WARNING("First frame is not a ONSEN Trigger frame");
        m_errorMask[c_nrONSEN_TRG_FIRST] = true;
      }
    }
  } else { // (Frame_Number != 0 &&
    if (frame_type == EDHCFrameHeaderDataType::c_ONSEN_TRG) {
      if (!(m_suppressErrorMask[c_nrONSEN_TRG_FIRST])) B2WARNING("More than one ONSEN Trigger frame");
      m_errorMask[c_nrONSEN_TRG_FIRST] = true;
    }
  }
 
  if (!m_formatBonnDAQ) {
    if (Frame_Number == 1) {
      if (frame_type != EDHCFrameHeaderDataType::c_DHC_START) {
        if (!(m_suppressErrorMask[c_nrDHC_START_SECOND])) B2WARNING("Second frame is not a DHC start of subevent frame");
        m_errorMask[c_nrDHC_START_SECOND] = true;
      }
    } else { // (Frame_Number != 0 &&
      if (frame_type == EDHCFrameHeaderDataType::c_DHC_START) {
        if (!(m_suppressErrorMask[c_nrDHC_START_SECOND])) B2WARNING("More than one DHC start of subevent frame");
        m_errorMask[c_nrDHC_START_SECOND] = true;
      }
    }
  }
 
  if (Frame_Number == Frames_in_event - 1) {
    if (frame_type != EDHCFrameHeaderDataType::c_DHC_END) {
      if (!(m_suppressErrorMask[c_nrDHC_END_MISS])) B2WARNING("Last frame is not a DHC end of subevent frame");
      m_errorMask[c_nrDHC_END_MISS] = true;
    }
    if (countedDHEStartFrames != countedDHEEndFrames || countedDHEStartFrames != nr_active_dhe) {
      if (!(m_suppressErrorMask[c_nrDHE_ACTIVE]) || !(m_suppressErrorMask[c_nrDHE_START_WO_END])
          || !(m_suppressErrorMask[c_nrDHE_END_WO_START])) {
        B2WARNING("The number of DHE Start/End does not match the number of active DHE in DHC Header!");
        B2DEBUG(29, "The number of DHE Start/End does not match the number of active DHE in DHC Header! Header: " << nr_active_dhe <<
                " Start: " << countedDHEStartFrames << " End: " << countedDHEEndFrames << " Mask: $" << hex << mask_active_dhe << " in Event Nr " <<
                eventNrOfThisFrame);
      }
      if (countedDHEStartFrames == countedDHEEndFrames) m_errorMask[c_nrDHE_ACTIVE] = true;
      if (countedDHEStartFrames > countedDHEEndFrames)  m_errorMask[c_nrDHE_START_WO_END] = true;
      if (countedDHEStartFrames < countedDHEEndFrames)  m_errorMask[c_nrDHE_END_WO_START] = true;
    }
 
  } else { //  (Frame_Number != Frames_in_event - 1 &&
    if (frame_type == EDHCFrameHeaderDataType::c_DHC_END) {
      if (!(m_suppressErrorMask[c_nrDHC_END_DBL])) B2WARNING("More than one DHC end of subevent frame");
      m_errorMask[c_nrDHC_END_DBL] = true;
    }
  }
 
  if (!m_formatBonnDAQ) {
    if (Frame_Number == 2 && nr_active_dhe != 0 && frame_type != EDHCFrameHeaderDataType::c_DHE_START) {
      if (!(m_suppressErrorMask[c_nrDHE_START_THIRD])) B2WARNING("Third frame is not a DHE start frame");
      m_errorMask[c_nrDHE_START_THIRD] = true;
    }
  }
 
  if (frame_type != EDHCFrameHeaderDataType::c_ONSEN_ROI  && frame_type != EDHCFrameHeaderDataType::c_ONSEN_TRG) {
    // actually, they should not be within Start and End, but better be sure.
    countedBytesInDHC += len;
    countedBytesInDHE += len;
  }
  B2DEBUG(29, "DHC/DHE $" << hex << countedBytesInDHC << ", $" << hex << countedBytesInDHE);
}

◆ 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

data	pointer to dhp data
len	length of dhp data
dhe_first_readout_frame_lo	16 bit of the first readout frame from DHE Start
dhe_ID	raw DHE ID from DHC frame
dhe_DHPport	raw DHP port from DHC frame
dhe_reformat	flag if DHE did reformatting
vxd_id	vertex Detector ID
daqpktstat	Daq Packet Status Object

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

Definition at line 445 of file PXDUnpackerOTModule.cc.

{
  unsigned int nr_words = frame_len / 2; // frame_len in bytes (excl. CRC)!!!
  ubig16_t* dhp_pix = (ubig16_t*)data;
 
  unsigned int dhp_readout_frame_lo = 0;
  unsigned int dhp_header_type  = 0;
  unsigned int dhp_reserved     = 0;
  unsigned int dhp_dhe_id       = 0;
  unsigned int dhp_dhp_id       = 0;
  unsigned int wrap = 0; // workaround to recalc a relative frame number
  int last_gate = -1; // workaround to recalc a relative frame number
 
  // cppcheck-suppress unreadVariable
  unsigned int dhp_row = 0, dhp_col = 0, dhp_cm = 0;
//   unsigned int dhp_offset = 0;
  bool rowflag = false;
  bool pixelflag = true; // just for first row start
 
  if (nr_words < 4) {
    if (!(m_suppressErrorMask[c_nrDHP_SIZE])) B2WARNING("DHP frame size error (too small)" << LogVar("Nr words", nr_words));
    m_errorMask[c_nrDHP_SIZE] = true;
    return;
  }
 
  B2DEBUG(29, "HEADER -- $" << hex << dhp_pix[0] << hex << dhp_pix[1] << hex << dhp_pix[2] << hex << dhp_pix[3] << " -- ");
 
  B2DEBUG(29, "DHP Header   | $" << hex << dhp_pix[2] << " ( " << dec << dhp_pix[2] << " ) ");
  dhp_header_type  = (dhp_pix[2] & 0xE000) >> 13;
  dhp_reserved     = (dhp_pix[2] & 0x1F00) >> 8;
  dhp_dhe_id       = (dhp_pix[2] & 0x00FC) >> 2;
  dhp_dhp_id       =  dhp_pix[2] & 0x0003;
 
  B2DEBUG(29, "DHP type     | $" << hex << dhp_header_type << " ( " << dec << dhp_header_type << " ) ");
  B2DEBUG(29, "DHP reserved | $" << hex << dhp_reserved << " ( " << dec << dhp_reserved << " ) ");
  B2DEBUG(29, "DHP DHE ID   | $" << hex << dhp_dhe_id << " ( " << dec << dhp_dhe_id << " ) ");
  B2DEBUG(29, "DHP DHP ID   | $" << hex << dhp_dhp_id << " ( " << dec << dhp_dhp_id << " ) ");
 
  if (dhe_ID != dhp_dhe_id) {
    if (!(m_suppressErrorMask[c_nrDHE_DHP_DHEID])) {
      B2WARNING("DHE ID in DHE and DHP header differ");
      B2DEBUG(29, "DHE ID in DHE and DHP header differ $" << hex << dhe_ID << " != $" << dhp_dhe_id);
    }
    m_errorMask[c_nrDHE_DHP_DHEID] = true;
  }
  if (dhe_DHPport != dhp_dhp_id) {
    if (!(m_suppressErrorMask[c_nrDHE_DHP_PORT])) {
      B2WARNING("DHP ID (Chip/Port) in DHE and DHP header differ");
      B2DEBUG(29, "DHP ID (Chip/Port) in DHE and DHP header differ $" << hex << dhe_DHPport << " != $" << dhp_dhp_id);
    }
    m_errorMask[c_nrDHE_DHP_PORT] = true;
  }
 
  if (dhp_header_type != EDHPFrameHeaderDataType::c_ZSD) {
    if (!(m_suppressErrorMask[c_nrHEADERTYPE_INV])) {
      B2WARNING("Header type invalid for this kind of DHE frame");
      B2DEBUG(29, "Header type invalid for this kind of DHE frame: $" << hex << dhp_header_type);
    }
    m_errorMask[c_nrHEADERTYPE_INV] = true;
    return;
  }
 
//  static int offtab[4] = {0, 64, 128, 192};
//   dhp_offset = offtab[dhp_dhp_id];
 
  dhp_readout_frame_lo  = dhp_pix[3] & 0xFFFF;
  B2DEBUG(29, "DHP Frame Nr     |  $" << hex << dhp_readout_frame_lo << " ( " << dec << dhp_readout_frame_lo << " ) ");
 
  /* // TODO removed because data format error is not to be fixed soon
  if (((dhp_readout_frame_lo - dhe_first_readout_frame_id_lo) & 0x3F) > m_maxDHPFrameDiff) {
    if(!m_suppressErrorMask&c_DHP_DHE_FRAME_DIFFER ) B2WARNING("DHP Frame Nr differ from DHE Frame Nr by >1 DHE " << dhe_first_readout_frame_id_lo << " != DHP " << (dhp_readout_frame_lo & 0x3F) << " delta "<< ((dhp_readout_frame_lo - dhe_first_readout_frame_id_lo) & 0x3F) );
    m_errorMask[c_nrDHP_DHE_FRAME_DIFFER] = true;
  }
  */
  /* // TODO removed because data format error is not to be fixed soon
    if (m_last_dhp_readout_frame_lo[dhp_dhp_id] != -1) {
    if (((dhp_readout_frame_lo - m_last_dhp_readout_frame_lo[dhp_dhp_id]) & 0xFFFF) > m_maxDHPFrameDiff) {
      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] << ", " <<
              dhp_readout_frame_lo);
      m_errorMask[c_nrDHP_NOT_CONT] = true;
    }
  }
  */
 
  if (daqpktstat.dhc_size() > 0) {
    if (daqpktstat.dhc_back().dhe_size() > 0) {
      // only is we have a DHC and DHE object... or back() is undefined
      // Remark, if we have a broken data (DHE_START/END) structure, we might fill the
      // previous DHE object ... but then the data is junk anyway
      daqpktstat.dhc_back().dhe_back().newDHP(dhp_dhp_id, dhp_readout_frame_lo);
    }
  }
 
  /* // TODO removed because the data is not ordered as expected in current firmware
  for (auto j = 0; j < 4; j++) {
    if (m_last_dhp_readout_frame_lo[j] != -1) {
      if (((dhp_readout_frame_lo - m_last_dhp_readout_frame_lo[j]) & 0xFFFF) > m_maxDHPFrameDiff) {
        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] <<
                ", " <<
                dhp_readout_frame_lo);
        m_errorMask[c_nrDHP_DHP_FRAME_DIFFER] = true;
        break;// give msg only once
      }
    }
  }
  */
  m_last_dhp_readout_frame_lo[dhp_dhp_id] = dhp_readout_frame_lo;
 
// TODO Please check if this can happen by accident with valid data!
  if (dhp_pix[2] == dhp_pix[4] && dhp_pix[3] + 1 == dhp_pix[5]) {
    // We see a second "header" with framenr+1 ...
    if (!(m_suppressErrorMask[c_nrDHP_DBL_HEADER])) {
      B2WARNING("DHP data: seems to be double header! skipping.");
      B2DEBUG(29, "DHP data: seems to be double header! skipping." << LogVar("Length",
              frame_len));
    }
    m_errorMask[c_nrDHP_DBL_HEADER] = true;
    // dump_dhp(data, frame_len); print out guilty dhp packet
    return;
  }
 
  // Start with offset 4, thus skipping header words
  for (unsigned int i = 4; i < nr_words ; i++) {
 
    B2DEBUG(29, "-- $" << hex << dhp_pix[i] << " --   " << dec << i);
    {
      if (((dhp_pix[i] & 0x8000) >> 15) == 0) {
        rowflag = true;
        if (!pixelflag) {
          if (!(m_suppressErrorMask[c_nrDHP_ROW_WO_PIX])) B2WARNING("DHP Unpacking: Row w/o Pix");
          m_errorMask[c_nrDHP_ROW_WO_PIX] = true;
        }
        pixelflag = false;
        dhp_row = (dhp_pix[i] & 0xFFC0) >> 5;
        dhp_cm  = dhp_pix[i] & 0x3F;
        if (last_gate != -1 && (int)dhp_row / 4 < last_gate) {
          // B2DEBUF(29,"Wrap " << LogVar("last", last_gate) << LogVar("curr", dhp_row / 4) << LogVar("DHE", dhe_ID) << LogVar("DHP", dhp_dhp_id));
          wrap++; // relies on the order of data before mapping and the fact that OT firmware delivers only one frame
        }
        last_gate = dhp_row / 4;
 
        if (dhp_cm == 63) { // fifo overflow
          B2WARNING("DHP data loss (CM=63) in " << LogVar("DHE", dhe_ID) << LogVar("DHP", dhp_dhp_id));
          m_errorMask[c_nrDHH_MISC_ERROR] = true;
        }
        if (daqpktstat.dhc_size() > 0) {
          if (daqpktstat.dhc_back().dhe_size() > 0) {
            PXDDAQDHPComMode cm(dhp_dhp_id, dhp_row, dhp_cm);
            // only is we have a DHC and DHE object... or back() is undefined
            // Remark, if we have a broken data (DHE_START/END) structure, we might fill the
            // previous DHE object ... but then the data is junk anyway
            daqpktstat.dhc_back().dhe_back().addCM(cm);
          }
        }
        B2DEBUG(29, "SetRow: $" << hex << dhp_row << " CM $" << hex << dhp_cm);
      } else {
        if (!rowflag) {
          if (!(m_suppressErrorMask[c_nrDHP_PIX_WO_ROW])) B2WARNING("DHP Unpacking: Pix without Row!!! skip dhp data ");
          m_errorMask[c_nrDHP_PIX_WO_ROW] = true;
          // dump_dhp(data, frame_len);// print out faulty dhp frame
          return;
        } else {
          pixelflag = true;
          dhp_row = (dhp_row & 0xFFE) | ((dhp_pix[i] & 0x4000) >> 14);
          dhp_col = ((dhp_pix[i]  & 0x3F00) >> 8);
          unsigned int v_cellID, u_cellID;
          v_cellID = dhp_row;// defaults for no mapping
          if (dhp_row >= 768) {
            if (!(m_suppressErrorMask[c_nrROW_OVERFLOW])) B2WARNING("DHP ROW Overflow " << LogVar("Row", dhp_row));
            m_errorMask[c_nrROW_OVERFLOW] = true;
          }
          // we cannot do col overflow check before mapping :-(
 
          if ((dhe_reformat == 0 && !m_forceNoMapping) || m_forceMapping) {
            u_cellID = dhp_col;// defaults for no mapping
            // data has not been pre-processed by DHH, thus we have to do the mapping ourselves
            if ((dhe_ID & 0x21) == 0x00 || (dhe_ID & 0x21) == 0x21) {
              // if IFOB
              PXDMappingLookup::map_rc_to_uv_IF_OB(v_cellID, u_cellID, dhp_dhp_id, dhe_ID);
            } else { // else OFIB
              PXDMappingLookup::map_rc_to_uv_IB_OF(v_cellID, u_cellID, dhp_dhp_id, dhe_ID);
            }
          } else {
            u_cellID = dhp_col + 64 * dhp_dhp_id; // defaults for already mapped
          }
          if (u_cellID >= 250) {
            if (!(m_suppressErrorMask[c_nrCOL_OVERFLOW])) {
              B2WARNING("DHP COL Overflow (unconnected drain lines)");
              B2DEBUG(29, "DHP COL Overflow (unconnected drain lines) " << u_cellID << ", reformat " << dhe_reformat << ", dhpcol " << dhp_col <<
                      ", id " << dhp_dhp_id);
            }
            m_errorMask[c_nrCOL_OVERFLOW] = true;
          }
          auto dhp_adc = dhp_pix[i] & 0xFF;
          B2DEBUG(29, "SetPix: Row $" << hex << dhp_row << " Col $" << hex << dhp_col << " ADC $" << hex << dhp_adc
                  << " CM $" << hex << dhp_cm);
 
          if (dhp_adc == 0) {
            // if !suppress error flag
            B2WARNING("DHE Event truncation in DHE " << dhe_ID << " DHP " << dhp_dhp_id);
            // m_errorMask |= c_DHE_EVENT_TRUNC;
            daqpktstat.dhc_back().dhe_back().dhp_back().setTruncated();
          } else {
            // in new firmware, (dhp_readout_frame_lo - dhe_first_readout_frame_id_lo) would always been 0
            if (!m_doNotStore) m_storeRawHits.appendNew(vxd_id, v_cellID, u_cellID, dhp_adc,
                                                          (dhp_readout_frame_lo - dhe_first_readout_frame_id_lo + wrap) & 0x3F);
          }
        }
      }
    }
  }
 
  B2DEBUG(29, "(DHE) DHE_ID $" << hex << dhe_ID << " (DHE) DHP ID $" << hex << dhe_DHPport << " (DHP) DHE_ID $" << hex << dhp_dhe_id
          << " (DHP) DHP ID $" << hex << dhp_dhp_id);
  /*for (int i = 0; i < raw_nr_words ; i++) {
    B2DEBUG(29, "RAW      |   " << hex << p_pix[i]);
    printf("raw %08X  |  ", p_pix[i]);
    B2DEBUG(29, "row " << hex << ((p_pix[i] >> 20) & 0xFFF) << dec << " ( " << ((p_pix[i] >> 20) & 0xFFF) << " ) " << " col " << hex << ((p_pix[i] >> 8) & 0xFFF)
           << " ( " << dec << ((p_pix[i] >> 8) & 0xFFF) << " ) " << " adc " << hex << (p_pix[i] & 0xFF) << " ( " << (p_pix[i] & 0xFF) << " ) "
          );
  }*/
}

◆ 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

data	pointer to dhp data
len	length of dhp data
dhe_ID	raw DHE ID from DHC frame
dhe_DHPport	raw DHP port from DHC frame
vxd_id	vertex 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 Constructors of Raw Objects!

Definition at line 301 of file PXDUnpackerOTModule.cc.

{
//   unsigned int nr_words = frame_len / 2; // frame_len in bytes (excl. CRC)!!!
  ubig16_t* dhp_pix = (ubig16_t*)data;
 
  // Size: 64*768 + 8 bytes for a full frame readout
  if (frame_len != 0xC008) {
    if (!(m_suppressErrorMask[c_nrFIX_SIZE])) B2WARNING("Frame size unsupported for RAW ADC frame! $" <<
                                                          LogVar("size [bytes] $", static_cast < std::ostringstream && >(std::ostringstream() << hex << frame_len).str())
                                                          << LogVar("DHE", dhe_ID) << LogVar("DHP", dhe_DHPport));
    m_errorMask[c_nrFIX_SIZE] = true;
    return;
  }
  unsigned int dhp_header_type  = 0;
//   unsigned int dhp_reserved     = 0;
  unsigned int dhp_dhe_id       = 0;
  unsigned int dhp_dhp_id       = 0;
 
  dhp_header_type  = (dhp_pix[2] & 0xE000) >> 13;
//   dhp_reserved     = (dhp_pix[2] >> 8) & 0x1F;
  dhp_dhe_id       = (dhp_pix[2] & 0x00FC) >> 2;
  dhp_dhp_id       =  dhp_pix[2] & 0x0003;
 
  if (dhe_ID != dhp_dhe_id) {
    if (!(m_suppressErrorMask[c_nrDHE_DHP_DHEID])) {
      B2WARNING("DHE ID in DHE and DHP header differ");
      B2DEBUG(29, "DHE ID in DHE and DHP header differ $" << hex << dhe_ID << " != $" << dhp_dhe_id);
    }
    m_errorMask[c_nrDHE_DHP_DHEID] = true;
  }
  if (dhe_DHPport != dhp_dhp_id) {
    if (!(m_suppressErrorMask[c_nrDHE_DHP_PORT])) {
      B2WARNING("DHP ID (Chip/Port) in DHE and DHP header differ");
      B2DEBUG(29, "DHP ID (Chip/Port) in DHE and DHP header differ $" << hex << dhe_DHPport << " != $" << dhp_dhp_id);
    }
    m_errorMask[c_nrDHE_DHP_PORT] = true;
  }
 
  if (dhp_header_type != EDHPFrameHeaderDataType::c_RAW) {
    if (!(m_suppressErrorMask[c_nrHEADERTYPE_INV])) {
      B2WARNING("Header type invalid for this kind of DHE frame");
      B2DEBUG(29, "Header type invalid for this kind of DHE frame: $" << hex << dhp_header_type);
    }
    m_errorMask[c_nrHEADERTYPE_INV] = true;
    return;
  }
  B2DEBUG(29, "Raw ADC Data");
  // size checked already above
  m_storeRawAdc.appendNew(vxd_id, data, frame_len);
};

◆ 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

data	pointer to dhp data
length	length of dhp data
vxd_id	vertex 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 362 of file PXDUnpackerOTModule.cc.

{
 
  B2WARNING("FCE (Cluster) Packet have not yet been tested with real HW clusters. Dont assume that this code is working!");
  return;
 
  // implement the unpacking here and not as a separate module ... when it is available in HW
//   ubig16_t* cluster = (ubig16_t*)data;
//   int nr_words; //words in dhp frame
//   unsigned int words_in_cluster = 0; //counts 16bit words in cluster
//   nr_words = length / 2;
//   ubig16_t sor;
//   sor = 0x0000;
//
//   for (int i = 2 ; i < nr_words ; i++) {
//     if (i != 2) { //skip header
//       if ((((cluster[i] & 0x8000) == 0)
//            && ((cluster[i] & 0x4000) >> 14) == 1)) {  //searches for start of row frame with start of cluster flag = 1 => new cluster
//         if (!m_doNotStore) m_storeRawCluster.appendNew(&data[i - words_in_cluster], words_in_cluster, vxd_id);
//         words_in_cluster = 0;
//       }
//     }
//     if ((cluster[i] & 0x8000) == 0) {
//       sor = cluster[i];
//     }
//     words_in_cluster++;
//
//     if ((cluster[nr_words - 1] & 0xFFFF) == (sor &
//                                              0xFFFF)) {//if frame is not 32bit aligned last word will be the last start of row word
//       cluster[nr_words - 1] = 0x0000;//overwrites the last redundant word with zero to make checking easier in PXDHardwareClusterUnpacker
//     }
//
//     if (i == nr_words - 1) {
//       if (!m_doNotStore) m_storeRawCluster.appendNew(&data[i - words_in_cluster + 1], words_in_cluster, vxd_id);
//     }
//   }
}

◆ unpack_rawpxd()

void unpack_rawpxd	(	RawPXD &	px,
		int	inx )

private

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

Parameters

px	RawPXD data object
inx	Index 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 176 of file PXDUnpackerOTModule.cc.

{
  int Frames_in_event;
  int fullsize;
  int datafullsize;
 
  m_errorMaskDHE = 0;
  m_errorMaskDHC = 0;
  m_errorMaskPacket = 0;
  PXDDAQPacketStatus& daqpktstat = m_storeDAQEvtStats->newPacket(inx);
 
  if (px.size() <= 0 || px.size() > 16 * 1024 * 1024) {
    if (!(m_suppressErrorMask[c_nrPACKET_SIZE])) {
      B2WARNING("PXD Unpacker --> invalid packet size" <<
                LogVar("size [32bit words] $", static_cast < std::ostringstream && >(std::ostringstream() << hex << px.size()).str()));
    }
    m_errorMask[c_nrPACKET_SIZE] = true;
    return;
  }
  std::vector<unsigned int> data(px.size());
  fullsize = px.size() * 4; 
  std::copy_n(px.data(), px.size(), data.begin());
 
  if (fullsize < 8) {
    if (!(m_suppressErrorMask[c_nrPACKET_SIZE])) {
      B2WARNING("Data is to small to hold a valid Header! Will not unpack anything." << LogVar("size [32bit words] $",
                static_cast < std::ostringstream && >(std::ostringstream() << hex << fullsize).str()));
    }
    m_errorMask[c_nrPACKET_SIZE] = true;
    return;
  }
 
  if (data[0] != 0xCAFEBABE && data[0] != 0xBEBAFECA) {
    if (!(m_suppressErrorMask[c_nrMAGIC])) {
      B2WARNING("Magic invalid: Will not unpack anything. Header corrupted." <<
                LogVar("Header Magic $", static_cast < std::ostringstream && >(std::ostringstream() << hex << data[0]).str()));
    }
    m_errorMask[c_nrMAGIC] = true;
    return;
  }
 
 
  Frames_in_event = ((ubig32_t*)data.data())[1];
  if (Frames_in_event < 0 || Frames_in_event > 256) {
    if (!(m_suppressErrorMask[c_nrFRAME_NR])) {
      B2WARNING("Number of Frames invalid: Will not unpack anything. Header corrupted!" << LogVar("Frames in event", Frames_in_event));
    }
    m_errorMask[c_nrFRAME_NR] = true;
    return;
  }
  if (Frames_in_event < 3) {
    if (!(m_suppressErrorMask[c_nrNR_FRAMES_TO_SMALL])) {
      B2WARNING("Number of Frames too small: It cannot contain anything useful." << LogVar("Frames in event", Frames_in_event));
    }
    m_errorMask[c_nrNR_FRAMES_TO_SMALL] = true;
  }
  if (m_verbose) {
    B2DEBUG(29, "PXD Unpacker --> data[0]: <-- Magic $" << hex << data[0]);
    B2DEBUG(29, "PXD Unpacker --> data[1]: <-- #Frames $" << hex << data[1]);
    if (data[1] >= 1 && fullsize < 12) B2DEBUG(29, "PXD Unpacker --> data[2]: <-- Frame 1 len $" << hex << data[2]);
    if (data[1] >= 2 && fullsize < 16) B2DEBUG(29, "PXD Unpacker --> data[3]: <-- Frame 2 len $" << hex << data[3]);
    if (data[1] >= 3 && fullsize < 20) B2DEBUG(29, "PXD Unpacker --> data[4]: <-- Frame 3 len $" << hex << data[4]);
    if (data[1] >= 4 && fullsize < 24) B2DEBUG(29, "PXD Unpacker --> data[5]: <-- Frame 4 len $" << hex << data[5]);
  };
 
  unsigned int* tableptr;
  tableptr = &data[2]; // skip header!!!
 
  unsigned int* dataptr;
  dataptr = &tableptr[Frames_in_event];
  datafullsize = fullsize - 2 * 4 - Frames_in_event * 4; // Size is fullsize minus header minus table
 
  int ll = 0; // Offset in dataptr in bytes
  for (int j = 0; j < Frames_in_event; j++) {
    int lo;
 
    lo = ((ubig32_t*)tableptr)[j];
    if (lo <= 0) {
      if (!(m_suppressErrorMask[c_nrFRAME_SIZE])) {
        B2WARNING("size of frame invalid");
        B2DEBUG(29, "size of frame invalid: " << j << "size " << lo << " at byte offset in dataptr " << ll);
      }
      m_errorMask[c_nrFRAME_SIZE] = true;
      return;
    }
    if (ll + lo > datafullsize) {
      if (!(m_suppressErrorMask[c_nrFRAME_SIZE])) {
        B2WARNING("Frames exceed packet size");
        B2DEBUG(29, "Frames exceed packet size: " << j  << " size " << lo << " at byte offset in dataptr " << ll << " of datafullsize " <<
                datafullsize << " of fullsize " << fullsize);
      }
      m_errorMask[c_nrFRAME_SIZE] = true;
      return;
    }
    if (lo & 0x3) {
      if (!(m_suppressErrorMask[c_nrFRAME_SIZE])) {
        B2WARNING("SKIP Frame with Data with not MOD 4 length");
        B2DEBUG(29, "SKIP Frame with Data with not MOD 4 length " << " ( $" << hex << lo  << " ) ");
      }
      ll += (lo + 3) & 0xFFFFFFFC; 
      m_errorMask[c_nrFRAME_SIZE] = true;
    } else {
      B2DEBUG(29, "unpack DHE(C) frame: " << j << " with size " << lo << " at byte offset in dataptr " << ll);
      unpack_dhc_frame(ll + (char*)dataptr, lo, j, Frames_in_event, daqpktstat);
      ll += lo; 
    }
    m_errorMaskDHE |= m_errorMask;
    m_errorMaskDHC |= m_errorMask;
    m_errorMaskPacket |= m_errorMask;
    m_errorMaskEvent |= m_errorMask;
    m_errorMask = 0;
 
    if (!m_continueOnError && (m_errorMaskPacket & PXDErrorFlags(m_errorSkipPacketMask)) != PXDErrorFlags(0)) {
      // skip full package on error, recovery to next DHC/DHE Start might be possible in some cases
      // But that's to hard to implement
      // Remark: PXD data for broken events is removed in next PXDPostChecker module, thus skipping the
      // unpacking is not strictly necessary here.
      break;
    }
  }
  daqpktstat.setErrorMask(m_errorMaskPacket);
}

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 PXDUnpackerOTModule.h.

62{false};

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 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 PXDUnpackerOTModule.h.

99{false};

◆ m_criticalErrorMask

PXDError::PXDErrorFlags m_criticalErrorMask {}

private

Critical error mask which defines return value of task.

Definition at line 71 of file PXDUnpackerOTModule.h.

71{};

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 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 PXDUnpackerOTModule.h.

60{false};

◆ m_errorCounter

unsigned int m_errorCounter[PXDError::ONSEN_MAX_TYPE_ERR] {}

private

Error counters.

Definition at line 95 of file PXDUnpackerOTModule.h.

95{};

◆ m_errorMask

PXDError::PXDErrorFlags m_errorMask {0}

private

Error Mask set per packet / frame.

Definition at line 160 of file PXDUnpackerOTModule.h.

160{0};

◆ m_errorMaskDHC

PXDError::PXDErrorFlags m_errorMaskDHC {0}

private

Error Mask set per packet / DHC.

Definition at line 164 of file PXDUnpackerOTModule.h.

164{0};

◆ m_errorMaskDHE

PXDError::PXDErrorFlags m_errorMaskDHE {0}

private

Error Mask set per packet / DHE.

Definition at line 162 of file PXDUnpackerOTModule.h.

162{0};

◆ m_errorMaskEvent

PXDError::PXDErrorFlags m_errorMaskEvent {0}

private

Error Mask set per packet / event.

Definition at line 168 of file PXDUnpackerOTModule.h.

168{0};

◆ m_errorMaskPacket

PXDError::PXDErrorFlags m_errorMaskPacket {0}

private

Error Mask set per packet / packet.

Definition at line 166 of file PXDUnpackerOTModule.h.

166{0};

◆ m_errorSkipPacketMask

PXDError::PXDErrorFlags m_errorSkipPacketMask {}

private

Mask for error which stop package unpacking directly.

Definition at line 75 of file PXDUnpackerOTModule.h.

75{};

◆ m_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData

private

Input ptr for EventMetaData.

Definition at line 104 of file PXDUnpackerOTModule.h.

◆ m_forceMapping

bool m_forceMapping {false}

private

Force Mapping even if DHH bit is not requesting it.

Definition at line 64 of file PXDUnpackerOTModule.h.

64{false};

◆ m_forceNoMapping

bool m_forceNoMapping {false}

private

Force No Mapping even if DHH bit is requesting it.

Definition at line 66 of file PXDUnpackerOTModule.h.

66{false};

◆ m_formatBonnDAQ

bool m_formatBonnDAQ {false}

private

flag ONSEN or BonnDAQ format

Definition at line 177 of file PXDUnpackerOTModule.h.

177{false};

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 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 PXDUnpackerOTModule.h.

180{ -1}; // signed because -1 means undefined

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 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 PXDUnpackerOTModule.h.

68{0};

◆ m_meta_event_nr

unsigned long m_meta_event_nr {0}

private

Event Number from MetaInfo.

Definition at line 78 of file PXDUnpackerOTModule.h.

78{0};

◆ m_meta_experiment

unsigned long m_meta_experiment {0}

private

Experiment from MetaInfo.

Definition at line 84 of file PXDUnpackerOTModule.h.

84{0};

◆ m_meta_run_nr

unsigned long m_meta_run_nr {0}

private

Run Number from MetaInfo.

Definition at line 80 of file PXDUnpackerOTModule.h.

80{0};

◆ 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 PXDUnpackerOTModule.h.

88{0};

◆ m_meta_subrun_nr

unsigned long m_meta_subrun_nr {0}

private

Subrun Number from MetaInfo.

Definition at line 82 of file PXDUnpackerOTModule.h.

82{0};

◆ m_meta_ticks

unsigned int m_meta_ticks {0}

private

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

Definition at line 90 of file PXDUnpackerOTModule.h.

90{0};

◆ m_meta_time

unsigned long long int m_meta_time {0}

private

Time(Tag) from MetaInfo.

Definition at line 86 of file PXDUnpackerOTModule.h.

86{0};

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 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 507 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 PXDUnpackerOTModule.h.

171{0};

◆ m_package

std::string m_package

privateinherited

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

Definition at line 509 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 511 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 PXDUnpackerOTModule.h.

◆ m_PXDRawAdcsName

std::string m_PXDRawAdcsName

private

The name of the StoreArray of PXDRawAdcs to be generated.

Definition at line 56 of file PXDUnpackerOTModule.h.

◆ m_PXDRawHitsName

std::string m_PXDRawHitsName

private

The name of the StoreArray of PXDRawHits to be generated.

Definition at line 55 of file PXDUnpackerOTModule.h.

◆ m_PXDRawROIsName

std::string m_PXDRawROIsName

private

The name of the StoreArray of PXDRawROIs to be generated.

Definition at line 57 of file PXDUnpackerOTModule.h.

◆ m_RawPXDsName

std::string m_RawPXDsName

private

The name of the StoreArray of processed RawPXDs.

Definition at line 53 of file PXDUnpackerOTModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_sendrois

unsigned int m_sendrois {0}

private

counter for send debug rois

Definition at line 173 of file PXDUnpackerOTModule.h.

173{0};

◆ m_sendunfiltered

unsigned int m_sendunfiltered {0}

private

counter for send unfiltered

Definition at line 175 of file PXDUnpackerOTModule.h.

175{0};

◆ m_storeDAQEvtStats

StoreObjPtr<PXDDAQStatus> m_storeDAQEvtStats

private

Output array for DAQ Status.

Definition at line 110 of file PXDUnpackerOTModule.h.

◆ m_storeRawAdc

StoreArray<PXDRawAdc> m_storeRawAdc

private

Output array for Raw Adcs.

Definition at line 112 of file PXDUnpackerOTModule.h.

◆ m_storeRawHits

StoreArray<PXDRawHit> m_storeRawHits

private

Output array for Raw Hits.

Definition at line 106 of file PXDUnpackerOTModule.h.

◆ m_storeRawPXD

StoreArray<RawPXD> m_storeRawPXD

private

Input array for PXD Raw.

Definition at line 102 of file PXDUnpackerOTModule.h.

◆ m_storeROIs

StoreArray<PXDRawROIs> m_storeROIs

private

Output array for Raw ROIs.

Definition at line 108 of file PXDUnpackerOTModule.h.

◆ m_suppressErrorMask

PXDError::PXDErrorFlags m_suppressErrorMask {}

private

Mask for suppressing selected error messages.

Definition at line 73 of file PXDUnpackerOTModule.h.

73{};

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_unpackedEventsCount

unsigned int m_unpackedEventsCount {0}

private

Event counter.

Definition at line 93 of file PXDUnpackerOTModule.h.

93{0};

◆ m_verbose

bool m_verbose {false}

private

give verbose unpacking information

Definition at line 97 of file PXDUnpackerOTModule.h.

97{false};

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

pxd/modules/pxdUnpacking/include/PXDUnpackerOTModule.h
pxd/modules/pxdUnpacking/src/PXDUnpackerOTModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ PXDUnpackerOTModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ dump_dhp()

◆ dump_roi()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ nr5bits()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

◆ unpack_dhc_frame()

◆ unpack_dhp()

◆ unpack_dhp_raw()

◆ unpack_fce()

◆ unpack_rawpxd()

Member Data Documentation

◆ m_checkPaddingCRC

◆ m_conditions

◆ m_continueOnError

◆ m_criticalErrorMask

◆ m_description

◆ m_doNotStore

◆ m_errorCounter