CDCUnpackerModule Class Reference

CDCUnpackerModule: The CDC Raw Hits Decoder. More...

#include <CDCUnpackerModule.h>

Inheritance diagram for CDCUnpackerModule:

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
	CDCUnpackerModule ()
	Constructor of the module.
virtual	~CDCUnpackerModule ()
	Destructor of the module.
void	initialize () override
	Initializes the Module.
void	beginRun () override
	Begin run action.
void	event () override
	Event action (main routine).
void	endRun () override
	End run action.
void	terminate () override
	Termination action.
void	setCDCPacketHeader (const int *buf)
	Set CDC Packet header.
int	getDataType ()
	Getter for CDC data mode.
int	getTriggerTime ()
	Getter for trigger time in nsec.
int	getDataLength ()
	Getter for data length in byte.
int	getTriggerNumber ()
	Getter for trigger number.
int	getBoardId ()
	Getter for FE board ID.
void	loadMap ()
	Load FE channel to cell ID map.
void	setADCPedestal ()
	Set DBobject of ADC delta pedestal.
WireID	getWireID (int iBoard, int iCh) const
	Getter of Wire ID.
void	printBuffer (int *buf, int nwords)
	Print out the CDC data block in hex.
bool	isValidBoardChannel (WireID wireId)
	Check if the hit wire is valid or not.
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
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_dataType
	Data type of CDC data block.
int	m_version
	Format version.
int	m_boardId
	Front end board ID.
int	m_triggerTime
	Trigger time.
int	m_dataLength
	Data length of the CDC data block (in bytes).
int	m_triggerNumber
	Trigger number.
bool	m_enableStoreCDCRawHit
	Enable/Disable to store CDCRawHit.
bool	m_enablePrintOut
	Enable/Disable to print out the data to the terminal.
std::string	m_rawCDCName
	Name of the RawCDC dataobject (suppressed mode).
std::string	m_cdcRawHitName
	Name of the CDCRawHit dataobject (suppressed mode).
std::string	m_cdcRawHitWaveFormName
	Name of the CDCRawHit dataobject (raw data mode).
std::string	m_cdcHitName
	Tree name of the CDCHit object.
std::string	m_xmlMapFileName
	Name of the assignment map of FE board channel to the cell.
std::string	m_relCDCRawHitToCDCHitName
	Relation name between CDCRawHit and CDCHit.
std::string	m_relCDCRawHitWFToCDCHitName
	Relation name between CDCRawHitWaveForm and CDCHit.
std::vector< unsigned short >	m_buffer
	Short ward buffer of CDC event block.
WireID	m_map [300][48]
	Assignment map of FE board channel to the cell.
int	m_fadcThreshold
	FADC threshold.
int	m_tdcOffset
	TDC offset (nsec).
int	m_tdcAuxOffset
	TDC auxiliary offset (nsec).
int	m_boardIDTrig
	Board ID for the trigger.
int	m_channelTrig
	Channel for the trigger.
bool	m_subtractTrigTiming
	Enable/Disable to subtract the trigger timing from TDCs.
bool	m_enableDatabase
	Enable/Disable to read the channel map from the database.
bool	m_enable2ndHit
	Enable/Disable to 2nd hit output.
DBArray< CDCChannelMap > *	m_channelMapFromDB
	Channel map retrieved from DB.
DBObjPtr< CDCADCDeltaPedestals > *	m_adcPedestalFromDB = nullptr
	ADC delta pedestal.
bool	m_pedestalSubtraction = true
	Whether pedestal is subtracted (true) or not (false).
StoreArray< RawCDC >	m_rawCDCs
	Input array for CDC Raw.
StoreArray< CDCRawHitWaveForm >	m_CDCRawHitWaveForms
	Raw hit waveforms.
StoreArray< CDCRawHit >	m_CDCRawHits
	Raw hits.
StoreArray< CDCHit >	m_CDCHits
	CDC hits.
bool	m_dataLengthError
	True if data length error has been already reported.
bool	m_dataSizeError
	True if data size error between CDCFE and COPPER has been already reported.
bool	m_relationRawHits
	True if add relation of CDCHits, CDCRawHits, and CDCRawHitWaveForms.
bool	m_recoverBoardIdError
	Recover boardID error if true, skip information otherwise.
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

CDCUnpackerModule: The CDC Raw Hits Decoder.

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

CDCUnpackerModule()

CDCUnpackerModule

(

)

Constructor of the module.

