Collect hit information for KLM time calibration with CAF. More...

#include <KLMTimeCollectorModule.h>

Inheritance diagram for KLMTimeCollectorModule:

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
	KLMTimeCollectorModule ()
	Constructor.

virtual	~KLMTimeCollectorModule ()
	Destructor.

void	prepare () override
	Initializes the module.

void	collect () override
	Event action, collect information for calibration.

void	finish () override
	Termination action.

void	initialize () final
	Set up a default RunRange object in datastore and call prepare()

void	event () final
	Check current experiment and run and update if needed, fill into RunRange and collect()

void	beginRun () final
	Reset the m_runCollectOnRun flag, if necessary, to begin collection again.

void	endRun () final
	Write the current collector objects to a file and clear their memory.

void	terminate () final
	Write the final objects to the file.

void	defineHisto () final
	Runs due to HistoManager, allows us to discover the correct file.

template<class T >
void	registerObject (std::string name, T *obj)
	Register object with a name, takes ownership, do not access the pointer beyond prepare()

template<class T >
T *	getObjectPtr (std::string name)
	Calls the CalibObjManager to get the requested stored collector data.

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	startRun ()
	Replacement for beginRun(). Do anything you would normally do in beginRun here.

virtual void	closeRun ()
	Replacement for endRun(). Do anything you would normally do in endRun here.

virtual void	inDefineHisto ()
	Replacement for defineHisto(). Do anything you would normally do in defineHisto here.

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.

Protected Attributes
TDirectory *	m_dir
	The top TDirectory that collector objects for this collector will be stored beneath.

CalibObjManager	m_manager
	Controls the creation, collection and access to calibration objects.

RunRange *	m_runRange
	Overall list of runs processed.

Calibration::ExpRun	m_expRun
	Current ExpRun for object retrieval (becomes -1,-1 for granularity=all)

StoreObjPtr< EventMetaData >	m_emd
	Current EventMetaData.

Private Member Functions
void	collectRPC (RelationVector< KLMHit2d > &)
	Collect hits information for RPC of BKLM.

void	collectScint (RelationVector< KLMHit2d > &)
	Collect hits information for scintillator of BKLM.

void	collectScintEnd (const RelationVector< KLMHit2d > &)
	Collect hits information for scintillator of EKLM.

std::pair< ExtHit , ExtHit >	matchExt (KLMChannelNumber channelID, std::multimap< unsigned int, ExtHit > &)
	Match KLM hit and extHit.

void	storeDistDiff (ROOT::Math::XYZVector &)
	Save position difference between matched kLMHit and ExtHit.

bool	getPreScaleChoice ()
	I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values.

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
bool	m_useEvtT0
	Use event T0 or not.

bool	m_IgnoreBackwardPropagation
	Whether to ignore ExtHits with backward propagation.

std::string	m_inputListName
	Input partilce list name.

std::multimap< unsigned int, ExtHit >	m_vExtHits_RPC
	Map for handle the extHit related to RPC.

std::multimap< unsigned int, ExtHit >	m_vExtHits
	Map for handle the extHit related to scint.

StoreArray< Track >	m_tracks
	Global tracks.

StoreObjPtr< EventT0 >	m_eventT0
	Event T0 array.

KLMTimeAlgorithm::Event	m_Event
	Time calibration data event.

const bklm::GeometryPar *	m_geoParB
	BKLM geometry parameters.

const EKLM::GeometryData *	m_geoParE
	EKLM geometry parameters.

EKLM::TransformData *	m_TransformData
	Transformation data.

const KLMElementNumbers *	m_elementNum
	KLM element numbers.

DBObjPtr< KLMChannelStatus >	m_channelStatus
	Channel status.

TH1D *	m_HeventT0_0
	Event T0 distribution before track selection.

TH1D *	m_HeventT0_1
	Event T0 distribution after track selection.

TH1I *	m_HnumTrack
	Number of tracks.

TH1I *	m_HnKLMHit2dOfTrack
	Number of KLM hits related to track.

TH1D *	m_HpositionDiff
	Difference between global and local position.

TH1D *	m_HpositionXDiff
	Difference between global and local position (X).

TH1D *	m_HpositionYDiff
	Difference between global and local position (Y).

TH1D *	m_HpositionZDiff
	Difference between global and local position (Z).

TH2D *	m_HflyTimeB
	Particle flying time versus detector layers (for BKLM).

TH2D *	m_HflyTimeE
	Particle flying time versus detector layers (for EKLM).

TH1I *	m_HnumDigit_scint_end
	EKLM parts.

TH1I *	m_HnumDigit_scint
	BKLM scitillator part.

TH1I *	m_HnumDigit_rpc
	BKLM RPC part.

TTree *	m_outTree
	Data collection tree.

std::string	m_granularity
	Granularity of data collection = run\|all(= no granularity, exp,run=-1,-1)

int	m_maxEventsPerRun
	Maximum number of events to be collected at the start of each run (-1 = no maximum)

float	m_preScale
	Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].

StoreObjPtr< EventMetaData >	m_evtMetaData
	Required input for EventMetaData.

bool	m_runCollectOnRun = true
	Whether or not we will run the collect() at all this run, basically skips the event() function if false.

std::map< Calibration::ExpRun, int >	m_expRunEvents
	How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.

int *	m_eventsCollectedInRun
	Will point at correct value in m_expRunEvents.

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

Collect hit information for KLM time calibration with CAF.

Definition at line 42 of file KLMTimeCollectorModule.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

◆ KLMTimeCollectorModule()

KLMTimeCollectorModule ( )

Constructor.

