the ECL unpacker module More...

#include <eclUnpackerModule.h>

Inheritance diagram for ECLUnpackerModule:

Public Types
enum	ECLUnpack { ECL_DISCARD_DSP_DATA = 0x00000001 , ECL_KEEP_GOOD_DSP_DATA = 0x00000002 , ECL_OFFLINE_ADC_FIT = 0x00000004 }
	ECL unpacker run-dependent parameters (per channel) More...

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
	ECLUnpackerModule ()
	constructor

virtual	~ECLUnpackerModule ()
	destructor

virtual void	initialize () override
	initialize

virtual void	beginRun () override
	beginRun

virtual void	event () override
	event

virtual void	endRun () override
	endRun

virtual void	terminate () override
	terminate

	BELLE2_DEFINE_EXCEPTION (Unexpected_end_of_FINESSE_buffer, "Unexpected end of the FINESSE buffer is reached while reading ShpaerDSP data")
	exeption should be thrown when the unexpected

	BELLE2_DEFINE_EXCEPTION (Bad_ShaperDSP_header, "Corrupted Shaper DSP header")
	exeption should be thrown when the Shaepr DSP header is corrupted

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.

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 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	doEvtNumReport (unsigned int iCrate, int tag, int evt_number)
	Report the problem with inconsistency between trg tag and evt number.

void	doTagsReport (unsigned int iCrate, int tag0, int tag1)
	Report the problem with trigger tags and exclude the crate from further reports of this type.

void	doPhasesReport (unsigned int iCrate, int phase0, int phase1)
	Report the problem with trigger phases and exclude the crate from further reports of this type.

void	doBadHeaderReport (unsigned int iCrate)
	Report the problem with bad shaper header and exclude the crate from further reports of this type.

bool	evtNumReported (unsigned int iCrate)
	Check if the problem with trg tag <-> evt number inconsistency was already reported for crate iCrate.

bool	tagsReported (unsigned int iCrate)
	Check if the problem with different trigger tags was already reported for crate iCrate.

bool	phasesReported (unsigned int iCrate)
	Check if the problem with different trigger phases was already reported for crate iCrate.

bool	badHeaderReported (unsigned int iCrate)
	Check if the problem with bad shaper header was already reported for crate iCrate.

unsigned int	readNextCollectorWord ()
	read nex word from COPPER data, check if the end of data is reached

unsigned int	readNBits (int bitsToRead)
	read N bits from COPPER buffer (needed for reading the compressed ADC data)

void	readRawECLData (RawECL *rawCOPPERData, int n)
	read raw data from COPPER and fill output m_eclDigits container

bool	isDSPValid (int cellID, int crate, int shaper, int channel, int amp, int time, int quality)
	Check if DSP data should be saved to datastore.

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
int	m_globalEvtNum
	event number from EventMetaData

int	m_localEvtNum
	Internally counted event number.

unsigned int *	m_bufPtr
	pointer to data from COPPER

int	m_bufPos
	position in the COPPER data array

int	m_bufLength
	length of COPPER data

int	m_bitPos
	bit position for bit-by-bit data read

bool	m_storeTrigTime
	flag for whether or not to store collection with trigger times

bool	m_storeUnmapped
	flag for whether or not to store ECLDsp data for unmapped channels

bool	m_useUnpackingParameters
	Use ECLUnpackingParameters payload for run-dependent unpacking.

long	m_evtNumReportedMask = 0
	report only once per crate about inconsistency between trg tag and evt number

long	m_tagsReportedMask = 0
	report only once per crate about problem with different trg tags

long	m_phasesReportedMask = 0
	report only once per crate about problem with different trg phases

long	m_badHeaderReportedMask = 0
	report only once per crate about problem with shaper header

std::string	m_eclDigitsName
	name of output collection for ECLDigits

std::string	m_eclTrigsName
	name of output collection for ECLTrig

std::string	m_eclDspsName
	name of output collection for ECLDsp

std::string	m_eclMapperInitFileName
	name of the file with correspondence between cellID and crate/shaper/channel numbers

ECL::ECLChannelMapper	m_eclMapper
	ECL channel mapper.

DBObjPtr< ECLChannelMap >	m_unpackingParams
	Run-dependent unpacking parameters for each channel.

StoreArray< RawECL >	m_rawEcl
	store array for RawECL

StoreObjPtr< EventMetaData >	m_eventMetaData
	store objptr for EventMetaData

StoreArray< ECLDigit >	m_eclDigits
	store array for digitized gits

StoreArray< ECLTrig >	m_eclTrigs
	store array for eclTrigs data (trigger time and tag)

StoreArray< ECLDsp >	m_eclDsps
	store array for waveforms