Definition at line 35 of file CDCUnpackerModule.cc.

                                     : Module()
{
  //Set module properties
  setDescription("CDCUnpacker generates CDCHit from Raw data.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("rawCDCName", m_rawCDCName, "Name of the RawCDC List name..", string(""));
  addParam("cdcRawHitWaveFormName", m_cdcRawHitWaveFormName, "Name of the CDCRawHit (Raw data mode).", string(""));
  addParam("cdcRawHitName", m_cdcRawHitName, "Name of the CDCRawHit (Suppressed mode).", string(""));
  addParam("cdcHitName", m_cdcHitName, "Name of the CDCHit List name..", string(""));
  addParam("fadcThreshold", m_fadcThreshold, "Threshold count.", 1);
 
  addParam("xmlMapFileName", m_xmlMapFileName, "path+name of the xml file", string(""));
  addParam("enableStoreCDCRawHit", m_enableStoreCDCRawHit, "Enable to store to the CDCRawHit object", false);
  addParam("enablePrintOut", m_enablePrintOut, "Enable to print out the data to the terminal", false);
  addParam("boardIDTrig", m_boardIDTrig, "Board ID for the trigger.", 7);
  addParam("channelTrig", m_channelTrig, "Channel for the trigger.", 1);
  addParam("subtractTrigTiming", m_subtractTrigTiming, "Enable to subtract the trigger timing from TDCs.", false);
  addParam("tdcOffset", m_tdcOffset, "TDC offset (in TDC count).", 0);
  addParam("enableDatabase", m_enableDatabase, "Enable database to read the channel map.", true);
  addParam("enable2ndHit", m_enable2ndHit, "Enable 2nd hit timing as a individual CDCHit object.", false);
  addParam("tdcAuxOffset", m_tdcAuxOffset, "TDC auxiliary offset (in TDC count).", 0);
  addParam("pedestalSubtraction", m_pedestalSubtraction, "Enbale ADC pedestal subtraction.", m_pedestalSubtraction);
  addParam("relationRawHits", m_relationRawHits, "Enbale relation of CDCHits, CDCRawHits, and CDCRawHitWaveForms.", false);
  addParam("recoverBoardIdError", m_recoverBoardIdError, "Recover boardID errors", true);
}

~CDCUnpackerModule()

~CDCUnpackerModule ( )

virtual

Destructor of the module.

Definition at line 62 of file CDCUnpackerModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Begin run action.

Reimplemented from Module.

Definition at line 107 of file CDCUnpackerModule.cc.

{
  if (m_enablePrintOut == true) {
    B2INFO("CDCUnpacker: beginRun() called.");
  }
 
 
  loadMap();
  setADCPedestal();
}

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.

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

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

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

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

{ terminate(); }

endRun()

void endRun ( void  )

overridevirtual

End run action.

Reimplemented from Module.

Definition at line 524 of file CDCUnpackerModule.cc.

{
  if (m_enablePrintOut == true) {
    B2INFO("CDCUnpacker : End run.");
  }
}

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 action (main routine).

Reimplemented from Module.

Definition at line 118 of file CDCUnpackerModule.cc.

{
  if (m_enablePrintOut == true) {
    B2INFO("CDCUnpacker: event() started.");
  }
 
  // TDC count for the trigger scinti.
  int tdcCountTrig = m_tdcOffset;
 
  const TrackFindingCDC::CDCWireTopology& wireTopology = TrackFindingCDC::CDCWireTopology::getInstance();
 
  // Create Data objects.
  m_CDCHits.clear();
 
  if (m_relationRawHits == true) {
    RelationArray rawCDCsToCDCHits(m_CDCRawHits, m_CDCHits, m_relCDCRawHitToCDCHitName); // CDCRawHit <-> CDCHit
    RelationArray rawCDCWFsToCDCHits(m_CDCRawHitWaveForms, m_CDCHits, m_relCDCRawHitWFToCDCHitName); // CDCRawHitWaveForm <-> CDCHit
  }
 
  if (m_enableStoreCDCRawHit == true) {
    m_CDCRawHits.clear();
    m_CDCRawHitWaveForms.clear();
  }
 
  //
  // Proccess RawCDC data block.
  //
 
  const int nEntries = m_rawCDCs.getEntries();
 
  B2DEBUG(99, "nEntries of RawCDCs : " << nEntries);
 
  for (int i = 0; i < nEntries; ++i) {
    const int subDetectorId = m_rawCDCs[i]->GetNodeID(0);
    const int iNode = (subDetectorId & 0xFFFFFF);
    const int nEntriesRawCDC = m_rawCDCs[i]->GetNumEntries();
 
    B2DEBUG(99, LogVar("nEntries of rawCDC[i]", nEntriesRawCDC));
 
    for (int j = 0; j < nEntriesRawCDC; ++j) {
      int trigType = m_rawCDCs[i]->GetTRGType(j); // Get event type of L1 trigger.
      int nWords[48];
      int* data32tab[48];
      int MaxNumOfCh = m_rawCDCs[i]->GetMaxNumOfCh(j);
      string readoutName;
      if (MaxNumOfCh == 4) readoutName = "COPPER";
      else if (MaxNumOfCh == 48) readoutName = "PCIe40";
      else
        B2FATAL("CDC UnpackerModule: Invalid value of GetMaxNumOfCh from raw data: " << LogVar("Number of ch: ",
                m_rawCDCs[i]->GetMaxNumOfCh(j)));
 
      for (int k = 0; k < MaxNumOfCh; ++k) {
        nWords[k] = m_rawCDCs[i]->GetDetectorNwords(j, k);
        if (MaxNumOfCh == 48 && m_rawCDCs[i]->CheckOnlineRemovedDataBit(j, k) == true) { //for error flag in ff55 trailer
          if (nWords[k] != 0)
            B2FATAL("The data is not removed for the bad channel (" << j << "," << k << ") with error flag in ff55 trailer! ");
        }
        data32tab[k] = (int*)m_rawCDCs[i]->GetDetectorBuffer(j, k);
      }
 
      //
      // Search Data from Finess 0->MaxNumOfCh (4/48 for COPPER/PCIe40).
      //
 
      for (int iFiness = 0; iFiness < MaxNumOfCh; ++iFiness) {
        int* ibuf = data32tab[iFiness];
        const int nWord = nWords[iFiness];
        B2DEBUG(99, LogVar("nWords (from " + readoutName + " header)", nWord));
 
        if (m_enablePrintOut == true) {
          B2INFO("CDCUnpacker : Print out CDC data block.");
          printBuffer(ibuf, nWord);
        }
 
        const int c_headearWords = 3;
        if (nWord < c_headearWords) {
          if (m_enablePrintOut == true) {
            B2WARNING("CDCUnpacker : No CDC block header.");
          }
          continue;
        }
 
        if (m_enablePrintOut == true) {
          B2INFO("CDCUnpacker : RawDataBlock(CDC) : Block #  "
                 << LogVar("Block", i)
                 << LogVar("Node", iNode)
                 << LogVar("Finness", iFiness));
        }
 
        setCDCPacketHeader(ibuf);
 
        // Skip invalid boardsIDs
        if (m_boardId > 300) {
          B2WARNING("Invalid board " << std::hex << m_boardId << std::dec << " readout buffer block: " << i << " block channel: " << iFiness);
          if (m_recoverBoardIdError) {
            m_boardId = m_boardId & 0x01ff;
            if (m_boardId > 300) {
              B2WARNING("Unrecoverable board " << std::hex << m_boardId);
              continue;
            }
          } else {
            continue;
          }
        }
 
        const int dataType = getDataType();
        const int dataLength = getDataLength() / 4; // Data length in int word (4bytes).
        const int swDataLength = dataLength * 2;   // Data length in short word (2bytes).
 
 
        if (dataLength != (nWord - c_headearWords)) {
          if (m_dataSizeError == false) {
            B2ERROR("Inconsistent data size between " + readoutName + " and CDC FEE."
                    << LogVar("data length", dataLength) << LogVar("nWord", nWord)
                    << LogVar("Node ID", iNode) << LogVar("Finness ID", iFiness));
            m_dataSizeError = true;
          } else {
            B2WARNING("Inconsistent data size between " + readoutName + " and CDC FEE."
                      << LogVar("data length", dataLength) << LogVar("nWord", nWord)
                      << LogVar("Node ID", iNode) << LogVar("Finness ID", iFiness));
          }
          continue;
        }
        if (m_enablePrintOut == true) {
          B2INFO("CDCUnpacker : " << LogVar("Data size", dataLength));
        }
 
        const int board = getBoardId();
        const int trgNumber = getTriggerNumber();
        const int trgTime = getTriggerTime();
 
        if (m_enablePrintOut == true) {
          B2INFO("CDCUnpacker : " << LogVar("Board", board) <<  LogVar("Trigger number", trgNumber)
                 << LogVar("Trigger time ", trgTime));
        }
 
        //
        // Check the data type (raw or supressed mode?).
        //
 
        if (dataType == 1) { //  Raw data mode.
          if (m_enablePrintOut == true) {
            B2INFO("CDCUnpacker : Raw data mode.");
          }
 
          m_buffer.clear();
 
          for (int it = 0; it < dataLength; ++it) {
            int index = it + c_headearWords;
 
            m_buffer.push_back(static_cast<unsigned short>((ibuf[index] & 0xffff0000) >> 16));
            m_buffer.push_back(static_cast<unsigned short>(ibuf[index] & 0xffff));
          }
 
          const int fadcTdcChannels = 48; // Total channels of FADC or TDC.
          const int nSamples = swDataLength / (2 * fadcTdcChannels); // Number of samplings.
 
          std::vector<unsigned short> fadcs;
          std::vector<unsigned short> tdcs;
 
          for (int iCh = 0; iCh < fadcTdcChannels; ++iCh) {
            const int offset = fadcTdcChannels;
            unsigned short fadcSum = 0;     // FADC sum below thereshold.
            unsigned short tdc1 = 0x7fff;   // Fastest TDC.
            unsigned short tdc2 = 0x7fff;   // 2nd fastest TDC.
 
            for (int iSample = 0; iSample < nSamples; ++iSample) {
              // FADC value for each sample and channel.
 
              unsigned short fadc = m_buffer.at(iCh + 2 * fadcTdcChannels * iSample);
 
              if (fadc > m_fadcThreshold) {
                fadcSum += fadc;
              }
              // TDC count for each sample and channel.
 
              unsigned short tdc = m_buffer.at(iCh + 2 * fadcTdcChannels * iSample + offset) & 0x7fff;
              unsigned short tdcIsValid = (m_buffer.at(iCh + 2 * fadcTdcChannels * iSample + offset) & 0x8000) >> 15;
              if (tdcIsValid == 1) { // good tdc data.
                if (tdc > 0) { // if hit timng is 0, skip.
                  if (tdc < tdc1) {
                    tdc2 = tdc1; // 2nd fastest hit
                    tdc1 = tdc;  // fastest hit.
                  }
                }
              }
 
              fadcs.push_back(fadc);
              tdcs.push_back(tdc);
              if (m_enableStoreCDCRawHit == true) {
                // Store to the CDCRawHitWaveForm object.
                const unsigned short status = 0;
                m_CDCRawHitWaveForms.appendNew(status, trgNumber, iNode, iFiness, board, iCh, iSample, trgTime, fadc, tdc);
              }
 
            }
 
            if (tdc1 != 0x7fff) {
              // Store to the CDCHit object.
              const WireID  wireId = getWireID(board, iCh);
              if (wireTopology.isValidWireID(wireId)) {
                if (trgTime < tdc1) {
                  tdc1 = (trgTime | 0x8000) - tdc1;
                } else {
                  tdc1 = trgTime - tdc1;
                }
                CDCHit* firstHit = m_CDCHits.appendNew(tdc1, fadcSum, wireId);
                if (m_enable2ndHit == true) {
                  CDCHit* secondHit = m_CDCHits.appendNew(tdc2, fadcSum, wireId);
                  secondHit->setOtherHitIndices(firstHit);
                  secondHit->set2ndHitFlag();
                }
                if (m_enableStoreCDCRawHit == true) {
                  if (m_relationRawHits == true) {
                    for (int iSample = 0; iSample < nSamples; ++iSample) {
                      m_CDCHits[m_CDCHits.getEntries() - 1]->addRelationTo(m_CDCRawHitWaveForms[m_CDCRawHitWaveForms.getEntries() - 1 + iSample -
                                                                           (nSamples - 1) ]);
                    }
                  }
                }
              } else {
                B2WARNING("Skip invalid wire board, channel: " << board << ", " << iCh);
              }
            }
 
 
 
 
            if (m_enablePrintOut == true) {
              //
              // Print out (for debug).
              //
 
              printf("FADC ch %2d : ", iCh);
              for (int iSample = 0; iSample < nSamples; ++iSample) {
                printf("%4x ", fadcs.at(iSample));
              }
              printf("\n");
 
              printf("TDC ch %2d  : ", iCh);
              for (int iSample = 0; iSample < nSamples; ++iSample) {
                printf("%4x ", tdcs.at(iSample));
              }
              printf("\n");
            }
 
          }
 
        } else if (dataType == 2) { // Suppressed mode.
          if (m_enablePrintOut == true) {
            B2INFO("CDCUnpacker : Suppressed mode.");
          }
 
          // convert int array -> short array.
          m_buffer.clear();
          for (int it = 0; it < dataLength; ++it) {
            int index = it + c_headearWords;
            m_buffer.push_back(static_cast<unsigned short>((ibuf[index] & 0xffff0000) >> 16));
            m_buffer.push_back(static_cast<unsigned short>(ibuf[index] & 0xffff));
          }
 
          const size_t bufSize = m_buffer.size();
          for (size_t it = 0; it < bufSize;) {
            unsigned short header = m_buffer.at(it);     // Header.
            unsigned short ch = (header & 0xff00) >> 8;  // Channel ID in FE.
            unsigned short length = (header & 0xff) / 2; // Data length in short word.
 
            if (header == 0xff02) {
              it++;
              continue;
            }
 
            if (!((length == 4) || (length == 5))) {
              if (m_dataLengthError == false) {
                B2ERROR("CDCUnpacker : data length should be 4 or 5 words."
                        << LogVar("data length", length)
                        << LogVar("board id", board)
                        << LogVar("channel", ch));
                m_dataLengthError = true;
              } else {
                B2WARNING("CDCUnpacker : data length should be 4 or 5 words."
                          << LogVar("data length", length)
                          << LogVar("board id", board)
                          << LogVar("channel", ch));
              }
              break;
            }
 
            unsigned short tot = m_buffer.at(it + 1);     // Time over threshold.
            unsigned short fadcSum = m_buffer.at(it + 2);  // FADC sum.
 
            if (m_pedestalSubtraction == true) {
              int diff = fadcSum - (*m_adcPedestalFromDB)->getPedestal(board, ch);
              if (diff <= m_fadcThreshold) {
                fadcSum = 0;
              } else {
                fadcSum =  static_cast<unsigned short>(diff);
              }
            }
            unsigned short tdc1 = 0;                  // TDC count.
            unsigned short tdc2 = 0;                  // 2nd TDC count.
            unsigned short tdcFlag = 0;               // Multiple hit or not (1 for multi hits, 0 for single hit).
 
            if (length == 4) {
              tdc1 = m_buffer.at(it + 3);
            } else if (length == 5) {
              tdc1 = m_buffer.at(it + 3);
              tdc2 = m_buffer.at(it + 4) & 0x7fff;
              tdcFlag = (m_buffer.at(it + 4) & 0x8000) >> 15;
            } else {
              B2ERROR("CDCUnpacker : Undefined data length (should be 4 or 5 short words) ");
            }
 
            if (ch >= 48) {
              B2WARNING("Invalid channel "
                        << LogVar("channel", ch)
                        << LogVar("board", board)
                        << LogVar("buffer total size", m_buffer.size())
                        << LogVar("length", length)
                        << LogVar("tdc", tdc1)
                        << LogVar("adc", fadcSum)
                        << LogVar("tot", tot)
                       );
              it += length;
              continue;
            }
 
            if (m_enablePrintOut == true) {
              printf("%4x %4x %4x %4x %4x %4x %4x \n", ch, length, tot, fadcSum, tdc1, tdc2, tdcFlag);
            }
            if (length == 4 || length == 5) {
 
              //              const unsigned short status = 0;
              const unsigned short status = trigType; // temporally trigger type is stored, here.
              // Store to the CDCHit.
              const WireID  wireId = getWireID(board, ch);
 
              if (isValidBoardChannel(wireId)) {
                if (wireTopology.isValidWireID(wireId)) {
 
                  if (board == m_boardIDTrig && ch == m_channelTrig) {
                    tdcCountTrig = tdc1;
                  } else {
                    CDCHit* firstHit = m_CDCHits.appendNew(tdc1, fadcSum, wireId,
                                                           0, tot);
                    if (length == 5) {
                      if (m_enable2ndHit == true) {
                        CDCHit* secondHit = m_CDCHits.appendNew(tdc2, fadcSum, wireId,
                                                                0, tot);
                        secondHit->setOtherHitIndices(firstHit);
                        secondHit->set2ndHitFlag();
                      }
                    }
                  }
 
                  if (m_enableStoreCDCRawHit == true) {
                    // Store to the CDCRawHit object.
                    if (m_relationRawHits == true) {
                      CDCRawHit* rawHit = m_CDCRawHits.appendNew(status, trgNumber, iNode, iFiness, board, ch,
                                                                 trgTime, fadcSum, tdc1, tdc2, tot);
                      m_CDCHits[m_CDCHits.getEntries() - 1]->addRelationTo(rawHit);
                      if (m_enable2ndHit == true) {
                        m_CDCHits[m_CDCHits.getEntries() - 2]->addRelationTo(rawHit);
                      }
                    } else {
                      m_CDCRawHits.appendNew(status, trgNumber, iNode, iFiness, board, ch,
                                             trgTime, fadcSum, tdc1, tdc2, tot);
                    }
                  }
                } else {
                  B2WARNING("Skip invalid wire board, channel: " << board << ", " << ch);
                }
              } else {
                B2WARNING("Undefined board id is fired: " << LogVar("board id", board) << " " << LogVar("channel", ch));
              }
            }
            it += length;
          }
 
        } else {
          B2WARNING("CDCUnpacker :  Undefined CDC Data Block : Block #  " << LogVar("block id", i));
        }
      }
    }
  }
 
  //
  // t0 correction w.r.t. the timing of the trigger counter.
  //
  if (m_subtractTrigTiming == true) {
    for (auto& hit : m_CDCHits) {
      int tdc = hit.getTDCCount();
      if (hit.is2ndHit()) {
        if (tdc != 0) {
          tdc  = tdc - (tdcCountTrig - m_tdcOffset);
        }
      } else {
        tdc  = tdc - (tdcCountTrig - m_tdcOffset);
      }
 
      tdc -= m_tdcAuxOffset;
      hit.setTDCCount(static_cast<unsigned short>(tdc));
    }
  }
}

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

getBoardId()

int getBoardId ( )

inline

Getter for FE board ID.

Definition at line 139 of file CDCUnpackerModule.h.

      {
        return m_boardId;
      }

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

getDataLength()

int getDataLength ( )

inline

Getter for data length in byte.

Definition at line 120 of file CDCUnpackerModule.h.

      {
        return m_dataLength;
      }

getDataType()

int getDataType ( )

inline

Getter for CDC data mode.

1 for raw data mode, 2 for suppressed mode.

Definition at line 102 of file CDCUnpackerModule.h.

      {
        return m_dataType;
      }

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

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

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

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

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

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

{ return m_returnValue; }

getTriggerNumber()

int getTriggerNumber ( )

inline

Getter for trigger number.

Definition at line 129 of file CDCUnpackerModule.h.

      {
        return m_triggerNumber;
      }

getTriggerTime()

int getTriggerTime ( )

inline

Getter for trigger time in nsec.

Definition at line 111 of file CDCUnpackerModule.h.

      {
        return m_triggerTime;
      }

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

getWireID()

WireID getWireID	(	int	iBoard,
		int	iCh
	)		const

Getter of Wire ID.

Definition at line 542 of file CDCUnpackerModule.cc.

{
  return m_map[iBoard][iCh];
}

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.

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

{ 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

Initializes the Module.

Reimplemented from Module.

Definition at line 66 of file CDCUnpackerModule.cc.

{
  m_dataLengthError = false;
  m_dataSizeError = false;
  m_channelMapFromDB = new DBArray<CDCChannelMap>;
  if ((*m_channelMapFromDB).isValid()) {
    //    B2INFO("Channel map is  valid");
  } else {
    B2FATAL("Channel map is not valid");
  }
 
  if (m_enablePrintOut == true) {
    B2INFO("CDCUnpacker: initialize() Called.");
  }
 
  m_rawCDCs.isRequired(m_rawCDCName);
  m_CDCRawHitWaveForms.registerInDataStore(m_cdcRawHitWaveFormName);
  m_CDCRawHits.registerInDataStore(m_cdcRawHitName);
  m_CDCHits.registerInDataStore(m_cdcHitName);
 
  if (m_relationRawHits == true) {
    m_CDCHits.registerRelationTo(m_CDCRawHitWaveForms);
    m_CDCHits.registerRelationTo(m_CDCRawHits);
 
    // Set default names for the relations.
    m_relCDCRawHitToCDCHitName = DataStore::relationName(
                                   DataStore::arrayName<CDCRawHit>(m_cdcRawHitName),
                                   DataStore::arrayName<CDCHit>(m_cdcHitName));
 
    m_relCDCRawHitWFToCDCHitName = DataStore::relationName(
                                     DataStore::arrayName<CDCRawHitWaveForm>(m_cdcRawHitWaveFormName),
                                     DataStore::arrayName<CDCHit>(m_cdcHitName));
  }
 
  if (m_enablePrintOut == true) {
    B2INFO("CDCUnpacker: " << LogVar("FADC threshold", m_fadcThreshold));
  }
 
  TrackFindingCDC::CDCWireTopology::getInstance();
}

isValidBoardChannel()

bool isValidBoardChannel ( WireID  wireId )

inline

Check if the hit wire is valid or not.

Parameters

wireId

hit wire.

Definition at line 171 of file CDCUnpackerModule.h.

      {
        if (wireId.getEWire() == 65535) {
          return false;
        } else {
          return true;
        }
      }

loadMap()

void loadMap

(

)

Load FE channel to cell ID map.

Definition at line 547 of file CDCUnpackerModule.cc.

{
 
  if (m_enableDatabase == false) {
 
    // Read the channel map from the local text.
    std::string fileName = FileSystem::findFile(m_xmlMapFileName);
    std::cout << fileName << std::endl;
    if (fileName == "") {
      B2ERROR("CDC unpacker can't find a filename: " << LogVar("file name", fileName));
      exit(1);
    }
 
 
    ifstream ifs;
    ifs.open(fileName.c_str());
    int isl;
    int icl;
    int iw;
    int iBoard;
    int iCh;
 
    while (!ifs.eof()) {
      ifs >>  isl >> icl >> iw >> iBoard >> iCh;
      const WireID  wireId(isl, icl, iw);
      m_map[iBoard][iCh] = wireId;
    }
  } else {
    for (const auto& cm : (*m_channelMapFromDB)) {
      const int isl = cm.getISuperLayer();
      const int il = cm.getILayer();
      const int iw = cm.getIWire();
      const int iBoard = cm.getBoardID();
      const int iCh = cm.getBoardChannel();
      const WireID  wireId(isl, il, iw);
      m_map[iBoard][iCh] = wireId;
    }
  }
}

printBuffer()

void printBuffer	(	int *	buf,
		int	nwords
	)

Print out the CDC data block in hex.

Parameters

buf	pointer to the buffer in RawCDC (RawCOPPER).
nwords	number of words to be printed out.

Definition at line 598 of file CDCUnpackerModule.cc.

{
 
  for (int j = 0; j < nwords; ++j) {
    printf(" %.8x", buf[j]);
    if ((j + 1) % 10 == 0) {
      printf("\n");
    }
  }
  printf("\n");
 
  return;
}

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

setADCPedestal()

void setADCPedestal

(

)

Set DBobject of ADC delta pedestal.

Definition at line 587 of file CDCUnpackerModule.cc.

{
  if (m_pedestalSubtraction == true) {
    m_adcPedestalFromDB = new DBObjPtr<CDCADCDeltaPedestals>;
    if (!(*m_adcPedestalFromDB).isValid()) {
      m_pedestalSubtraction = false;
    }
  }
 
}

setCDCPacketHeader()

void setCDCPacketHeader ( const int *  buf )

inline

Set CDC Packet header.

Definition at line 79 of file CDCUnpackerModule.h.

      {
 
        if ((buf[0] & 0xff000000) == 0x22000000) { // raw data mode.
          m_dataType = 1;
        } else if ((buf[0] & 0xff000000) == 0x20000000) { // suppressed data mode.
          m_dataType = 2;
        } else {
          B2ERROR("Undefined data type");
        }
 
        m_version = ((buf[0] & 0xff0000) >> 16); // Always zero.
        m_boardId = (buf[0] & 0xffff);
        m_triggerTime = ((buf[1] & 0xffff0000) >> 16);
        m_dataLength = (buf[1] & 0xffff);
        m_triggerNumber = buf[2];
 
      }

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.

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

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

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

overridevirtual

Termination action.

Reimplemented from Module.

Definition at line 531 of file CDCUnpackerModule.cc.

{
  if (m_enablePrintOut == true) {
    B2INFO("CDCUnpacker : Terminated.");
  }
 
  if (m_channelMapFromDB) delete m_channelMapFromDB;
  if (m_adcPedestalFromDB) delete m_adcPedestalFromDB;
}

Member Data Documentation

m_adcPedestalFromDB

DBObjPtr<CDCADCDeltaPedestals>* m_adcPedestalFromDB = nullptr

private

ADC delta pedestal.

Definition at line 321 of file CDCUnpackerModule.h.

m_boardId

int m_boardId

private

Front end board ID.

Definition at line 194 of file CDCUnpackerModule.h.

m_boardIDTrig

int m_boardIDTrig

private

Board ID for the trigger.

Definition at line 287 of file CDCUnpackerModule.h.

m_buffer

std::vector<unsigned short> m_buffer

private

Short ward buffer of CDC event block.

Definition at line 262 of file CDCUnpackerModule.h.

m_cdcHitName

std::string m_cdcHitName

private

Tree name of the CDCHit object.

Definition at line 241 of file CDCUnpackerModule.h.

m_CDCHits

StoreArray<CDCHit> m_CDCHits

private

CDC hits.

Definition at line 346 of file CDCUnpackerModule.h.

m_cdcRawHitName

std::string m_cdcRawHitName

private

Name of the CDCRawHit dataobject (suppressed mode).

Definition at line 231 of file CDCUnpackerModule.h.

m_CDCRawHits

StoreArray<CDCRawHit> m_CDCRawHits

private

Raw hits.

Definition at line 341 of file CDCUnpackerModule.h.

m_cdcRawHitWaveFormName

std::string m_cdcRawHitWaveFormName

private

Name of the CDCRawHit dataobject (raw data mode).

Definition at line 236 of file CDCUnpackerModule.h.

m_CDCRawHitWaveForms

StoreArray<CDCRawHitWaveForm> m_CDCRawHitWaveForms

private

Raw hit waveforms.

Definition at line 336 of file CDCUnpackerModule.h.

m_channelMapFromDB

DBArray<CDCChannelMap>* m_channelMapFromDB

private

Channel map retrieved from DB.

Definition at line 315 of file CDCUnpackerModule.h.

m_channelTrig

int m_channelTrig

private

Channel for the trigger.

Definition at line 292 of file CDCUnpackerModule.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_dataLength

int m_dataLength

private

Data length of the CDC data block (in bytes).

Definition at line 204 of file CDCUnpackerModule.h.

m_dataLengthError

bool m_dataLengthError

private

True if data length error has been already reported.

Definition at line 351 of file CDCUnpackerModule.h.

m_dataSizeError

bool m_dataSizeError

private

True if data size error between CDCFE and COPPER has been already reported.

Definition at line 356 of file CDCUnpackerModule.h.

m_dataType

int m_dataType

private

Data type of CDC data block.

Definition at line 184 of file CDCUnpackerModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_enable2ndHit

bool m_enable2ndHit

private

Enable/Disable to 2nd hit output.

Definition at line 310 of file CDCUnpackerModule.h.

m_enableDatabase

bool m_enableDatabase

private

Enable/Disable to read the channel map from the database.

Definition at line 304 of file CDCUnpackerModule.h.

m_enablePrintOut

bool m_enablePrintOut

private

Enable/Disable to print out the data to the terminal.

Definition at line 220 of file CDCUnpackerModule.h.

m_enableStoreCDCRawHit

bool m_enableStoreCDCRawHit

private

Enable/Disable to store CDCRawHit.

Definition at line 214 of file CDCUnpackerModule.h.

m_fadcThreshold

int m_fadcThreshold

private

FADC threshold.

Definition at line 273 of file CDCUnpackerModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_map

WireID m_map[300][48]

private

Assignment map of FE board channel to the cell.

1st column : board ID , 2nd column : FE channel (0-47).

Definition at line 268 of file CDCUnpackerModule.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_pedestalSubtraction

bool m_pedestalSubtraction = true

private

Whether pedestal is subtracted (true) or not (false).

Definition at line 326 of file CDCUnpackerModule.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_rawCDCName

std::string m_rawCDCName

private

Name of the RawCDC dataobject (suppressed mode).

Definition at line 226 of file CDCUnpackerModule.h.

m_rawCDCs

StoreArray<RawCDC> m_rawCDCs

private

Input array for CDC Raw.

Definition at line 331 of file CDCUnpackerModule.h.

m_recoverBoardIdError

bool m_recoverBoardIdError

private

Recover boardID error if true, skip information otherwise.

Definition at line 366 of file CDCUnpackerModule.h.

m_relationRawHits

bool m_relationRawHits

private

True if add relation of CDCHits, CDCRawHits, and CDCRawHitWaveForms.

"

Definition at line 361 of file CDCUnpackerModule.h.

m_relCDCRawHitToCDCHitName

std::string m_relCDCRawHitToCDCHitName

private

Relation name between CDCRawHit and CDCHit.

Definition at line 251 of file CDCUnpackerModule.h.

m_relCDCRawHitWFToCDCHitName

std::string m_relCDCRawHitWFToCDCHitName

private

Relation name between CDCRawHitWaveForm and CDCHit.

Definition at line 257 of file CDCUnpackerModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_subtractTrigTiming

bool m_subtractTrigTiming

private

Enable/Disable to subtract the trigger timing from TDCs.

Definition at line 298 of file CDCUnpackerModule.h.

m_tdcAuxOffset

int m_tdcAuxOffset

private

TDC auxiliary offset (nsec).

Definition at line 283 of file CDCUnpackerModule.h.

m_tdcOffset

int m_tdcOffset

private

TDC offset (nsec).

Definition at line 278 of file CDCUnpackerModule.h.

m_triggerNumber

int m_triggerNumber

private

Trigger number.

Definition at line 209 of file CDCUnpackerModule.h.

m_triggerTime

int m_triggerTime

private

Trigger time.

Definition at line 199 of file CDCUnpackerModule.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_version

int m_version

private

Format version.

Definition at line 189 of file CDCUnpackerModule.h.

m_xmlMapFileName

std::string m_xmlMapFileName

private

Name of the assignment map of FE board channel to the cell.

Definition at line 246 of file CDCUnpackerModule.h.

---

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

• cdc/modules/cdcUnpacker/include/CDCUnpackerModule.h
• cdc/modules/cdcUnpacker/src/CDCUnpackerModule.cc