Definition at line 39 of file KLMTimeCollectorModule.cc.

                                               :
  CalibrationCollectorModule(),
  m_geoParB(nullptr),
  m_geoParE(nullptr),
  m_TransformData(nullptr),
  m_HeventT0_0(nullptr),
  m_HeventT0_1(nullptr),
  m_HnumTrack(nullptr),
  m_HnKLMHit2dOfTrack(nullptr),
  m_HpositionDiff{nullptr},
  m_HpositionXDiff(nullptr),
  m_HpositionYDiff(nullptr),
  m_HpositionZDiff(nullptr),
  m_HflyTimeB(nullptr),
  m_HflyTimeE(nullptr),
  m_HnumDigit_scint_end(nullptr),
  m_HnumDigit_scint(nullptr),
  m_HnumDigit_rpc(nullptr),
  m_outTree(nullptr)
{
  setDescription("Module for KLM time calibration (data collection).");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("inputParticleList", m_inputListName, "input particle list.", std::string("mu+:cali"));
  addParam("useEventT0", m_useEvtT0, "Use event T0 or not.", true);
  addParam("IgnoreBackwardPropagation", m_IgnoreBackwardPropagation,
           "Whether to ignore ExtHits with backward propagation.", false);
 
  m_elementNum = &(KLMElementNumbers::Instance());
}

◆ ~KLMTimeCollectorModule()

~KLMTimeCollectorModule ( )

virtual

Destructor.

Definition at line 70 of file KLMTimeCollectorModule.cc.

71{

72}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

finalvirtualinherited

Reset the m_runCollectOnRun flag, if necessary, to begin collection again.

It seems that the beginRun() function is called in each basf2 subprocess when the run changes in each process. This is nice because it allows us to write the new (exp,run) object creation in the beginRun function as though the other processes don't exist.

Reimplemented from HistoModule.

Definition at line 77 of file CalibrationCollectorModule.cc.

{
  // Current (Exp,Run)
  ExpRun expRun = make_pair(m_emd->getExperiment(), m_emd->getRun());
  m_runRange->add(expRun.first, expRun.second);
 
  // Do we care about the number of events collected in each (input data) ExpRun?
  // If so, we want to create values for the events collected map
  if (m_maxEventsPerRun > -1) {
    // Do we have a count for this ExpRun yet? If not create one
    auto i_eventsInExpRun = m_expRunEvents.find(expRun);
    if (i_eventsInExpRun == m_expRunEvents.end()) {
      m_expRunEvents[expRun] = 0;
    }
 
    // Set our pointer to the correct location for this ExpRun
    m_eventsCollectedInRun = &m_expRunEvents[expRun];
    // Want to reset our flag to start collection if necessary
    if ((*m_eventsCollectedInRun) < m_maxEventsPerRun) {
      B2INFO("New run has had less events than the maximum collected so far ("
             << (*m_eventsCollectedInRun)
             << " < "
             << m_maxEventsPerRun
             << "). Turning on collection.");
      m_runCollectOnRun = true;
    } else {
      B2INFO("New run has had more events than the maximum collected so far ("
             << (*m_eventsCollectedInRun)
             << " >= "
             << m_maxEventsPerRun
             << "). Turning off collection.");
      m_runCollectOnRun = false;
    }
  }
  // Granularity=all removes data splitting by runs by setting
  // always the same exp, run for calibration data objects
  if (m_granularity == "all") {
    m_expRun = { -1, -1};
  } else {
    m_expRun = expRun;
  }
  m_manager.createExpRunDirectories(m_expRun);
  // Run the user's startRun() implementation if there is one
  startRun();
}

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

◆ closeRun()

virtual void closeRun ( )

inlineprotectedvirtualinherited

Replacement for endRun(). Do anything you would normally do in endRun here.

Reimplemented in TOPValidationCollectorModule, MillepedeCollectorModule, CaTestModule, CDCCrudeT0CollectorModule, eclAutocovarianceCalibrationC1CollectorModule, eclAutocovarianceCalibrationC3CollectorModule, eclAutocovarianceCalibrationC4CollectorModule, eclWaveformTemplateCalibrationC1CollectorModule, KLMChannelStatusCollectorModule, KLMStripEfficiencyCollectorModule, SVDCrossTalkCalibrationsCollectorModule, and SVDOccupancyCalibrationsCollectorModule.

Definition at line 77 of file CalibrationCollectorModule.h.

77{}

◆ collect()

void collect ( )

overridevirtual

Event action, collect information for calibration.

Reimplemented from CalibrationCollectorModule.

Definition at line 141 of file KLMTimeCollectorModule.cc.