RelationArray	m_relDigitToTrig {m_eclDigits, m_eclTrigs}
	ECLDigit->ECLTrig relation array.

RelationArray	m_relDigitToDsp {m_eclDigits, m_eclDsps}
	ECLDigit->ECLTrig relation array.

ECLTrig	m_eclTrigsBuffer [ECL::ECL_CRATES]
	ECLTrigs objects before they are added to m_eclTrigs array.

int	m_debugLevel
	Cached debug level from LogSystem.

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 ECL unpacker module

Definition at line 35 of file eclUnpackerModule.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

◆ ECLUnpack

enum ECLUnpack

ECL unpacker run-dependent parameters (per channel)

Enumerator
ECL_DISCARD_DSP_DATA	Skip ECLDigit unpacking.
ECL_KEEP_GOOD_DSP_DATA	Keep ECLDigits for quality flag 0 even if ECL_DISCARD_DSP_DATA is set.
ECL_OFFLINE_ADC_FIT	Get ECLDigits from offline waveform fit.

Definition at line 61 of file eclUnpackerModule.h.

                   {
      ECL_DISCARD_DSP_DATA   = 0x00000001,
      ECL_KEEP_GOOD_DSP_DATA = 0x00000002,
      ECL_OFFLINE_ADC_FIT = 0x00000004,
    };

◆ 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

◆ ECLUnpackerModule()

ECLUnpackerModule ( )

constructor

Definition at line 80 of file eclUnpackerModule.cc.

                                     :
  m_globalEvtNum(0),
  m_localEvtNum(0),
  m_bufPtr(0),
  m_bufPos(0),
  m_bufLength(0),
  m_bitPos(0),
  m_storeTrigTime(0),
  m_storeUnmapped(0),
  m_unpackingParams("ECLUnpackingParameters", false),
  m_eclDigits("", DataStore::c_Event),
  m_debugLevel(0)
{
  setDescription("The module reads RawECL data from the DataStore and writes the ECLDigit data");
 
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("InitFileName",  m_eclMapperInitFileName, "Initialization file",             string("/ecl/data/ecl_channels_map.txt"));
  addParam("ECLDigitsName", m_eclDigitsName,         "Name of the ECLDigits container", string("ECLDigits"));
  addParam("ECLDspsName",   m_eclDspsName,           "Name of the ECLDsp container",    string("ECLDsps"));
  addParam("ECLTrigsName",  m_eclTrigsName,          "Name of the ECLTrig container",   string("ECLTrigs"));
  // flag to store trigger times needed for calibration with pulse generator only, so false by default
  addParam("storeTrigTime", m_storeTrigTime,         "Store trigger time",              false);
  addParam("storeUnmapped", m_storeUnmapped,         "Store ECLDsp for channels that don't "
           "exist in ECL mapping", false);
  addParam("useUnpackingParameters", m_useUnpackingParameters,
           "Use ECLUnpackingParameters payload", true);
}

◆ ~ECLUnpackerModule()

virtual ~ECLUnpackerModule ( )

inlinevirtual

destructor

Definition at line 40 of file eclUnpackerModule.h.

40{}

Member Function Documentation

◆ badHeaderReported()

bool badHeaderReported ( unsigned int iCrate )

inlineprivate

Check if the problem with bad shaper header was already reported for crate iCrate.

Definition at line 144 of file eclUnpackerModule.h.

144{ return m_badHeaderReportedMask & (1L << (iCrate - 1)); }

Belle2::ECLUnpackerModule::m_badHeaderReportedMask

long m_badHeaderReportedMask

report only once per crate about problem with shaper header

Definition: eclUnpackerModule.h:102

◆ beginRun()

void beginRun ( void )

overridevirtual

beginRun

Reimplemented from Module.

Definition at line 130 of file eclUnpackerModule.cc.

{
  m_evtNumReportedMask    = 0;
  m_tagsReportedMask      = 0;
  m_phasesReportedMask    = 0;
  m_badHeaderReportedMask = 0;
  // Initialize channel mapper at run start to account for possible
  // changes in ECL mapping between runs.
  if (!m_eclMapper.initFromDB()) {
    B2FATAL("ECL Unpacker: Can't initialize eclChannelMapper!");
  }
  if (!m_unpackingParams.isValid() && m_useUnpackingParameters) {
    B2FATAL("ECL Unpacker: Can't access ECLUnpackingParameters payload");
  }
}

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

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

This method is called at the end of the event processing.

Definition: Module.h:176

◆ doBadHeaderReport()

void doBadHeaderReport ( unsigned int iCrate )

private

Report the problem with bad shaper header and exclude the crate from further reports of this type.

Definition at line 604 of file eclUnpackerModule.cc.

{
  if (!badHeaderReported(iCrate)) {
    B2ERROR("Bad shaper header."
            << LogVar("crate", iCrate));
    m_badHeaderReportedMask |= 1L << (iCrate - 1);
  }
}

◆ doEvtNumReport()

void doEvtNumReport	(	unsigned int	iCrate,
		int	tag,
		int	evt_number
	)

private

Report the problem with inconsistency between trg tag and evt number.

Exclude the crate from further reports of this type.

Definition at line 576 of file eclUnpackerModule.cc.

{
  if (!evtNumReported(iCrate)) {
    B2ERROR("ECL trigger tag is inconsistent with event number."
            << LogVar("crate", iCrate)
            << LogVar("trigger tag", tag)
            << LogVar("event number", evt_number));
    m_evtNumReportedMask |= 1L << (iCrate - 1);
  }
}

◆ doPhasesReport()

void doPhasesReport	(	unsigned int	iCrate,
		int	phase0,
		int	phase1
	)

private

Report the problem with trigger phases and exclude the crate from further reports of this type.

Definition at line 595 of file eclUnpackerModule.cc.

{
  if (!phasesReported(iCrate)) {
    B2ERROR("Different trigger phases. ECL data is corrupted for whole run probably."
            << LogVar("crate", iCrate)
            << LogVar("trigger phase0", phase0) << LogVar("trigger phase1", phase1));
    m_phasesReportedMask |= 1L << (iCrate - 1);
  }
}

◆ doTagsReport()

void doTagsReport	(	unsigned int	iCrate,
		int	tag0,
		int	tag1
	)

private

Report the problem with trigger tags and exclude the crate from further reports of this type.

Definition at line 586 of file eclUnpackerModule.cc.

{
  if (!tagsReported(iCrate)) {
    B2ERROR("Different trigger tags. ECL data is corrupted for whole run probably."
            << LogVar("crate", iCrate)
            << LogVar("trigger tag0", tag0) << LogVar("trigger tag1", tag1));
    m_tagsReportedMask |= 1L << (iCrate - 1);
  }
}

◆ endRun()

void endRun ( void )

overridevirtual

endRun

Reimplemented from Module.

Definition at line 199 of file eclUnpackerModule.cc.

200{

201}

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

overridevirtual

event

Reimplemented from Module.

Definition at line 146 of file eclUnpackerModule.cc.

{
  // output data
  m_eclDigits.clear();
  m_eclDsps.clear();
  m_eclTrigs.clear();
  // clear relations arrays
  if (m_relDigitToTrig) m_relDigitToTrig.clear();
  if (m_relDigitToDsp) m_relDigitToDsp.clear();
 
  if (m_eventMetaData.isValid()) {
    m_globalEvtNum = m_eventMetaData->getEvent();
  } else {
    m_globalEvtNum = -1;
  }
 
  for (int i = 0; i < ECL_CRATES; i++) {
    m_eclTrigsBuffer[i].setTrigId(0);
  }
 
  //=== Read raw event data
 
  int nRawEclEntries = m_rawEcl.getEntries();
 
  B2DEBUG_eclunpacker(22, "Ecl unpacker event called N_RAW = " << nRawEclEntries);
 
  for (int i = 0; i < nRawEclEntries; i++) {
    for (int n = 0; n < m_rawEcl[i]->GetNumEntries(); n++) {
      readRawECLData(m_rawEcl[ i ], n); // read data from RawECL and put into the m_eclDigits container
    }
  }
 
  //=== Add created ECLTrig objects to the StoreArray
 
  ECLTrig* new_ecl_trigs[ECL_CRATES] = {};
  for (int i = 0; i < ECL_CRATES; i++) {
    if (m_eclTrigsBuffer[i].getTrigId() > 0) {
      new_ecl_trigs[i] = m_eclTrigs.appendNew(m_eclTrigsBuffer[i]);
    }
  }
 
  for (int i = 0; i < m_eclDigits.getEntries(); i++) {
    int cid = m_eclDigits[i]->getCellId();
    int crate0 = m_eclMapper.getCrateID(cid) - 1;
    if (new_ecl_trigs[crate0]) {
      m_relDigitToTrig.add(i, crate0);
    }
  }
 
  m_localEvtNum++;
 
}

◆ evtNumReported()

bool evtNumReported ( unsigned int iCrate )

inlineprivate

Check if the problem with trg tag <-> evt number inconsistency was already reported for crate iCrate.

Definition at line 129 of file eclUnpackerModule.h.

129{ return m_evtNumReportedMask & (1L << (iCrate - 1)); }