{
  StoreObjPtr<EventMetaData> eventMetaData("EventMetaData", DataStore::c_Event);
 
  m_Event.t0 = 0.0;
  /* Require event T0 determined from CDC. */
  if (m_useEvtT0) {
    if (!m_eventT0.isValid())
      return;
    if (!m_eventT0->hasTemporaryEventT0(Const::EDetector::CDC))
      return;
    const auto bestCDCEvtT0C = m_eventT0->getBestCDCTemporaryEventT0();
    m_Event.t0 = bestCDCEvtT0C->eventT0;
  }
 
  /* Read event metadata. */
  int runId = eventMetaData->getRun();
  int evtId = eventMetaData->getEvent();
 
  getObjectPtr<TH1D>("m_HevtT0_0")->Fill(m_Event.t0);
 
  const StoreObjPtr<ParticleList> inputList(m_inputListName);
  unsigned n_track =  inputList->getListSize();
  /* Return if there are no tracks. */
  if (n_track < 1) {
    B2DEBUG(20, "No necessary tracks in" << LogVar("run", runId) << LogVar("event", evtId));
    return;
  }
 
  B2DEBUG(20, "debug info for" << LogVar("run", runId) << LogVar("event", evtId) << LogVar("number of rec tracks", n_track));
 
  getObjectPtr<TH1D>("m_HevtT0_1")->Fill(m_Event.t0);
  getObjectPtr<TH1I>("m_HnTrack")->Fill(n_track);
 
  /* Here begins the ext track sequence */
  B2DEBUG(20, "Collect :: Track loop begins.");
 
  /* Main loop */
  for (unsigned iT = 0; iT < n_track; ++iT) {
    // Good track selection
    const Particle* particle = inputList->getParticle(iT);
    const Track* track = particle->getTrack();
 
    // Find data objects related to track
    RelationVector<ExtHit> extHits = track->getRelationsTo<ExtHit>();
    RelationVector<KLMHit2d> klmHit2ds = track->getRelationsTo<KLMHit2d>();
 
    getObjectPtr<TH1I>("m_HnKLMHit2d")->Fill(int(klmHit2ds.size()));
 
    B2DEBUG(20, "Track" << LogVar("exthits", extHits.size())
            << LogVar("KLMHit2d", klmHit2ds.size()));
    if (klmHit2ds.size() < 2)
      continue;
 
    // Loop for extroplate hits
    m_vExtHits.clear();
    m_vExtHits_RPC.clear();
    B2DEBUG(20, "Collect :: extHits loop begins.");
    for (const ExtHit& eHit : extHits) {
      if (eHit.getStatus() != EXT_EXIT)
        continue;
 
      if (m_IgnoreBackwardPropagation) {
        if (eHit.isBackwardPropagated())
          continue;
      }
 
      bool bklmCover = (eHit.getDetectorID() == Const::EDetector::BKLM);
      bool eklmCover = (eHit.getDetectorID() == Const::EDetector::EKLM);
      if (!bklmCover && !eklmCover)
        continue;
 
      int copyId = eHit.getCopyID();
      int tFor, tSec, tLay, tPla, tStr;
      int tSub = -1;
 
      if (eklmCover) {
        tSub = KLMElementNumbers::c_EKLM;
        EKLMElementNumbers::Instance().stripNumberToElementNumbers(copyId, &tFor, &tLay, &tSec, &tPla, &tStr);
      }
      if (bklmCover) {
        tSub = KLMElementNumbers::c_BKLM;
        BKLMElementNumbers::channelNumberToElementNumbers(copyId, &tFor, &tSec, &tLay, &tPla, &tStr);
      }
      if (tSub < 0)
        continue;
      B2DEBUG(20, "Collect :: Assign elementNum based on copyId for extHits." << LogVar("Sub from elementNumber",
              tSub) << LogVar("bklmCover", bklmCover) << LogVar("eklmCover", eklmCover));
 
      bool crossed = false; // should be only once ?
      KLMMuidLikelihood* muidLikelihood = track->getRelatedTo<KLMMuidLikelihood>();
      if (bklmCover) {
        crossed = muidLikelihood->isExtrapolatedBarrelLayerCrossed(tLay - 1);
        if (crossed) {
          if (tLay > 2) {
            unsigned int tModule = m_elementNum->moduleNumber(tSub, tFor, tSec, tLay);
            m_vExtHits_RPC.insert(std::pair<unsigned int, ExtHit>(tModule, eHit));
          } else {
            unsigned int tChannel = m_elementNum->channelNumber(tSub, tFor, tSec, tLay, tPla, tStr);
            if (m_channelStatus->getChannelStatus(tChannel) != KLMChannelStatus::c_Normal)
              continue;
            m_vExtHits.insert(std::pair<unsigned int, ExtHit>(tChannel, eHit));
          }
        }
      }
      if (eklmCover) {
        crossed = muidLikelihood->isExtrapolatedEndcapLayerCrossed(tLay - 1);
        if (crossed) {
          unsigned int tChannel = m_elementNum->channelNumber(tSub, tFor, tSec, tLay, tPla, tStr);
          if (m_channelStatus->getChannelStatus(tChannel) != KLMChannelStatus::c_Normal)
            continue;
          m_vExtHits.insert(std::pair<unsigned int, ExtHit>(tChannel, eHit));
        }
      }
    }
    if (m_vExtHits.size() > 0) {
      collectScintEnd(klmHit2ds);
      collectScint(klmHit2ds);
    }
    if (m_vExtHits_RPC.size() > 0) {
      collectRPC(klmHit2ds);
    }
  }
}

◆ collectRPC()

void collectRPC ( RelationVector< KLMHit2d > & klmHit2ds )

private

Collect hits information for RPC of BKLM.

Definition at line 394 of file KLMTimeCollectorModule.cc.

{
  for (KLMHit2d& hit2d : klmHit2ds) {
    if (hit2d.getSubdetector() != KLMElementNumbers::c_BKLM)
      continue;
    if (!hit2d.inRPC())
      continue;
    if (hit2d.isOutOfTime())
      continue;
    RelationVector<BKLMHit1d> bklmHit1ds = hit2d.getRelationsTo<BKLMHit1d>();
    if (bklmHit1ds.size() != 2)
      continue;
 
    ROOT::Math::XYZVector positionGlobal_hit2d = hit2d.getPosition();
    const bklm::Module* corMod = m_geoParB->findModule(hit2d.getSection(), hit2d.getSector(), hit2d.getLayer());
    double stripWidtm_HZ = corMod->getZStripWidth();
    double stripWidtm_HPhi = corMod->getPhiStripWidth();
 
    for (const BKLMHit1d& hit1d : bklmHit1ds) {
      RelationVector<KLMDigit> digits = hit1d.getRelationsTo<KLMDigit>();
      getObjectPtr<TH1I>("m_HnDigit_rpc")->Fill(digits.size());
      if (digits.size() > 5)
        continue;
 
      for (const KLMDigit& digitHit : digits) {
        unsigned int channelId_digit = digitHit.getUniqueChannelID();
        m_Event.inRPC = digitHit.inRPC();
        if (m_channelStatus->getChannelStatus(channelId_digit) != KLMChannelStatus::c_Normal)
          continue;
        unsigned int tModule = m_elementNum->moduleNumber(digitHit.getSubdetector(), digitHit.getSection(), digitHit.getSector(),
                                                          digitHit.getLayer());
 
        std::pair<ExtHit*, ExtHit*> pair_extHits = matchExt(tModule, m_vExtHits_RPC);
        if (pair_extHits.first == nullptr || pair_extHits.second == nullptr)
          continue;
        ExtHit& entryHit = *(pair_extHits.first);
        ExtHit& exitHit = *(pair_extHits.second);
 
        m_Event.flyTime = 0.5 * (entryHit.getTOF() + exitHit.getTOF());
        ROOT::Math::XYZVector positionGlobal_extHit = 0.5 * (entryHit.getPosition() + exitHit.getPosition());
        ROOT::Math::XYZVector positionGlobal_diff = positionGlobal_extHit - positionGlobal_hit2d;
        B2DEBUG(20, LogVar("Distance between digit and hit2d", positionGlobal_diff.R()));
 
        storeDistDiff(positionGlobal_diff);
        const CLHEP::Hep3Vector positionLocal_extHit = corMod->globalToLocal(CLHEP::Hep3Vector(
                                                         positionGlobal_extHit.X(), positionGlobal_extHit.Y(), positionGlobal_extHit.Z()), true);
        const CLHEP::Hep3Vector positionLocal_hit2d = corMod->globalToLocal(CLHEP::Hep3Vector(
                                                        positionGlobal_hit2d.X(), positionGlobal_hit2d.Y(), positionGlobal_hit2d.Z()), true);
        const CLHEP::Hep3Vector diffLocal = positionLocal_extHit - positionLocal_hit2d;
        if (fabs(diffLocal.z()) > stripWidtm_HZ  || fabs(diffLocal.y()) > stripWidtm_HPhi)
          continue;
 
        const CLHEP::Hep3Vector propaLengthV3 = corMod->getPropagationDistance(positionLocal_extHit);
        double propaLength = propaLengthV3[2 - int(hit1d.isPhiReadout())];
 
        m_Event.isFlipped = corMod->isFlipped();
        m_Event.recTime = digitHit.getTime();
        m_Event.dist = propaLength;
        m_Event.eDep = digitHit.getEnergyDeposit();
        m_Event.nPE = digitHit.getNPhotoelectrons();
        m_Event.channelId = channelId_digit;
 
        getObjectPtr<TH2D>("m_HfTimeB")->Fill(m_Event.flyTime, digitHit.getLayer());
        getObjectPtr<TTree>("time_calibration_data")->Fill();
      }
    }
  }
}