◆ 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 pathes */
  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://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  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 324 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 314 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 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

{
  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://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

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 )

overridevirtual

initialize

Reimplemented from Module.

Definition at line 109 of file eclUnpackerModule.cc.

{
  // Get cached debug level to improve performance
  auto& config = LogSystem::Instance().getCurrentLogConfig(PACKAGENAME());
  m_debugLevel = config.getLogLevel() == LogConfig::c_Debug ? config.getDebugLevel() : 0;
 
  // require input data
  m_rawEcl.isRequired();
 
  // register output containers in data store
  m_eclDigits.registerInDataStore(m_eclDigitsName);
  if (m_storeTrigTime) {
    m_eclTrigs.registerInDataStore(m_eclTrigsName);
    m_relDigitToTrig.registerInDataStore();
  }
  m_eclDsps.registerInDataStore(m_eclDspsName);
  m_relDigitToDsp.registerInDataStore();
  m_eclDsps.registerRelationTo(m_eclDigits);
 
}

◆ isDSPValid()

bool isDSPValid	(	int	cellID,
		int	crate,
		int	shaper,
		int	channel,
		int	amp,
		int	time,
		int	quality
	)

private

Check if DSP data should be saved to datastore.

Definition at line 557 of file eclUnpackerModule.cc.

{
  // Channel is not connected to crystal
  if (cellID < 1) return false;
 
  if (m_useUnpackingParameters) {
    // Check if data for this channel should be discarded in current run.
    auto params = m_unpackingParams->get(crate, shaper, channel);
    if (params & ECL_DISCARD_DSP_DATA) {
      if (params & ECL_KEEP_GOOD_DSP_DATA) {
        if (quality == 0) return true;
      }
      return false;
    }
  }
 
  return true;
}

◆ phasesReported()

bool phasesReported ( unsigned int iCrate )

inlineprivate

Check if the problem with different trigger phases was already reported for crate iCrate.

Definition at line 139 of file eclUnpackerModule.h.

139{ return m_phasesReportedMask & (1L << (iCrate - 1)); }

◆ readNBits()

unsigned int readNBits ( int bitsToRead )

private

read N bits from COPPER buffer (needed for reading the compressed ADC data)

Definition at line 220 of file eclUnpackerModule.cc.

{
  unsigned int val = 0;
 
  val = m_bufPtr[m_bufPos] >> m_bitPos;
  if (m_bitPos + bitsToRead > 31)
    if (m_bufPos == m_bufLength) {
      B2ERROR("Reached the end of the FINESSE buffer while read compressed ADC data");
 
      throw Unexpected_end_of_FINESSE_buffer();
    } else {
      m_bufPos++;
      val += m_bufPtr[m_bufPos] << (32 - m_bitPos);
      m_bitPos += bitsToRead;
      m_bitPos -= 32;
    } else {
    m_bitPos += bitsToRead;
    if (m_bitPos == 32) {
      m_bufPos++;
      m_bitPos -= 32;
    }
  }
 
  val &= (1 << bitsToRead) - 1;
 
  return val;
}

◆ readNextCollectorWord()

unsigned int readNextCollectorWord ( )

private

read nex word from COPPER data, check if the end of data is reached

Definition at line 208 of file eclUnpackerModule.cc.

{
  if (m_bufPos == m_bufLength) {
    B2DEBUG_eclunpacker(22, "Reached the end of the FINESSE buffer");
    throw Unexpected_end_of_FINESSE_buffer();
  }
  unsigned int value = m_bufPtr[m_bufPos];
  m_bufPos++;
  return value;
}

◆ readRawECLData()

void readRawECLData	(	RawECL *	rawCOPPERData,
		int	n
	)

private

read raw data from COPPER and fill output m_eclDigits container

Definition at line 248 of file eclUnpackerModule.cc.

{
  int iCrate, iShaper, iChannel, cellID;
 
  int shapersMask;
  int adcDataBase, adcDataDiffWidth;
  int compressMode, shaperDataLength;
  unsigned int value = 0;
  unsigned int nRead = 0, ind = 0, indSample = 0;
  unsigned int nActiveChannelsWithADCData, nADCSamplesPerChannel, nActiveDSPChannels;
  int triggerPhase;
  int dspMask = 0, triggerTag = 0;
  int nShapers;
  int adcMask, adcHighMask, dspTime, dspAmplitude, dspQualityFlag;
  // Mask of shapers that discarded waveform data due to beam burst suppression
  int burstSuppressionMask;
 
 
  std::vector <int> eclWaveformSamples;
 
  int nodeID = rawCOPPERData->GetNodeID(n);
  int channelsCount = rawCOPPERData->GetMaxNumOfCh(n);
 
  int collectorsInNode = -1;
 
  bool pcie40Data = false;
  if (channelsCount == 4) { // COPPER data
    pcie40Data = false;
    collectorsInNode = 2;
  } else if (channelsCount == 48) { // PCIe40 data
    pcie40Data = true;
    collectorsInNode = 18;
    if (nodeID == BECL_ID + 3) {
      collectorsInNode = 16;
    }
  } else {
    B2FATAL("The maximum number of channels per readout board is invalid."
            << LogVar("Number of channels", channelsCount));
  }
 
  // loop over FINESSEs in the COPPER
  for (int iFINESSE = 0; iFINESSE < collectorsInNode; iFINESSE++) {
 
    m_bitPos = 0;
    m_bufPos = 0;
 
    m_bufLength = rawCOPPERData->GetDetectorNwords(n, iFINESSE);
 
    if (m_bufLength <= 0) continue;
 
    // get Number of Collector/Crate connected to the FINESSE
    iCrate = m_eclMapper.getCrateID(nodeID, iFINESSE, pcie40Data);
 
    // pointer to data from COPPER/FINESSE
    m_bufPtr = (unsigned int*)rawCOPPERData->GetDetectorBuffer(n, iFINESSE);
 
    B2DEBUG_eclunpacker(21, "***** iEvt " << m_localEvtNum << " node " << std::hex << nodeID);
 
    // dump buffer data
    for (int i = 0; i < m_bufLength; i++) {
      B2DEBUG_eclunpacker(29, "" << std::hex << setfill('0') << setw(8) << m_bufPtr[i]);
    }
    B2DEBUG_eclunpacker(21, "***** ");
 
 
    m_bufPos = 0; // set read position to the 1-st word
 
    // get number of shapers depending on the subsystem this crate belongs to(barrel/forward/backward)
    int eclSubSystem = m_eclMapper.getSubSystem(iCrate);
    switch (eclSubSystem) {
      case 0  : nShapers = ECL_BARREL_SHAPERS_IN_CRATE; break;
      case 1  : nShapers = ECL_FWD_SHAPERS_IN_CRATE; break;
      case 2  : nShapers = ECL_BKW_SHAPERS_IN_CRATE; break;
      default : nShapers = ECL_BARREL_SHAPERS_IN_CRATE;
    }
 
    try {
      burstSuppressionMask = 0;
 
      // trigger phase of the Collector connected to this FINESSE
      // -1 if there are no triggered shapers
      int triggerPhase0 = -1;
      int triggerTag0   = -1;
 
      // read the collector header
      value = readNextCollectorWord();
      shapersMask = value & 0xFFF;           // mask of active shapers
      compressMode = (value & 0xF000) >> 12; // compression mode for ADC data, 0 -- disabled, 1 -- enabled
 
      B2DEBUG_eclunpacker(22, "ShapersMask = " << std::hex << shapersMask << " compressMode =  "  <<  compressMode);
 
      // loop over all shapers in crate
      for (iShaper = 1; iShaper <= nShapers; iShaper++) {
 
        // check if shaper is active
        int thisShaperMask = (1 << (iShaper - 1)) & shapersMask;
        if (thisShaperMask != (1 << (iShaper - 1))) continue;
 
        // read the shaper header
        value = readNextCollectorWord();
        shaperDataLength = value & 0xFFFF; // amount of words in DATA section (without COLLECTOR HEADER)
        B2DEBUG_eclunpacker(22, "iCrate = " << iCrate << " iShaper = " << iShaper);
        B2DEBUG_eclunpacker(22, "Shaper HEADER = 0x" << std::hex << value << " dataLength = " << std::dec << shaperDataLength);
        // check shaperDSP header
        if ((value & 0x00FF0000) != 0x00100000) {
          doBadHeaderReport(iCrate);
          throw Bad_ShaperDSP_header();
        }
 
        value = readNextCollectorWord();
        burstSuppressionMask |= ((value >> 29) & 1) << (iShaper - 1); // burst suppression bit
        nActiveChannelsWithADCData = (value >> 24) & 0x1F;//number of channels with ADC data
        nADCSamplesPerChannel = (value >> 16) & 0x7F;    //ADC samples per channel
        nActiveDSPChannels = (value >> 8) & 0x1F;       //number of active channels in DSP
        triggerPhase = value & 0xFF;                   //trigger phase
 
        // check that trigger phases for all shapers in the crate are equal
        if (triggerPhase0 == -1) triggerPhase0 = triggerPhase;
        else if (triggerPhase != triggerPhase0) {
          doPhasesReport(iCrate, triggerPhase0, triggerPhase);
        }
 
        B2DEBUG_eclunpacker(22, "nActiveADCChannels = " << nActiveChannelsWithADCData << " samples " << nADCSamplesPerChannel <<
                            " nActiveDSPChannels "
                            << nActiveDSPChannels);
 
        value = readNextCollectorWord();
 
        dspMask    = (value >> 16) & 0xFFFF;  // Active DSP channels mask
        triggerTag = value & 0xFFFF;          // trigger tag
        B2DEBUG_eclunpacker(22, "DSPMASK = 0x" << std::hex << dspMask << " triggerTag " << std::dec << triggerTag);
 
        if (triggerTag0 == -1) triggerTag0 = triggerTag;
        else if (triggerTag != triggerTag0) {
          doTagsReport(iCrate, triggerTag0, triggerTag);
          triggerTag0 |= (1 << 16);
        }
 
        if (m_globalEvtNum >= 0) {
          if (triggerTag != (m_globalEvtNum & 0xFFFF)) {
            doEvtNumReport(iCrate, triggerTag, m_globalEvtNum);
          }
        }
 
        value = readNextCollectorWord();
        adcMask = value & 0xFFFF; // mask for channels with ADC data
        adcHighMask = (value >> 16) & 0xFFFF;
        B2DEBUG_eclunpacker(22, "ADCMASK = 0x" << std::hex << adcMask << " adcHighMask = 0x" << adcHighMask);
 
        ECLDigit* newEclDigits[ECL_CHANNELS_IN_SHAPER] = {};
        int newEclDigitsIdx[ECL_CHANNELS_IN_SHAPER] = {};
 
        nRead = 0;
        // read DSP data (quality, fitted time, amplitude)
        for (ind = 0; ind < ECL_CHANNELS_IN_SHAPER; ind++) {
          // check if DSP channel is active
          if (((1 << ind) & dspMask) != (1 << ind)) continue;
          iChannel = ind + 1;
          value = readNextCollectorWord();
          dspTime = (int)(value << 2) >> 20;
          dspQualityFlag = (value >> 30) & 0x3;
          dspAmplitude  = (value & 0x3FFFF) - 128;
          nRead++;
 
          cellID = m_eclMapper.getCellId(iCrate, iShaper, iChannel);
 
          if (!isDSPValid(cellID, iCrate, iShaper, iChannel, dspAmplitude, dspTime, dspQualityFlag)) continue;
 
          // fill eclDigits data object
          B2DEBUG_eclunpacker(23, "New eclDigit: cid = " << cellID << " amp = " << dspAmplitude << " time = " << dspTime << " qflag = " <<
                              dspQualityFlag);
 
          // construct eclDigit object and save it in DataStore
          ECLDigit* newEclDigit = m_eclDigits.appendNew();
          newEclDigitsIdx[ind]  = m_eclDigits.getEntries() - 1;
          newEclDigits[ind]     = newEclDigit;
          newEclDigit->setCellId(cellID);
          newEclDigit->setAmp(dspAmplitude);
          newEclDigit->setQuality(dspQualityFlag);
          if (dspQualityFlag == 2) {
            // amplitude is lower than threshold value time = trg_time => fit_time = 0
            newEclDigit->setTimeFit(0);
            // the time data is replaced with chi2 data
            const int chi_mantissa = dspTime & 0x1FF;
            const int chi_exponent = (dspTime >> 9) & 7;
            const int chi2  = chi_mantissa << (chi_exponent * 2);
            newEclDigit->setChi(chi2);
 
          } else {
            // otherwise we do not have chi2 information
            newEclDigit->setTimeFit(dspTime);
            newEclDigit->setChi(0);
          }
 
        }
 
 
 
        if (nRead != nActiveDSPChannels) {
          B2ERROR("Number of active DSP channels and number of read channels don't match (Corrupted data?)"
                  << LogVar("nRead", nRead) << LogVar("nActiveDSP", nActiveDSPChannels));
          // do something (throw an exception etc.) TODO
        }
 
        //read ADC data
        eclWaveformSamples.resize(nADCSamplesPerChannel);
        nRead = 0;
        for (ind = 0; ind < ECL_CHANNELS_IN_SHAPER; ind++) {
          //check if there is ADC data for this channel
          if (((1 << ind) & adcMask) != (1 << ind)) continue;
          iChannel = ind + 1;
          adcDataBase = 0;
          adcDataDiffWidth = 0;
          for (indSample = 0; indSample < nADCSamplesPerChannel; indSample++) {
            if (compressMode == 0) value = readNextCollectorWord();
            else {
              if (indSample == 0) {
                value = readNBits(18);
                adcDataBase = value;
                B2DEBUG_eclunpacker(24, "adcDataBase = " << adcDataBase);
                value = readNBits(5);
                adcDataDiffWidth = value;
                B2DEBUG_eclunpacker(24, "adcDataDiffWidth = " << adcDataDiffWidth);
              }
              value = readNBits(adcDataDiffWidth);
              B2DEBUG_eclunpacker(24, "adcDataOffset = " << value);
              value += adcDataBase;
            }
            // fill waveform data for single channel
            eclWaveformSamples[indSample] = value;
          }
 
          // save ADC data to the eclDsp DataStore object if any
          if (nADCSamplesPerChannel > 0) {
 
            cellID = m_eclMapper.getCellId(iCrate, iShaper, iChannel);
 
            if (cellID > 0 || m_storeUnmapped) {
              m_eclDsps.appendNew(cellID, eclWaveformSamples);
 
              if (m_useUnpackingParameters) {
                // Check run-dependent unpacking parameters
                auto params = m_unpackingParams->get(iCrate, iShaper, iChannel);
                if (params & ECL_OFFLINE_ADC_FIT) {
                  auto result = ECLDspUtilities::shapeFitter(cellID, eclWaveformSamples, triggerPhase0);
                  if (result.quality == 2) result.time = 0;
 
                  if (!newEclDigits[ind]) {
                    ECLDigit* newEclDigit = m_eclDigits.appendNew();
                    newEclDigits[ind] = newEclDigit;
                    newEclDigit->setCellId(cellID);
                    newEclDigit->setAmp(result.amp);
                    newEclDigit->setTimeFit(result.time);
                    newEclDigit->setQuality(result.quality);
                    newEclDigit->setChi(result.chi2);
                  }
                }
              }
              // Add relation from ECLDigit to ECLDsp
              if (newEclDigits[ind]) {
                int eclDspIdx = m_eclDsps.getEntries() - 1;
                m_relDigitToDsp.add(newEclDigitsIdx[ind], eclDspIdx);
              }
            }
 
          }
 
          nRead++;
        } // read ADC data loop
 
        if (m_bitPos > 0) {
          m_bufPos++;
          m_bitPos = 0;
        }
 
        if (nRead != nActiveChannelsWithADCData) {
          B2ERROR("Number of channels with ADC data and "
                  "number of read channels don't match (Corrupted data?)"
                  << LogVar("active channels", nActiveChannelsWithADCData)
                  << LogVar("read channels", nRead));
          // do something (throw an exception etc.) TODO
        }
 
 
 
      } // loop over shapers
 
      // make new eclTrig oject to store trigger time for crate if there are triggered shapers in the crate
      if (m_storeTrigTime && shapersMask != 0) {
        int trigId = iCrate & 0x3F;
        ECLTrig* eclTrig = &m_eclTrigsBuffer[trigId - 1];
        // fill trigid, trgtime for eclTrig object
        trigId |= (burstSuppressionMask & 0xFFF) << 6;
        eclTrig->setTrigId(trigId);
        eclTrig->setTimeTrig(triggerPhase0);
        eclTrig->setTrigTag(triggerTag0);
      }
 
    } // try
    catch (...) {
      // errors while reading data block
      // do something (count errors etc) TODO
      B2ERROR("Corrupted data from ECL collector");
    }
 
  }// loop over FINESSEs
 
}

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

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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;
}