◆ collectScint()

void collectScint ( RelationVector< KLMHit2d > & klmHit2ds )

private

Collect hits information for scintillator of BKLM.

Definition at line 322 of file KLMTimeCollectorModule.cc.

{
  double stripWidtm_HZ, stripWidtm_HPhi;
  for (KLMHit2d& hit2d : klmHit2ds) {
    if (hit2d.getSubdetector() != KLMElementNumbers::c_BKLM)
      continue;
    if (hit2d.inRPC())
      continue;
    if (hit2d.isOutOfTime())
      continue;
 
    RelationVector<BKLMHit1d> bklmHit1ds = hit2d.getRelationsTo<BKLMHit1d>();
    if (bklmHit1ds.size() != 2)
      continue;
 
    ROOT::Math::XYZVector positionGlobal_hit2d = hit2d.getPosition();
    const bklm::Module* corMod = m_geoParB->findModule(hit2d.getSection(), hit2d.getSector(), hit2d.getLayer());
    stripWidtm_HZ = corMod->getZStripWidth();
    stripWidtm_HPhi = corMod->getPhiStripWidth();
 
    for (const BKLMHit1d& hit1d : bklmHit1ds) {
      RelationVector<KLMDigit> digits = hit1d.getRelationsTo<KLMDigit>();
      getObjectPtr<TH1I>("m_HnDigit_scint")->Fill(digits.size());
      if (digits.size() > 3)
        continue;
 
      for (const KLMDigit& digitHit : digits) {
        if (digitHit.inRPC() || !digitHit.isGood())
          continue;
 
        unsigned int channelId_digit = digitHit.getUniqueChannelID();
        if (m_channelStatus->getChannelStatus(channelId_digit) != KLMChannelStatus::c_Normal)
          continue;
 
        std::pair<ExtHit*, ExtHit*> pair_extHits = matchExt(channelId_digit, m_vExtHits);
        if (pair_extHits.first == nullptr || pair_extHits.second == nullptr)
          continue;
        ExtHit& entryHit = *(pair_extHits.first);
        ExtHit& exitHit = *(pair_extHits.second);
 
        m_Event.inRPC = digitHit.inRPC();
        m_Event.flyTime = 0.5 * (entryHit.getTOF() + exitHit.getTOF());
 
        ROOT::Math::XYZVector positionGlobal_extHit = 0.5 * (entryHit.getPosition() + exitHit.getPosition());
        ROOT::Math::XYZVector positionGlobal_diff = positionGlobal_extHit - positionGlobal_hit2d;
        B2DEBUG(20, LogVar("Distance between digit and hit2d", positionGlobal_diff.R()));
 
        storeDistDiff(positionGlobal_diff);
        const CLHEP::Hep3Vector positionLocal_extHit = corMod->globalToLocal(CLHEP::Hep3Vector(
                                                         positionGlobal_extHit.X(), positionGlobal_extHit.Y(), positionGlobal_extHit.Z()), true);
        const CLHEP::Hep3Vector positionLocal_hit2d = corMod->globalToLocal(CLHEP::Hep3Vector(
                                                        positionGlobal_hit2d.X(), positionGlobal_hit2d.Y(), positionGlobal_hit2d.Z()), true);
        const CLHEP::Hep3Vector diffLocal = positionLocal_extHit - positionLocal_hit2d;
        if (fabs(diffLocal.z()) > stripWidtm_HZ  || fabs(diffLocal.y()) > stripWidtm_HPhi)
          continue;
 
        double propaLength = corMod->getPropagationDistance(positionLocal_extHit, digitHit.getStrip(), digitHit.isPhiReadout());
 
        m_Event.isFlipped = corMod->isFlipped();
        m_Event.recTime = digitHit.getTime();
        m_Event.dist = propaLength;
        m_Event.eDep = digitHit.getEnergyDeposit();
        m_Event.nPE = digitHit.getNPhotoelectrons();
        m_Event.channelId = channelId_digit;
 
        getObjectPtr<TH2D>("m_HfTimeB")->Fill(m_Event.flyTime, digitHit.getLayer());
        getObjectPtr<TTree>("time_calibration_data")->Fill();
      }
    }
  }
}

◆ collectScintEnd()

void collectScintEnd ( const RelationVector< KLMHit2d > & klmHit2ds )