◆ tagsReported()

bool tagsReported ( unsigned int iCrate )

inlineprivate

Check if the problem with different trigger tags was already reported for crate iCrate.

Definition at line 134 of file eclUnpackerModule.h.

134{ return m_tagsReportedMask & (1L << (iCrate - 1)); }

◆ terminate()

void terminate ( void )

overridevirtual

terminate

Reimplemented from Module.

Definition at line 203 of file eclUnpackerModule.cc.

204{

205}

Member Data Documentation

◆ m_badHeaderReportedMask

long m_badHeaderReportedMask = 0

private

report only once per crate about problem with shaper header

Definition at line 102 of file eclUnpackerModule.h.

◆ m_bitPos

int m_bitPos

private

bit position for bit-by-bit data read

Definition at line 86 of file eclUnpackerModule.h.

◆ m_bufLength

int m_bufLength

private

length of COPPER data

Definition at line 84 of file eclUnpackerModule.h.

◆ m_bufPos

int m_bufPos

private

position in the COPPER data array

Definition at line 82 of file eclUnpackerModule.h.

◆ m_bufPtr

unsigned int* m_bufPtr

private

pointer to data from COPPER

Definition at line 80 of file eclUnpackerModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_debugLevel

int m_debugLevel

private

Cached debug level from LogSystem.