private

Collect hits information for scintillator of EKLM.

Definition at line 266 of file KLMTimeCollectorModule.cc.

{
  const HepGeom::Transform3D* tr;
  HepGeom::Point3D<double> hitGlobal_extHit, hitLocal_extHit;
  double l;
 
  for (const KLMHit2d& hit2d : klmHit2ds) {
    if (hit2d.getSubdetector() != KLMElementNumbers::c_EKLM)
      continue;
    RelationVector<KLMDigit> digits = hit2d.getRelationsTo<KLMDigit>();
    unsigned nDigit = digits.size();
    getObjectPtr<TH1I>("m_HnDigit_scint_end")->Fill(nDigit);
    if (nDigit != 2)
      B2FATAL("Wrong number of related KLMDigits.");
 
    if (!digits[0]->isGood() || !digits[1]->isGood())
      continue;
 
    for (KLMDigit& digitHit : digits) {
      m_Event.channelId = digitHit.getUniqueChannelID();
      m_Event.inRPC = 0;
      if (m_channelStatus->getChannelStatus(m_Event.channelId) != KLMChannelStatus::c_Normal)
        continue;
 
      std::pair<ExtHit*, ExtHit*> pair_extHits = matchExt(m_Event.channelId, m_vExtHits);
      if (pair_extHits.first == nullptr || pair_extHits.second == nullptr)
        continue;
      ExtHit& entryHit = *(pair_extHits.first);
      ExtHit& exitHit = *(pair_extHits.second);
 
      m_Event.flyTime = 0.5 * (entryHit.getTOF() + exitHit.getTOF());
 
      ROOT::Math::XYZVector positionGlobal_extHit = 0.5 * (entryHit.getPosition() + exitHit.getPosition());
      ROOT::Math::XYZVector positionGlobal_digit = hit2d.getPosition();
      ROOT::Math::XYZVector positionGlobal_diff = positionGlobal_extHit - positionGlobal_digit;
 
      storeDistDiff(positionGlobal_diff);
 
      l = m_geoParE->getStripLength(digitHit.getStrip()) / CLHEP::mm * Unit::mm;
      hitGlobal_extHit.setX(positionGlobal_extHit.X() / Unit::mm * CLHEP::mm);
      hitGlobal_extHit.setY(positionGlobal_extHit.Y() / Unit::mm * CLHEP::mm);
      hitGlobal_extHit.setZ(positionGlobal_extHit.Z() / Unit::mm * CLHEP::mm);
      tr = m_TransformData->getStripGlobalToLocal(&digitHit);
      hitLocal_extHit = (*tr) * hitGlobal_extHit;
 
      m_Event.dist = 0.5 * l - hitLocal_extHit.x() / CLHEP::mm * Unit::mm;
      m_Event.recTime = digitHit.getTime();
      m_Event.eDep = digitHit.getEnergyDeposit();
      m_Event.nPE = digitHit.getNPhotoelectrons();
 
      getObjectPtr<TH2D>("m_HfTimeE")->Fill(m_Event.flyTime, digitHit.getLayer());
      getObjectPtr<TTree>("time_calibration_data")->Fill();
    }
  }
}

◆ 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

◆ defineHisto()

void defineHisto ( )

finalvirtualinherited

Runs due to HistoManager, allows us to discover the correct file.

Reimplemented from HistoModule.

Definition at line 127 of file CalibrationCollectorModule.cc.

{
  if (!ProcHandler::parallelProcessingUsed() || ProcHandler::isWorkerProcess()) {
    m_dir = gDirectory->mkdir(getName().c_str(), "", true);
    m_manager.setDirectory(m_dir);
    B2INFO("Saving output to TDirectory " << m_dir->GetPath());
    B2DEBUG(100, "Creating directories for individual collector objects.");
    m_manager.createDirectories();
    m_runRange = new RunRange();
    m_runRange->setGranularity(m_granularity);
    m_runRange->SetName(Calibration::RUN_RANGE_OBJ_NAME.c_str());
    m_dir->Add(m_runRange);
  }
  inDefineHisto();
}

◆ endRun()

void endRun ( void )

finalvirtualinherited

Write the current collector objects to a file and clear their memory.

Reimplemented from HistoModule.

Definition at line 143 of file CalibrationCollectorModule.cc.

{
  closeRun();
  // Moving between runs possibly creates new objects if getObjectPtr is called and granularity is run
  // So we should write and clear the current memory objects.
  if (m_granularity == "run") {
    ExpRun expRun = make_pair(m_emd->getExperiment(), m_emd->getRun());
    m_manager.writeCurrentObjects(expRun);
    m_manager.clearCurrentObjects(expRun);
  }
}

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

finalvirtualinherited

Check current experiment and run and update if needed, fill into RunRange and collect()

Reimplemented from HistoModule.

Definition at line 52 of file CalibrationCollectorModule.cc.

{
  // Should we collect data this event based on the number collected in the run?
  if (m_runCollectOnRun) {
    // If yes, does our preScale return true?
    if (getPreScaleChoice()) {
      collect();
      // Since we collected, do we care about incrementing the number of events collected?
      if (m_maxEventsPerRun > -1) {
        (*m_eventsCollectedInRun) += 1;
        // Now that we incremented, have we exceeded our maximum collected events in this run?
        if ((*m_eventsCollectedInRun) >= m_maxEventsPerRun) {
          // If we have, we should skip collection until further notice
          B2INFO("Reached maximum number of events processed by collector for this run ("
                 << (*m_eventsCollectedInRun)
                 << " >= "
                 << m_maxEventsPerRun
                 << "). Turning off collection.");
          m_runCollectOnRun = false;
        }
      }
    }
  }
}

◆ 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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ finish()

void finish ( )

overridevirtual

Termination action.

Reimplemented from CalibrationCollectorModule.

Definition at line 502 of file KLMTimeCollectorModule.cc.

503{

504}

◆ 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

◆ getObjectPtr()

T * getObjectPtr ( std::string name )

inlineinherited

Calls the CalibObjManager to get the requested stored collector data.

Definition at line 64 of file CalibrationCollectorModule.h.

    {
      return m_manager.getObject<T>(name, m_expRun);
    }

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

◆ getPreScaleChoice()

bool getPreScaleChoice ( )

inlineprivateinherited

I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values.

But since a user will have set them (or left them as default) as exactly equal to 0.0 or 1.0 rather than calculating them in almost every case, I think we can assume that the equalities hold.

Definition at line 122 of file CalibrationCollectorModule.h.

    {
      if (m_preScale == 1.) {
        return true;
      } else if (m_preScale == 0.) {
        return false;
      } else {
        const double randomNumber = gRandom->Uniform();
        return randomNumber < m_preScale;
      }
    }

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ inDefineHisto()

virtual void inDefineHisto ( )

inlineprotectedvirtualinherited

Replacement for defineHisto(). Do anything you would normally do in defineHisto here.

Reimplemented in CaTestModule, ECLBhabhaTCollectorModule, eclBhabhaTimeCalibrationValidationCollectorModule, eclHadronTimeCalibrationValidationCollectorModule, and eclTimeShiftsPlottingCollectorModule.

Definition at line 81 of file CalibrationCollectorModule.h.

81{}

◆ initialize()

void initialize ( void )

finalvirtualinherited

Set up a default RunRange object in datastore and call prepare()

Reimplemented from HistoModule.

Definition at line 44 of file CalibrationCollectorModule.cc.

{
  m_evtMetaData.isRequired();
  REG_HISTOGRAM
  prepare();
}

◆ matchExt()

std::pair< ExtHit , ExtHit > matchExt	(	KLMChannelNumber	channelID,
		std::multimap< unsigned int, ExtHit > &	v_ExtHits
	)

private

Match KLM hit and extHit.

Definition at line 463 of file KLMTimeCollectorModule.cc.

{
  ExtHit* entryHit = nullptr;
  ExtHit* exitHit = nullptr;
  std::multimap<unsigned int, ExtHit>::iterator it, itlow, itup;
  itlow = v_ExtHits.lower_bound(channelID);
  itup = v_ExtHits.upper_bound(channelID);
  for (it = itlow; it != itup; ++it) {
    if (entryHit == nullptr) {
      entryHit = &(it->second);
    } else if ((it->second).getTOF() < entryHit->getTOF()) {
      entryHit = &(it->second);
    }
    if (exitHit == nullptr) {
      exitHit = &(it->second);
    } else if ((it->second).getTOF() > exitHit->getTOF()) {
      exitHit = &(it->second);
    }
  }
  std::pair<ExtHit*, ExtHit*> p_extHits = std::make_pair(entryHit, exitHit);
  return p_extHits;
}

◆ prepare()

void prepare ( )

overridevirtual

Initializes the module.

Reimplemented from CalibrationCollectorModule.

Definition at line 74 of file KLMTimeCollectorModule.cc.

{
  /* Initialize geometry. */
  m_geoParB = bklm::GeometryPar::instance();
  m_geoParE = &(EKLM::GeometryData::Instance());
  m_TransformData = new EKLM::TransformData(true, EKLM::TransformData::c_None);
 
  /* Require input dataobjects. */
  if (m_useEvtT0)
    m_eventT0.isRequired("EventT0");
  m_tracks.isRequired();
 
  /* Initialization of output tree. */
  m_outTree = new TTree("time_calibration_data", "");
  m_outTree->Branch("t0",        &m_Event.t0,        "t0/D");
  m_outTree->Branch("flyTime",   &m_Event.flyTime,   "flyTime/D");
  m_outTree->Branch("recTime",   &m_Event.recTime,   "recTime/D");
  m_outTree->Branch("dist",      &m_Event.dist,      "dist/D");
  m_outTree->Branch("diffDistX", &m_Event.diffDistX, "diffDistX/D");
  m_outTree->Branch("diffDistY", &m_Event.diffDistY, "diffDistY/D");
  m_outTree->Branch("diffDistZ", &m_Event.diffDistZ, "diffDistZ/D");
  m_outTree->Branch("eDep",      &m_Event.eDep,      "eDep/D");
  m_outTree->Branch("nPE",       &m_Event.nPE,       "nPE/D");
  m_outTree->Branch("channelId", &m_Event.channelId, "channelId/I");
  m_outTree->Branch("inRPC",     &m_Event.inRPC,     "inRPC/O");
  m_outTree->Branch("isFlipped", &m_Event.isFlipped, "isFlipped/O");
 
  registerObject<TTree>("time_calibration_data", m_outTree);
 
  /* Initialization of histograms. */
  m_HeventT0_0 = new TH1D("m_HeventT0_0", "collision time before track number request;t0[ns]", 200, -100, 100);
  m_HeventT0_1 = new TH1D("m_HeventT0_1", "collision time after track number request;t0[ns]", 200, -100, 100);
  m_HnumTrack = new TH1I("m_HnnumTrack", "Number of Track;nTrack", 30, 0, 30);
 
  m_HnKLMHit2dOfTrack = new TH1I("m_HnKLMHit2dOfTrack", "Number of KLMHit2d belong to recTrack;num of KLMHit2d", 20, 0, 20);
 
  m_HpositionDiff = new TH1D("m_HpositionDiff", "Dist between extHit and KLMHit2d;dist", 160, 0, 8);
  m_HpositionXDiff = new TH1D("m_HpositionXDiff", "DistX between extHit and KLMHit2d;distX", 100, 0, 5);
  m_HpositionYDiff = new TH1D("m_HpositionYDiff", "DistY between extHit and KLMHit2d;distY", 100, 0, 5);
  m_HpositionZDiff = new TH1D("m_HpositionZDiff", "DistZ between extHit and KLMHit2d;distZ", 100, 0, 5);
 
  m_HflyTimeB = new TH2D("m_HflyTimeB", "flyTime;flyTime(wet)/ns;Layer", 40, 0, 20, 20, 0, 20);
  m_HflyTimeE = new TH2D("m_HflyTimeE", "flyTime;flyTime(wet)/ns;Layer", 40, 0, 20, 20, 0, 20);
 
  m_HnumDigit_rpc = new TH1I("m_HnumDigit_rpc", "Number of digit per bklmHit1d (RPC);number of digit", 15, 0, 15);
  m_HnumDigit_scint = new TH1I("m_HnumDigit_scint", "Number of digit per bklmHit1d (scint);number of digit", 15, 0, 15);
  m_HnumDigit_scint_end = new TH1I("m_HnumDigit_scint_end", "Number of eklmDigit per eklmHit2d (scint);number of eklmDigit", 15, 0,
                                   15);
 
  registerObject<TH1D>("m_HevtT0_0", m_HeventT0_0);
  registerObject<TH1D>("m_HevtT0_1", m_HeventT0_1);
  registerObject<TH1I>("m_HnTrack", m_HnumTrack);
  registerObject<TH1I>("m_HnKLMHit2d", m_HnKLMHit2dOfTrack);
 
  registerObject<TH1D>("m_HposiDiff", m_HpositionDiff);
  registerObject<TH1D>("m_HposiXDiff", m_HpositionXDiff);
  registerObject<TH1D>("m_HposiYDiff", m_HpositionYDiff);
  registerObject<TH1D>("m_HposiZDiff", m_HpositionZDiff);
 
  registerObject<TH2D>("m_HfTimeB", m_HflyTimeB);
  registerObject<TH2D>("m_HfTimeE", m_HflyTimeE);
 
  registerObject<TH1I>("m_HnDigit_rpc", m_HnumDigit_rpc);
  registerObject<TH1I>("m_HnDigit_scint", m_HnumDigit_scint);
  registerObject<TH1I>("m_HnDigit_scint_end", m_HnumDigit_scint_end);
}