Definition at line 186 of file eclUnpackerModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_eclDigits

StoreArray<ECLDigit> m_eclDigits

private

store array for digitized gits

Definition at line 171 of file eclUnpackerModule.h.

◆ m_eclDigitsName

std::string m_eclDigitsName

private

name of output collection for ECLDigits

Definition at line 147 of file eclUnpackerModule.h.

◆ m_eclDsps

StoreArray<ECLDsp> m_eclDsps

private

store array for waveforms

Definition at line 175 of file eclUnpackerModule.h.

◆ m_eclDspsName

std::string m_eclDspsName

private

name of output collection for ECLDsp

Definition at line 151 of file eclUnpackerModule.h.

◆ m_eclMapper

ECL::ECLChannelMapper m_eclMapper

private

ECL channel mapper.

Definition at line 156 of file eclUnpackerModule.h.

◆ m_eclMapperInitFileName

std::string m_eclMapperInitFileName

private

name of the file with correspondence between cellID and crate/shaper/channel numbers

Definition at line 153 of file eclUnpackerModule.h.

◆ m_eclTrigs

StoreArray<ECLTrig> m_eclTrigs

private

store array for eclTrigs data (trigger time and tag)

Definition at line 173 of file eclUnpackerModule.h.

◆ m_eclTrigsBuffer