◆ registerObject()

void registerObject	(	std::string	name,
		T *	obj
	)

inlineinherited

Register object with a name, takes ownership, do not access the pointer beyond prepare()

Definition at line 55 of file CalibrationCollectorModule.h.

    {
      std::shared_ptr<T> calObj(obj);
      calObj->SetName(name.c_str());
      m_manager.addObject(name, calObj);
    }

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

◆ startRun()

virtual void startRun ( )

inlineprotectedvirtualinherited

Replacement for beginRun(). Do anything you would normally do in beginRun here.

Reimplemented in TOPValidationCollectorModule, CaTestModule, CDCCrudeT0CollectorModule, eclAutocovarianceCalibrationC1CollectorModule, eclAutocovarianceCalibrationC3CollectorModule, eclAutocovarianceCalibrationC4CollectorModule, eclWaveformTemplateCalibrationC1CollectorModule, eclWaveformTemplateCalibrationC2CollectorModule, KLMStripEfficiencyCollectorModule, PXDClusterChargeCollectorModule, PXDPerformanceCollectorModule, PXDPerformanceVariablesCollectorModule, SVDCrossTalkCalibrationsCollectorModule, SVDOccupancyCalibrationsCollectorModule, SVDClusterTimeShifterCollectorModule, SVDTimeCalibrationCollectorModule, and SVDTimeValidationCollectorModule.

Definition at line 75 of file CalibrationCollectorModule.h.

75{}

◆ storeDistDiff()

void storeDistDiff ( ROOT::Math::XYZVector & pDiff )

private

Save position difference between matched kLMHit and ExtHit.

Definition at line 487 of file KLMTimeCollectorModule.cc.

{
  double diffM = pDiff.R();
  double diffX = pDiff.X();
  double diffY = pDiff.Y();
  double diffZ = pDiff.Z();
  getObjectPtr<TH1D>("m_HposiDiff")->Fill(diffM);
  getObjectPtr<TH1D>("m_HposiXDiff")->Fill(diffX);
  getObjectPtr<TH1D>("m_HposiYDiff")->Fill(diffY);
  getObjectPtr<TH1D>("m_HposiZDiff")->Fill(diffZ);
  m_Event.diffDistX = diffX;
  m_Event.diffDistY = diffY;
  m_Event.diffDistZ = diffZ;
}

◆ terminate()

void terminate ( void )

finalvirtualinherited

Write the final objects to the file.

Reimplemented from HistoModule.

Definition at line 155 of file CalibrationCollectorModule.cc.

{
  finish();
  // actually this should be done by the write() called by HistoManager....
 
  // Haven't written objects yet if collecting with granularity == all
  // Write them now that everything is done.
//  if (m_granularity == "all") {
//    m_manager.writeCurrentObjects(m_expRun);
//    m_manager.clearCurrentObjects(m_expRun);
//  }
  m_manager.deleteHeldObjects();
}

Member Data Documentation

◆ m_channelStatus

DBObjPtr<KLMChannelStatus> m_channelStatus

private

Channel status.

Definition at line 134 of file KLMTimeCollectorModule.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_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_dir

TDirectory* m_dir

protectedinherited

The top TDirectory that collector objects for this collector will be stored beneath.

Definition at line 84 of file CalibrationCollectorModule.h.

◆ m_elementNum

const KLMElementNumbers* m_elementNum

private

KLM element numbers.

Definition at line 131 of file KLMTimeCollectorModule.h.

◆ m_emd

StoreObjPtr<EventMetaData> m_emd

protectedinherited

Current EventMetaData.

Definition at line 96 of file CalibrationCollectorModule.h.

◆ m_Event

KLMTimeAlgorithm::Event m_Event

private

Time calibration data event.

Definition at line 119 of file KLMTimeCollectorModule.h.

◆ m_eventsCollectedInRun

int* m_eventsCollectedInRun

privateinherited

Will point at correct value in m_expRunEvents.

Definition at line 117 of file CalibrationCollectorModule.h.

◆ m_eventT0

StoreObjPtr<EventT0> m_eventT0

private

Event T0 array.

Definition at line 116 of file KLMTimeCollectorModule.h.

◆ m_evtMetaData

StoreObjPtr<EventMetaData> m_evtMetaData

privateinherited

Required input for EventMetaData.

Definition at line 108 of file CalibrationCollectorModule.h.

◆ m_expRun

Calibration::ExpRun m_expRun

protectedinherited

Current ExpRun for object retrieval (becomes -1,-1 for granularity=all)

Definition at line 93 of file CalibrationCollectorModule.h.

◆ m_expRunEvents

std::map<Calibration::ExpRun, int> m_expRunEvents

privateinherited

How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.

Definition at line 115 of file CalibrationCollectorModule.h.

◆ m_geoParB

const bklm::GeometryPar* m_geoParB

private

BKLM geometry parameters.

Definition at line 122 of file KLMTimeCollectorModule.h.

◆ m_geoParE

const EKLM::GeometryData* m_geoParE

private

EKLM geometry parameters.

Definition at line 125 of file KLMTimeCollectorModule.h.

◆ m_granularity

std::string m_granularity

privateinherited

Granularity of data collection = run|all(= no granularity, exp,run=-1,-1)

Definition at line 101 of file CalibrationCollectorModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_HeventT0_0

TH1D* m_HeventT0_0

private

Event T0 distribution before track selection.

Definition at line 139 of file KLMTimeCollectorModule.h.

◆ m_HeventT0_1

TH1D* m_HeventT0_1

private

Event T0 distribution after track selection.

Definition at line 142 of file KLMTimeCollectorModule.h.

◆ m_HflyTimeB

TH2D* m_HflyTimeB

private

Particle flying time versus detector layers (for BKLM).

Definition at line 163 of file KLMTimeCollectorModule.h.

◆ m_HflyTimeE

TH2D* m_HflyTimeE

private

Particle flying time versus detector layers (for EKLM).

Definition at line 166 of file KLMTimeCollectorModule.h.

◆ m_HnKLMHit2dOfTrack

TH1I* m_HnKLMHit2dOfTrack

private

Number of KLM hits related to track.

Definition at line 148 of file KLMTimeCollectorModule.h.

◆ m_HnumDigit_rpc

TH1I* m_HnumDigit_rpc

private

BKLM RPC part.

Definition at line 177 of file KLMTimeCollectorModule.h.

◆ m_HnumDigit_scint

TH1I* m_HnumDigit_scint

private

BKLM scitillator part.

Definition at line 174 of file KLMTimeCollectorModule.h.

◆ m_HnumDigit_scint_end

TH1I* m_HnumDigit_scint_end

private

EKLM parts.

Definition at line 171 of file KLMTimeCollectorModule.h.

◆ m_HnumTrack

TH1I* m_HnumTrack

private

Number of tracks.

Definition at line 145 of file KLMTimeCollectorModule.h.

◆ m_HpositionDiff

TH1D* m_HpositionDiff

private

Difference between global and local position.

Definition at line 151 of file KLMTimeCollectorModule.h.

◆ m_HpositionXDiff

TH1D* m_HpositionXDiff

private

Difference between global and local position (X).

Definition at line 154 of file KLMTimeCollectorModule.h.

◆ m_HpositionYDiff

TH1D* m_HpositionYDiff

private

Difference between global and local position (Y).

Definition at line 157 of file KLMTimeCollectorModule.h.

◆ m_HpositionZDiff

TH1D* m_HpositionZDiff

private

Difference between global and local position (Z).

Definition at line 160 of file KLMTimeCollectorModule.h.

◆ m_IgnoreBackwardPropagation

bool m_IgnoreBackwardPropagation

private

Whether to ignore ExtHits with backward propagation.

Definition at line 101 of file KLMTimeCollectorModule.h.

◆ m_inputListName

std::string m_inputListName

private

Input partilce list name.

Definition at line 104 of file KLMTimeCollectorModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_manager

CalibObjManager m_manager

protectedinherited

Controls the creation, collection and access to calibration objects.

Definition at line 87 of file CalibrationCollectorModule.h.

◆ m_maxEventsPerRun

int m_maxEventsPerRun

privateinherited

Maximum number of events to be collected at the start of each run (-1 = no maximum)

Definition at line 103 of file CalibrationCollectorModule.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_outTree

TTree* m_outTree

private

Data collection tree.

Definition at line 180 of file KLMTimeCollectorModule.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_preScale

float m_preScale

privateinherited

Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].

Definition at line 105 of file CalibrationCollectorModule.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_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_runCollectOnRun

bool m_runCollectOnRun = true

privateinherited

Whether or not we will run the collect() at all this run, basically skips the event() function if false.

Definition at line 111 of file CalibrationCollectorModule.h.

◆ m_runRange

RunRange* m_runRange

protectedinherited

Overall list of runs processed.

Definition at line 90 of file CalibrationCollectorModule.h.

◆ m_tracks

StoreArray<Track> m_tracks

private

Global tracks.

Definition at line 113 of file KLMTimeCollectorModule.h.

◆ m_TransformData

EKLM::TransformData* m_TransformData

private

Transformation data.

Definition at line 128 of file KLMTimeCollectorModule.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_useEvtT0

bool m_useEvtT0

private

Use event T0 or not.

Definition at line 98 of file KLMTimeCollectorModule.h.

◆ m_vExtHits

std::multimap<unsigned int, ExtHit> m_vExtHits

private

Map for handle the extHit related to scint.

Definition at line 110 of file KLMTimeCollectorModule.h.

◆ m_vExtHits_RPC

std::multimap<unsigned int, ExtHit> m_vExtHits_RPC

private

Map for handle the extHit related to RPC.

Definition at line 107 of file KLMTimeCollectorModule.h.

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

klm/modules/KLMTimeCollector/include/KLMTimeCollectorModule.h
klm/modules/KLMTimeCollector/src/KLMTimeCollectorModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ KLMTimeCollectorModule()

◆ ~KLMTimeCollectorModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ closeRun()

◆ collect()

◆ collectRPC()

◆ collectScint()

◆ collectScintEnd()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ defineHisto()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ finish()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getObjectPtr()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getPreScaleChoice()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ inDefineHisto()

◆ initialize()

◆ matchExt()

◆ prepare()

◆ registerObject()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ startRun()

◆ storeDistDiff()