ECLTrig m_eclTrigsBuffer[ECL::ECL_CRATES]

private

ECLTrigs objects before they are added to m_eclTrigs array.

Definition at line 183 of file eclUnpackerModule.h.

◆ m_eclTrigsName

std::string m_eclTrigsName

private

name of output collection for ECLTrig

Definition at line 149 of file eclUnpackerModule.h.

◆ m_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData

private

store objptr for EventMetaData

Definition at line 166 of file eclUnpackerModule.h.

◆ m_evtNumReportedMask

long m_evtNumReportedMask = 0

private

report only once per crate about inconsistency between trg tag and evt number

Definition at line 96 of file eclUnpackerModule.h.

◆ m_globalEvtNum

int m_globalEvtNum

private

event number from EventMetaData

Definition at line 75 of file eclUnpackerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_localEvtNum

int m_localEvtNum

private

Internally counted event number.

Definition at line 77 of file eclUnpackerModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

◆ m_phasesReportedMask

long m_phasesReportedMask = 0

private

report only once per crate about problem with different trg phases

Definition at line 100 of file eclUnpackerModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

◆ m_rawEcl

StoreArray<RawECL> m_rawEcl

private

store array for RawECL

Definition at line 164 of file eclUnpackerModule.h.

◆ m_relDigitToDsp

RelationArray m_relDigitToDsp {m_eclDigits, m_eclDsps}

private

ECLDigit->ECLTrig relation array.

Definition at line 180 of file eclUnpackerModule.h.

◆ m_relDigitToTrig

RelationArray m_relDigitToTrig {m_eclDigits, m_eclTrigs}

private

ECLDigit->ECLTrig relation array.

Definition at line 178 of file eclUnpackerModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_storeTrigTime

bool m_storeTrigTime

private

flag for whether or not to store collection with trigger times

Definition at line 89 of file eclUnpackerModule.h.

◆ m_storeUnmapped

bool m_storeUnmapped

private

flag for whether or not to store ECLDsp data for unmapped channels

Definition at line 91 of file eclUnpackerModule.h.

◆ m_tagsReportedMask

long m_tagsReportedMask = 0

private

report only once per crate about problem with different trg tags

Definition at line 98 of file eclUnpackerModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_unpackingParams

DBObjPtr<ECLChannelMap> m_unpackingParams

private

Run-dependent unpacking parameters for each channel.

Definition at line 159 of file eclUnpackerModule.h.

◆ m_useUnpackingParameters

bool m_useUnpackingParameters

private

Use ECLUnpackingParameters payload for run-dependent unpacking.

Definition at line 93 of file eclUnpackerModule.h.

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

ecl/modules/eclUnpacker/include/eclUnpackerModule.h
ecl/modules/eclUnpacker/src/eclUnpackerModule.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

◆ ECLUnpack

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLUnpackerModule()

◆ ~ECLUnpackerModule()

Member Function Documentation

◆ badHeaderReported()

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ doBadHeaderReport()

◆ doEvtNumReport()

◆ doPhasesReport()

◆ doTagsReport()

◆ endRun()

◆ evalCondition()

◆ event()

◆ evtNumReported()

◆ 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()

◆ isDSPValid()

◆ phasesReported()

◆ readNBits()

◆ readNextCollectorWord()

◆ readRawECLData()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ tagsReported()

◆ terminate()

Member Data Documentation

◆ m_badHeaderReportedMask