ECLBhabhaTCollectorModule Class Reference

This module generates time vs crystal 2D histograms to later (in eclBhabhaTAlgorithm) find time crystal/crate offsets from bhabha events. More...

#include <ECLBhabhaTCollectorModule.h>

Inheritance diagram for ECLBhabhaTCollectorModule:

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
	ECLBhabhaTCollectorModule ()
	Module constructor.
virtual	~ECLBhabhaTCollectorModule ()
	Module destructor.
void	inDefineHisto () override
	Replacement for defineHisto() in CalibrationCollector modules.
void	prepare () override
	Define histograms and read payloads from DB.
void	collect () override
	Select events and crystals and accumulate histograms.
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	finish ()
	Replacement for terminate(). Do anything you would normally do in terminate 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
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_saveTree
	If true, save TTree with more detailed event info.
StoreArray< Track >	tracks
	StoreArray for tracks.
std::unique_ptr< Belle2::ECL::ECLChannelMapper >	m_crystalMapper
	ECL object for keeping track of mapping between crystals and crates etc.
StoreObjPtr< SoftwareTriggerResult >	m_TrgResult
	Store array for Trigger selection.
StoreObjPtr< EventT0 >	m_eventT0
	StoreObjPtr for T0.
StoreObjPtr< EventMetaData >	m_EventMetaData
	Event metadata.
DBObjPtr< ECLCrystalCalib >	m_ElectronicsDB
	electronics amplitude calibration from database Scale amplitudefor each crystal and for dead pre-amps
std::vector< float >	m_Electronics
	vector obtained from DB object
DBObjPtr< ECLCrystalCalib >	m_ElectronicsTimeDB
	Time offset from electronics calibration from database.
std::vector< float >	m_ElectronicsTime
	vector obtained from DB object
DBObjPtr< ECLCrystalCalib >	m_FlightTimeDB
	Time offset from flight time b/w IP and crystal from database.
std::vector< float >	m_FlightTime
	vector obtained from DB object
DBObjPtr< ECLCrystalCalib >	m_PreviousCrystalTimeDB
	Time offset from previous crystal time calibration (this calibration) from database.
std::vector< float >	m_PreviousCrystalTime
	vector obtained from DB object
std::vector< float >	m_PreviousCrystalTimeUnc
	vector obtained from DB object
DBObjPtr< ECLCrystalCalib >	m_CrateTimeDB
	Time offset from crate time calibration (also this calibration) from database.
std::vector< float >	m_CrateTime
	vector obtained from DB object
std::vector< float >	m_CrateTimeUnc
	uncertainty vector obtained from DB object
DBObjPtr< ECLReferenceCrystalPerCrateCalib >	m_RefCrystalsCalibDB
	Crystal IDs of the one reference crystal per crate from database.
std::vector< short >	m_RefCrystalsCalib
	vector obtained from DB object
DBObjPtr< Belle2::ECLChannelMap >	m_channelMapDB
	Mapper of ecl channels to various other objects, like crates.
TTree *	m_dbgTree_electrons = nullptr
	Output tree with detailed event data.
TTree *	m_dbgTree_tracks = nullptr
	Debug TTree output per track.
TTree *	m_dbgTree_crystals = nullptr
	Debug TTree output per crystal.
TTree *	m_dbgTree_event = nullptr
	Debug TTree output per event.
TTree *	m_dbgTree_allCuts = nullptr
	Debug TTree output after all cuts.
TTree *	m_dbgTree_evt_allCuts = nullptr
	Debug TTree output per event after all cuts.
TTree *	m_dbgTree_crys_allCuts = nullptr
	Debug TTree output per crystal after all cuts.
int	m_tree_evtNum = intNaN
	Event number for debug TTree output.
int	m_tree_cid = intNaN
	ECL Cell ID (1..ECLElementNumbers::c_NCrystals) for debug TTree output.
int	m_tree_amp = intNaN
	Fitting amplitude from ECL for debug TTree output.
double	m_tree_en = realNaN
	Energy of crystal with maximum energy within ECL cluster, GeV for debug TTree output.
double	m_tree_E1Etot = realNaN
	Energy of crystal with maximum energy within ECL cluster divided by total cluster energy, unitless for debug TTree output.
double	m_tree_E1E2 = realNaN
	Energy of crystal with maximum energy within ECL cluster divided by second most energetic crystal in the cluster, unitless for debug TTree output.
double	m_tree_E1p = realNaN
	Energy of crystal with maximum energy within ECL cluster divided by total cluster energy divided by the track momentum, unitless for debug TTree output.
int	m_tree_quality = intNaN
	ECL fit quality for debug TTree output.
double	m_tree_timeF = realNaN
	ECL fitting time for debug TTree output.
double	m_tree_time = realNaN
	Time for Ts distribution for debug TTree output.
double	m_tree_timetsPreviousTimeCalibs = realNaN
	Time for Ts distribution after application of previous time calibrations for debug TTree output.
double	m_tree_t0 = realNaN
	EventT0 (not from ECL) for debug TTree output.
double	m_tree_t0_unc = realNaN
	EventT0 uncertainty for debug TTree output.
double	m_tree_t0_ECLclosestCDC = realNaN
	EventT0 (from ECL) closest to CDC for debug TTree output.
double	m_tree_t0_ECL_minChi2 = realNaN
	EventT0 (from ECL) min chi2 for debug TTree output.
double	m_tree_d0 = realNaN
	Track d0 for debug TTree output.
double	m_tree_z0 = realNaN
	Track z0 for debug TTree output.
double	m_tree_p = realNaN
	Track momentum for debug TTree output.
double	m_tree_nCDChits = realNaN
	Number of CDC hits along the track for debug TTree output.
double	m_tree_clustCrysE_DIV_maxEcrys = realNaN
	ratio of crystal energy to energy of the crystal that has the maximum energy, only for the crystals that meet all the selection criteria for debug TTree output
double	m_tree_clustCrysE = realNaN
	crystal energy, only for the crystals that meet all the selection criteria for debug TTree output
double	m_tree_enPlus = realNaN
	Energy of cluster associated to positively charged track, GeV for debug TTree output.
double	m_tree_enNeg = realNaN
	Energy of cluster associated to negatively charged track, GeV for debug TTree output.
double	m_tree_tClustPos = realNaN
	Cluster time of cluster associated to positively charged track, ns for debug TTree output.
double	m_tree_tClustNeg = realNaN
	Cluster time of cluster associated to negatively charged track, ns for debug TTree output.
double	m_tree_maxEcrystPosClust = realNaN
	Time of the highest energy crystal in the cluster associated to positively charged track, ns for debug TTree output.
double	m_tree_maxEcrystNegClust = realNaN
	Time of the highest energy crystal in the cluster associated to negatively charged track, ns for debug TTree output.
double	m_tree_tClust = realNaN
	Cluster time of a cluster, ns for debug TTree output.
double	m_tree_ECLCalDigitTime = realNaN
	Time of an ECLCalDigit within a cluster, ns for debug TTree output.
double	m_tree_ECLCalDigitE = realNaN
	Energy of an ECLCalDigit within a cluster, GeV for debug TTree output.
double	m_tree_ECLDigitAmplitude = realNaN
	Amplitude (used to calculate energy) of an ECLDigit within a cluster, for debug TTree output.
int	m_charge = intNaN
	particle charge, for debug TTree output
double	m_E_DIV_p = realNaN
	Energy divided by momentum, for debug TTree output.
double	m_massInvTracks = realNaN
	invariant mass of the two tracks, for debug TTree output
StoreArray< ECLDigit >	m_eclDigitArray
	Required input array of ECLDigits.
StoreArray< ECLCalDigit >	m_eclCalDigitArray
	Required input array of ECLCalDigits.
StoreArray< ECLCluster >	m_eclClusterArray
	Required input array of ECLClusters.
std::vector< float >	m_EperCrys
	ECL cal digit energy for each crystal.
std::vector< int >	m_eclCalDigitID
	ECL cal digit id sorter.
std::vector< int >	m_eclDigitID
	ECL digit id sorter.
short	m_timeAbsMax
	Events with abs(time) > m_timeAbsMax are excluded, mostly for histogram x-range purposes.
int	m_minCrystal = intNaN
	First CellId to handle.
int	m_maxCrystal = intNaN
	Last CellId to handle.
double	m_looseTrkZ0 = realNaN
	Loose track z0 minimum cut.
double	m_tightTrkZ0 = realNaN
	Tight track z0 minimum cut.
double	m_looseTrkD0 = realNaN
	Loose track d0 minimum cut.
double	m_tightTrkD0 = realNaN
	Tight track d0 minimum cut.
int	m_crystalCrate = intNaN
	Crate id for the crystal.
int	m_runNum = intNaN
	run number
bool	m_storeCalib = true
	Boolean for whether or not to store the previous calibration calibration constants.
std::unique_ptr< Belle2::ECL::ECLTimingUtilities >	m_ECLTimeUtil
	ECL timing tools.
double	m_hadronEventT0_TO_bhabhaEventT0_correction
	correction to apply to CDC event t0 values in bhabha events to correct for CDC event t0 bias compared to CDC event t0 in hadronic events in ns
bool	skipTrgSel
	flag to skip the trigger skim selection in the module
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

This module generates time vs crystal 2D histograms to later (in eclBhabhaTAlgorithm) find time crystal/crate offsets from bhabha events.

Definition at line 47 of file ECLBhabhaTCollectorModule.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

ECLBhabhaTCollectorModule()

ECLBhabhaTCollectorModule

(

)

Module constructor.

Definition at line 45 of file ECLBhabhaTCollectorModule.cc.

                                                     : CalibrationCollectorModule(),
  m_ElectronicsDB("ECLCrystalElectronics"),
  m_ElectronicsTimeDB("ECLCrystalElectronicsTime"),
  m_FlightTimeDB("ECLCrystalFlightTime"),
  m_PreviousCrystalTimeDB("ECLCrystalTimeOffset"),
  m_CrateTimeDB("ECLCrateTimeOffset"),
  m_RefCrystalsCalibDB("ECLReferenceCrystalPerCrateCalib"),
  m_channelMapDB("ECLChannelMap")//,
{
  setDescription("This module generates sum of all event times per crystal");
 
  addParam("timeAbsMax", m_timeAbsMax, // (Time in ns)
           "Events with fabs(getTimeFit) > m_timeAbsMax "
           "are excluded", (short)80);
 
  addParam("minCrystal", m_minCrystal,
           "First CellId to handle.", 1);
  addParam("maxCrystal", m_maxCrystal,
           "Last CellId to handle.", ECLElementNumbers::c_NCrystals);
 
  addParam("saveTree", m_saveTree,
           "If true, TTree 'tree' with more detailed event info is saved in "
           "the output file specified by HistoManager",
           false);
 
  addParam("looseTrkZ0", m_looseTrkZ0, "max Z0 for loose tracks (cm)", 10.);
  addParam("tightTrkZ0", m_tightTrkZ0, "max Z0 for tight tracks (cm)", 2.);
  addParam("looseTrkD0", m_looseTrkD0, "max D0 for loose tracks (cm)", 2.);
  addParam("tightTrkD0", m_tightTrkD0, "max D0 for tight tracks (cm)", 0.5);  // beam pipe radius = 1cm in 2019
  addParam("skipTrgSel", skipTrgSel, "boolean to skip the trigger skim selection", false);
 
  addParam("hadronEventT0_TO_bhabhaEventT0_correction", m_hadronEventT0_TO_bhabhaEventT0_correction,
           "CDC bhabha t0 bias correction (ns)", 0.);
 
  // specify this flag if you need parallel processing
  setPropertyFlags(c_ParallelProcessingCertified);
}

~ECLBhabhaTCollectorModule()

~ECLBhabhaTCollectorModule ( )

virtual

Module destructor.

Definition at line 83 of file ECLBhabhaTCollectorModule.cc.

{
}

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.

{}

collect()

void collect ( )

overridevirtual

Select events and crystals and accumulate histograms.

< vector derived from DB object

Store the crystal cell id of those being used as the reference crystals for ts. One crystal per crate is defined as having ts=0. This histogram only keeps track of the crystal id, not the crate id. The talg can figure out to which crate to associate the crystal.

Record the input database constants

< number of loose tracks

< number of tight tracks

Reimplemented from CalibrationCollectorModule.

Definition at line 319 of file ECLBhabhaTCollectorModule.cc.

{
  int cutIndexPassed = 0;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: no cuts: index = " << cutIndexPassed);
  B2DEBUG(22, "Event number = " << m_EventMetaData->getEvent());
 
 
  // --- Check the trigger skim is the type that has two tracks
 
  /* If we skip the trigger skim selection then still fill the cutflow histogram
     just so that the positions don't change. */
  if (!skipTrgSel) {
    if (!m_TrgResult.isValid()) {
      B2WARNING("SoftwareTriggerResult required to select bhabha event is not found");
      return;
    }
 
    /* Release05: bhabha_all is grand skim = bhabha+bhabhaecl+radee.  We only want
       to look at the 2 track bhabha events. */
    const std::map<std::string, int>& fresults = m_TrgResult->getResults();
    if (fresults.find("software_trigger_cut&skim&accept_bhabha") == fresults.end()) {
      B2WARNING("Can't find required bhabha trigger identifier");
      return;
    }
 
    const bool eBhabha = (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha") ==
                          SoftwareTriggerCutResult::c_accept);
    B2DEBUG(22, "eBhabha (trigger passed) = " << eBhabha);
 
    if (!eBhabha) {
      return;
    }
  }
 
  /*  Fill the histogram showing that the trigger skim cut passed OR that we
      are skipping this selection. */
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: Trigger cut passed: index = " << cutIndexPassed);
 
 
 
  /* Use ECLChannelMapper to get other detector indices for the crystals
     For conversion from CellID to crate, shaper, and channel ids.
     The initialization function automatically checks to see if the
     object has been initialized and ifthe payload has changed and
     thus needs updating. */
  bool ECLchannelMapHasChanged = m_channelMapDB.hasChanged();
  if (ECLchannelMapHasChanged) {
    B2INFO("ECLBhabhaTCollectorModule::collect() " << LogVar("ECLchannelMapHasChanged", ECLchannelMapHasChanged));
    if (!m_crystalMapper->initFromDB()) {
      B2FATAL("ECLBhabhaTCollectorModule::collect() : Can't initialize eclChannelMapper!");
    }
  }
 
 
  //== Get expected energies and calibration constants from DB. Need to call
  //   hasChanged() for later comparison
  if (m_ElectronicsDB.hasChanged()) {
    m_Electronics = m_ElectronicsDB->getCalibVector();
  }
  if (m_ElectronicsTimeDB.hasChanged()) {
    m_ElectronicsTime = m_ElectronicsTimeDB->getCalibVector();
  }
  if (m_FlightTimeDB.hasChanged()) {
    m_FlightTime = m_FlightTimeDB->getCalibVector();
  }
 
  // Get the previous crystal time offset (the same thing that this calibration is meant to calculate).
  // This can be used for testing purposes, and for the crate time offset.
  if (m_PreviousCrystalTimeDB.hasChanged()) {
    m_PreviousCrystalTime = m_PreviousCrystalTimeDB->getCalibVector();
    m_PreviousCrystalTimeUnc = m_PreviousCrystalTimeDB->getCalibUncVector();
  }
 
  B2DEBUG(29, "Finished checking if previous crystal time payload has changed");
  if (m_CrateTimeDB.hasChanged()) {
    m_CrateTime = m_CrateTimeDB->getCalibVector();
    m_CrateTimeUnc = m_CrateTimeDB->getCalibUncVector();
  }
  B2DEBUG(29, "Finished checking if previous crate time payload has changed");
  B2DEBUG(29, "m_CrateTime size = " << m_CrateTime.size());
  B2DEBUG(25, "Crate time +- uncertainty [0]= " << m_CrateTime[0] << " +- " << m_CrateTimeUnc[0]);
  B2DEBUG(25, "Crate time +- uncertainty [8735]= " << m_CrateTime[8735] << " +- " << m_CrateTimeUnc[8735]);
 
  B2DEBUG(29, "Finished checking if previous crate time payload has changed");
  if (m_RefCrystalsCalibDB.hasChanged()) {
    m_RefCrystalsCalib = m_RefCrystalsCalibDB->getReferenceCrystals();
  }
  B2DEBUG(29, "Finished checking if reference crystal cell ids payload has changed");
 
 
  B2DEBUG(25, "ECLBhabhaTCollector:: loaded ECLCrystalTimeOffset from the database"
          << LogVar("IoV", m_PreviousCrystalTimeDB.getIoV())
          << LogVar("Checksum", m_PreviousCrystalTimeDB.getChecksum()));
  B2DEBUG(25, "ECLBhabhaTCollector:: loaded ECLCrateTimeOffset from the database"
          << LogVar("IoV", m_CrateTimeDB.getIoV())
          << LogVar("Checksum", m_CrateTimeDB.getChecksum()));
  B2DEBUG(25, "ECLBhabhaTCollector:: loaded ECLCrystalElectronics from the database"
          << LogVar("IoV", m_ElectronicsDB.getIoV())
          << LogVar("Checksum", m_ElectronicsDB.getChecksum()));
  B2DEBUG(25, "ECLBhabhaTCollector:: loaded ECLCrystalElectronicsTime from the database"
          << LogVar("IoV", m_ElectronicsTimeDB.getIoV())
          << LogVar("Checksum", m_ElectronicsTimeDB.getChecksum()));
  B2DEBUG(25, "ECLBhabhaTCollector:: loaded ECLCrystalFlightTime from the database"
          << LogVar("IoV", m_FlightTimeDB.getIoV())
          << LogVar("Checksum", m_FlightTimeDB.getChecksum()));
  B2DEBUG(25, "ECLBhabhaTCollector:: loaded ECLReferenceCrystalPerCrateCalib from the database"
          << LogVar("IoV", m_RefCrystalsCalibDB.getIoV())
          << LogVar("Checksum", m_RefCrystalsCalibDB.getChecksum()));
 
 
 
  // Conversion coefficient from ADC ticks to nanoseconds
  // TICKS_TO_NS ~ 0.4913 ns/clock tick
  // 1/(4fRF) = 0.4913 ns/clock tick, where fRF is the accelerator RF frequency
  const double TICKS_TO_NS = 1.0 / (4.0 * EclConfiguration::getRF()) * 1e3;
 
 
  vector<float> Crate_time_ns(52, 0.0); 
  // Make a crate time offset vector with an entry per crate (instead of per crystal) and convert from ADC counts to ns.
  for (int crysID = 1; crysID <= ECLElementNumbers::c_NCrystals; crysID++) {
    int crateID_temp = m_crystalMapper->getCrateID(crysID);
    Crate_time_ns[crateID_temp - 1] = m_CrateTime[crysID] * TICKS_TO_NS;
  }
 
 
 
  for (int crateID_temp = 1; crateID_temp <= 52; crateID_temp++) {
    getObjectPtr<TH1F>("refCrysIDzeroingCrate")->Fill(m_RefCrystalsCalib[crateID_temp - 1] + 0.001);
  }
 
 
  for (int crysID = 1; crysID <= ECLElementNumbers::c_NCrystals; crysID++) {
    getObjectPtr<TH1F>("TsDatabase")->SetBinContent(crysID + 0.001, m_PreviousCrystalTime[crysID - 1]);
    getObjectPtr<TH1F>("TsDatabaseUnc")->SetBinContent(crysID + 0.001, m_PreviousCrystalTimeUnc[crysID - 1]);
    getObjectPtr<TH1F>("TcrateDatabase")->SetBinContent(crysID + 0.001, m_CrateTime[crysID - 1]);
    getObjectPtr<TH1F>("TcrateUncDatabase")->SetBinContent(crysID + 0.001, m_CrateTimeUnc[crysID - 1]);
  }
  if (m_storeCalib) {
    B2INFO("ECLBhabhaTCollector:: ECLCrystalTimeOffset from the database information:"
           << LogVar("IoV", m_PreviousCrystalTimeDB.getIoV())
           << LogVar("Checksum", m_PreviousCrystalTimeDB.getChecksum()));
    B2INFO("First event so print out previous ts values");
    for (int crysID = 1; crysID <= ECLElementNumbers::c_NCrystals; crysID++) {
      B2INFO("cid = " << crysID << ", Ts previous = " << m_PreviousCrystalTime[crysID - 1]);
    }
    m_storeCalib = false;
  }
 
 
 
 
  for (int crateID_temp = 1; crateID_temp <= 52; crateID_temp++) {
    getObjectPtr<TH1F>("tcrateDatabase_ns")->SetBinContent(crateID_temp + 0.001, Crate_time_ns[crateID_temp - 1]);
  }
 
  // Use a histogram with only one bin as a counter to know the number of times the database histograms were filled.
  //    This is mostly useful for the talg when running over multiple runs and trying to read ts values.
  getObjectPtr<TH1I>("databaseCounter")->SetBinContent(1, 1);
 
 
 
  // Save what CDC event t0 correction was applied
  getObjectPtr<TH1F>("CDCEventT0Correction")->SetBinContent(1, m_hadronEventT0_TO_bhabhaEventT0_correction);
 
 
 
 
  /* Getting the event t0 using the full event t0 rather than from the CDC specifically */
  double evt_t0 = -1;
  double evt_t0_unc = -1;
  double evt_t0_ECL_closestCDC = -1;
  double evt_t0_ECL_minChi2 = -1;
 
  // Determine if there is an event t0 to use and then extract the information about it
  if (!m_eventT0.isValid()) {
    //cout << "event t0 not valid\n";
    return;
  } else if (!m_eventT0->hasTemporaryEventT0(Const::EDetector::CDC)) {
    //cout << "no event t0\n";
    return;
  } else {
    // Event has a t0 from CDC
    cutIndexPassed++;
    getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
    B2DEBUG(22, "Cutflow: Event t0 exists: index = " << cutIndexPassed);
 
 
    // Get event t0 from CDC.  We don't want event t0 from ECL as we are calibrating the ECL wrt the more accurately measured time measurements of the time.  Start with the CDC since it has an event t0 but in the future we may switch to the TOP detector.
    // Based on the information from Thomas Hauth <Thomas.Hauth@kit.edu> (leaving physics) we should take the last event t0 in the list of event t0's from the CDC as the later event t0 measurements are calculated in slower but more accurate ways.
    const auto bestCDCEventT0Candidate = m_eventT0->getBestCDCTemporaryEventT0();
    evt_t0 = bestCDCEventT0Candidate->eventT0;   // time value
    evt_t0_unc = bestCDCEventT0Candidate->eventT0Uncertainty;   // uncertainty on event t0
 
 
    // Correct the CDC event t0 value for the bhabha bias
    evt_t0 = evt_t0 + m_hadronEventT0_TO_bhabhaEventT0_correction;   // Bias not yet fixed in CDC t0 reco.
 
 
    // Get the ECL event t0 for comparison - validations
    if (m_eventT0->hasTemporaryEventT0(Const::EDetector::ECL)) {
      vector<EventT0::EventT0Component> evt_t0_list_ECL = m_eventT0->getTemporaryEventT0s(Const::EDetector::ECL);
 
 
      double smallest_CDC_ECL_t0_diff = fabs(evt_t0_list_ECL[0].eventT0 - evt_t0);
      int smallest_CDC_ECL_t0_diff_idx = 0;
      for (long unsigned int ECLi = 0; ECLi < evt_t0_list_ECL.size(); ECLi++) {
        double tempt_ECL_t0 = evt_t0_list_ECL[ECLi].eventT0;
        if (fabs(tempt_ECL_t0 - evt_t0) < smallest_CDC_ECL_t0_diff) {
          smallest_CDC_ECL_t0_diff = fabs(tempt_ECL_t0 - evt_t0);
          smallest_CDC_ECL_t0_diff_idx = ECLi;
        }
      }
 
      evt_t0_ECL_closestCDC = evt_t0_list_ECL[smallest_CDC_ECL_t0_diff_idx].eventT0;   // time value
      B2DEBUG(26, "evt_t0_ECL_closestCDC = " << evt_t0_ECL_closestCDC);
 
 
 
      double smallest_ECL_t0_minChi2 = evt_t0_list_ECL[0].quality;
      int smallest_ECL_t0_minChi2_idx = 0;
 
      B2DEBUG(26, "evt_t0_list_ECL[0].quality = " << evt_t0_list_ECL[0].quality
              << ", with ECL event t0 = " << evt_t0_list_ECL[0].eventT0);
 
      for (long unsigned int ECLi = 0; ECLi < evt_t0_list_ECL.size(); ECLi++) {
        B2DEBUG(26, "evt_t0_list_ECL[" << ECLi << "].quality = " << evt_t0_list_ECL[ECLi].quality
                << ", with ECL event t0 = " <<
                evt_t0_list_ECL[ECLi].eventT0);
        if (evt_t0_list_ECL[ECLi].quality < smallest_ECL_t0_minChi2) {
          smallest_ECL_t0_minChi2 = evt_t0_list_ECL[ECLi].quality;
          smallest_ECL_t0_minChi2_idx = ECLi;
        }
      }
 
      evt_t0_ECL_minChi2 = evt_t0_list_ECL[smallest_ECL_t0_minChi2_idx].eventT0;   // time value
 
      B2DEBUG(26, "evt_t0_ECL_minChi2 = " << evt_t0_ECL_minChi2);
      B2DEBUG(26, "smallest_ECL_t0_minChi2_idx = " << smallest_ECL_t0_minChi2_idx);
    }
  }
 
 
 
  /* Determine the energies for each of the crystals since this isn't naturally connected to the cluster.
     Also determine the indexing of the ecl cal digits and the ecl digits
     Taken from Chris's ec/modules/eclGammaGammaECollector   */
 
  // Resize vectors
  m_EperCrys.resize(ECLElementNumbers::c_NCrystals);
  m_eclCalDigitID.resize(ECLElementNumbers::c_NCrystals);
  m_eclDigitID.resize(ECLElementNumbers::c_NCrystals);
 
 
  int idx = 0;
  for (auto& eclCalDigit : m_eclCalDigitArray) {
    int tempCrysID = eclCalDigit.getCellId() - 1;
    m_EperCrys[tempCrysID] = eclCalDigit.getEnergy();
    m_eclCalDigitID[tempCrysID] = idx;
    idx++;
  }
 
  idx = 0;
  for (auto& eclDigit : m_eclDigitArray) {
    int tempCrysID = eclDigit.getCellId() - 1;
    m_eclDigitID[tempCrysID] = idx;
    idx++;
  }
 
 
 
 
  //---------------------------------------------------------------------
  //..Some utilities
  PCmsLabTransform boostrotate;
 
  //---------------------------------------------------------------------
  //..Track properties, including 2 maxp tracks. Use pion (211) mass hypothesis,
  //     which is the only particle hypothesis currently available???
  double maxp[2] = {0., 0.};
  int maxiTrk[2] = { -1, -1};
  int nTrkAll = tracks.getEntries();
 
  int nTrkLoose = 0; 
  int nTrkTight = 0; 
  /* Loop over all the tracks to define the tight and loose selection tracks.
     We will select events with only 2 tight tracks and no additional loose tracks.
     Tight tracks are a subset of looses tracks. */
  for (int iTrk = 0; iTrk < nTrkAll; iTrk++) {
    // Get track biasing towards the particle being a pion based on what particle types
    // are used for reconstruction at this stage.
    const TrackFitResult* tempTrackFit = tracks[iTrk]->getTrackFitResultWithClosestMass(Const::pion);
    if (not tempTrackFit) {continue;}
 
    // Collect track info to be used for categorizing
    short charge = tempTrackFit->getChargeSign();
    double z0 = tempTrackFit->getZ0();
    double d0 = tempTrackFit->getD0();
    int nCDChits = tempTrackFit->getHitPatternCDC().getNHits();
    double p = tempTrackFit->getMomentum().R();
 
    // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
    //== Save debug TTree with detailed information if necessary.
    m_tree_d0 = d0;
    m_tree_z0 = z0;
    m_tree_p  = p;
    m_charge = charge;
    m_tree_nCDChits = nCDChits;
 
    if (m_saveTree) {
      m_dbgTree_tracks->Fill();
    }
    //<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 
 
    /* Test if loose track  */
 
    // d0 and z0 cuts
    if (fabs(d0) > m_looseTrkD0) {
      continue;
    }
    if (fabs(z0) > m_looseTrkZ0) {
      continue;
    }
    // Number of hits in the CDC
    if (nCDChits < 1) {
      continue;
    }
    nTrkLoose++;
 
 
 
    /* Test if the loose track is also a tight track */
 
    // Number of hits in the CDC
    if (nCDChits < 20) {
      continue;
    }
 
 
    // d0 and z0 cuts
    if (fabs(d0) > m_tightTrkD0) {
      continue;
    }
    if (fabs(z0) > m_tightTrkZ0) {
      continue;
    }
    nTrkTight++;
 
    // Sorting of tight tracks.  Not really required as we only want two tight tracks (at the moment) but okay.
    //..Find the maximum p negative [0] and positive [1] tracks
    int icharge = 0;
    if (charge > 0) {icharge = 1;}
    if (p > maxp[icharge]) {
      maxp[icharge] = p;
      maxiTrk[icharge] = iTrk;
    }
 
  }
  /* After that last section the numbers of loose and tight tracks are known as well as the
     index of the loose tracks that have the highest p negatively charged and highest p positively
     charged tracks as measured in the centre of mass frame */
 
 
  if (nTrkTight != 2) {
    return;
  }
  // There are exactly two tight tracks
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: Two tight tracks: index = " << cutIndexPassed);
 
 
  if (nTrkLoose != 2) {
    return;
  }
  // There are exactly two loose tracks as well, i.e. no additional loose tracks
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: No additional loose tracks: index = " << cutIndexPassed);
 
  /* Determine if the two tracks have the opposite electric charge.
     We know this because the track indices stores the max pt track in [0] for negatively charged track
     and [1] for the positively charged track.  If both are filled then both a negatively charged
     and positively charged track were found.   */
  bool oppositelyChargedTracksPassed = maxiTrk[0] != -1  &&  maxiTrk[1] != -1;
  if (!oppositelyChargedTracksPassed) {
    return;
  }
  // The two tracks have the opposite electric charges.
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: Oppositely charged tracks: index = " << cutIndexPassed);
 
 
 
 
  //---------------------------------------------------------------------
  /* Determine associated energy clusters to each of the two tracks.  Sum the energies of the
     multiple clusters to each track and find the crystal with the maximum energy within all
     the sets of clusters associated to the tracks*/
  double trkEClustLab[2] = {0., 0.};
  double trkEClustCOM[2] = {0., 0.};
  double trkpLab[2];
  double trkpCOM[2];
  ROOT::Math::PxPyPzEVector trkp4Lab[2];
  ROOT::Math::PxPyPzEVector trkp4COM[2];
 
  // Index of the cluster and the crystal that has the highest energy crystal for the two tracks
  int crysIDMax[2] = { -1, -1 };
  double crysEMax[2] = { -1, -1 };
  double crysE2Max[2] = { -1, -1 };
  int numClustersPerTrack[2] = { 0, 0 };
 
  double clusterTime[2] = {0, 0};
 
  double E_DIV_p[2];
 
  vector<double> time_ECLCaldigits_bothClusters;
  vector<int> cid_ECLCaldigits_bothClusters;
  vector<double> E_ECLCaldigits_bothClusters;
  vector<double> amp_ECLDigits_bothClusters;
  vector<int> chargeID_ECLCaldigits_bothClusters;
 
  for (int icharge = 0; icharge < 2; icharge++) {
    if (maxiTrk[icharge] > -1) {
      B2DEBUG(22, "looping over the 2 max pt tracks");
 
      const TrackFitResult* tempTrackFit = tracks[maxiTrk[icharge]]->getTrackFitResultWithClosestMass(Const::pion);
      if (not tempTrackFit) {continue;}
      trkp4Lab[icharge] = tempTrackFit->get4Momentum();
      trkp4COM[icharge] = boostrotate.rotateLabToCms() * trkp4Lab[icharge];
      trkpLab[icharge] = trkp4Lab[icharge].P();
      trkpCOM[icharge] = trkp4COM[icharge].P();
 
 
      /* For each cluster associated to the current track, sum up the energies to get the total
         energy of all clusters associated to the track and find which crystal has the highest
         energy from all those clusters*/
      auto eclClusterRelationsFromTracks = tracks[maxiTrk[icharge]]->getRelationsTo<ECLCluster>();
      for (unsigned int clusterIdx = 0; clusterIdx < eclClusterRelationsFromTracks.size(); clusterIdx++) {
 
        B2DEBUG(22, "Looking at clusters.  index = " << clusterIdx);
        auto cluster = eclClusterRelationsFromTracks[clusterIdx];
        bool goodClusterType = false;
 
        if (cluster->hasHypothesis(Belle2::ECLCluster::EHypothesisBit::c_nPhotons)) {
          trkEClustLab[icharge] += cluster->getEnergy(Belle2::ECLCluster::EHypothesisBit::c_nPhotons);
          goodClusterType = true;
          numClustersPerTrack[icharge]++;
        }
 
        if (goodClusterType) {
 
          clusterTime[icharge] = cluster->getTime();
 
          auto eclClusterRelations = cluster->getRelationsTo<ECLCalDigit>("ECLCalDigits");
 
          // Find the crystal that has the largest energy
          for (unsigned int ir = 0; ir < eclClusterRelations.size(); ir++) {
            const auto calDigit = eclClusterRelations.object(ir);
            int tempCrysID = calDigit->getCellId() - 1;
            double tempE = m_EperCrys[tempCrysID];
 
            int eclDigitIndex = m_eclDigitID[tempCrysID];
            ECLDigit*    ecl_dig = m_eclDigitArray[eclDigitIndex];
 
            // for the max E crystal
            if (tempE > crysEMax[icharge]) {
              // Set 2nd highest E crystal to the info from the highest E crystal
              crysE2Max[icharge] = crysEMax[icharge];
              // Set the highest E crystal to the current crystal
              crysEMax[icharge] = tempE;
              crysIDMax[icharge] = tempCrysID;
            }
            // for the 2nd highest E crystal
            if (tempE > crysE2Max[icharge] && tempCrysID != crysIDMax[icharge]) {
              crysE2Max[icharge] = tempE;
            }
 
            // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
            // If we drop the information about the second highest energy crystal we could use
            //    m_eclClusterArray[ic]->getMaxECellId()
 
            B2DEBUG(26,  "calDigit(ir" << ir << ") time = " << calDigit->getTime() << "ns , with E = " << tempE << " GeV");
            time_ECLCaldigits_bothClusters.push_back(calDigit->getTime());
            cid_ECLCaldigits_bothClusters.push_back(tempCrysID);
            E_ECLCaldigits_bothClusters.push_back(tempE);
            amp_ECLDigits_bothClusters.push_back(ecl_dig->getAmp());
            chargeID_ECLCaldigits_bothClusters.push_back(icharge);
 
          }
        }
      }
      trkEClustCOM[icharge] = trkEClustLab[icharge] * trkpCOM[icharge] / trkpLab[icharge];
 
      // Check both electrons to see if their cluster energy / track momentum is good.
      // The Belle II physics book shows that this is the main way of separating electrons from other particles
      // Done in the centre of mass reference frame although I believe E/p is invariant under a boost.
      E_DIV_p[icharge] = trkEClustCOM[icharge] / trkpCOM[icharge];
 
    }
  }
  /* At the end of this section the 3-momenta magnitudes and the cluster energies are known
     for the two saved track indices for both the lab and COM frames.
     The crystal with the maximum energy, one associated to each track, is recorded*/
 
 
 
  //=== Check each crystal in the processed event and fill histogram.
 
  int numCrystalsPassingCuts = 0;
 
  int crystalIDs[2] = { -1, -1};
  int crateIDs[2] = { -1, -1};
  double ts_prevCalib[2] = { -1, -1};
  double tcrate_prevCalib[2] = { -1, -1};
  double times_noPreviousCalibrations[2] = { -1, -1};
  bool crystalCutsPassed[2] = {false, false};
  double crystalEnergies[2] = { -1, -1};
  double crystalEnergies2[2] = { -1, -1};
 
  for (int iCharge = 0; iCharge < 2; iCharge++) {
    int crystal_idx = crysIDMax[iCharge];
    int eclCalDigitIndex = m_eclCalDigitID[crystal_idx];
    int eclDigitIndex = m_eclDigitID[crystal_idx];
 
    ECLDigit*    ecl_dig = m_eclDigitArray[eclDigitIndex];
    ECLCalDigit* ecl_cal = m_eclCalDigitArray[eclCalDigitIndex];
 
    //== Check whether specific ECLDigits should be excluded.
 
    auto en = ecl_cal->getEnergy();
    auto amplitude = ecl_dig->getAmp();
    crystalEnergies[iCharge] = en;
 
    int cid   = ecl_dig->getCellId();
    double time  = ecl_dig->getTimeFit() * TICKS_TO_NS - evt_t0;
 
    // Offset time by electronics calibration and flight time calibration.
    time -= m_ElectronicsTime[cid - 1] * TICKS_TO_NS;
    time -= m_FlightTime[cid - 1];
 
 
    // Apply the time walk correction: time shift as a function of the amplitude corrected by the electronics calibration.
    //    The electronics calibration also accounts for crystals that have a dead pre-amp and thus half the normal amplitude.
    double energyTimeShift = m_ECLTimeUtil->energyDependentTimeOffsetElectronic(amplitude * m_Electronics[cid - 1]) * TICKS_TO_NS;
 
    B2DEBUG(29, "cellid = " << cid << ", amplitude = " << amplitude << ", time before t(E) shift = " << time <<
            ", t(E) shift = " << energyTimeShift << " ns");
    time -= energyTimeShift;
 
 
    // Cell ID should be within specified range.
    if (cid < m_minCrystal || cid > m_maxCrystal) continue;
 
    // Absolute time should be in specified range condition.
    if (fabs(time) > m_timeAbsMax) continue;
 
    // Fit quality flag -- choose only events with best fit quality
    if (ecl_dig->getQuality() != 0) continue;
 
    //== Save time and crystal information.  Fill plot after both electrons are tested
    crystalIDs[iCharge] = cid;
    crateIDs[iCharge] = m_crystalMapper->getCrateID(ecl_cal->getCellId());
 
 
    ts_prevCalib[iCharge] = m_PreviousCrystalTime[cid - 1] * TICKS_TO_NS;
    tcrate_prevCalib[iCharge] = m_CrateTime[cid - 1] * TICKS_TO_NS;
    times_noPreviousCalibrations[iCharge] = time;
 
 
    B2DEBUG(26, "iCharge = " << iCharge);
    B2DEBUG(26, "crateIDs[iCharge] = " << crateIDs[iCharge]);
    B2DEBUG(26, "times_noPreviousCalibrations[iCharge] = " << times_noPreviousCalibrations[iCharge]);
    B2DEBUG(26, "tcrate_prevCalib[iCharge] = " << tcrate_prevCalib[iCharge]);
    B2DEBUG(26, "ts_prevCalib[iCharge] = " << ts_prevCalib[iCharge]);
 
 
    crystalCutsPassed[iCharge] = true;
 
 
    // For second most energetic energy crystal
    crystalEnergies2[iCharge] = crysE2Max[iCharge];
 
 
//  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Tree saving
    //== Save debug TTree with detailed information if necessary.
    m_tree_cid      = ecl_dig->getCellId();
    m_tree_amp      = ecl_dig->getAmp();
    m_tree_en       = en;
    m_tree_E1Etot   = en / trkEClustLab[iCharge];
    m_tree_E1E2     = en / crystalEnergies2[iCharge];
    m_tree_E1p      = en / trkpLab[iCharge];
    m_tree_timetsPreviousTimeCalibs = time - ts_prevCalib[iCharge] - tcrate_prevCalib[iCharge];
    m_tree_timeF    = ecl_dig->getTimeFit() * TICKS_TO_NS;
    m_tree_time     = time;
    m_tree_quality  = ecl_dig->getQuality();
    m_tree_t0       = evt_t0;
    m_tree_t0_unc   = evt_t0_unc;
    m_E_DIV_p       = E_DIV_p[iCharge];
    m_tree_evtNum  = m_EventMetaData->getEvent();
    m_crystalCrate  = m_crystalMapper->getCrateID(ecl_cal->getCellId());
    m_runNum        = m_EventMetaData->getRun();
 
    if (m_saveTree) {
      m_dbgTree_electrons->Fill();
    }
//  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< Tree saving
 
    // Fill histogram with information about maximum energy crystal energy fraction
    getObjectPtr<TH1F>("maxEcrsytalEnergyFraction")->Fill(en / trkEClustLab[iCharge]);
 
 
  }
 
 
 
  // Check both electrons to see if their cluster energy / track momentum is good.
  // The Belle II physics book shows that this is the main way of separating electrons from other particles
  // Done in the centre of mass reference frame although I believe E/p is invariant under a boost.
  bool E_DIV_p_instance_passed[2] = {false, false};
  double E_DIV_p_CUT = 0.7;
  for (int icharge = 0; icharge < 2; icharge++) {
    E_DIV_p_instance_passed[icharge] = E_DIV_p[icharge] > E_DIV_p_CUT;
  }
  if (!E_DIV_p_instance_passed[0] || !E_DIV_p_instance_passed[1]) {
    return;
  }
  // E/p sufficiently large
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: E_i/p_i > " << E_DIV_p_CUT  << ": index = " << cutIndexPassed);
 
 
 
  // Start of cuts on both the combined system of tracks and energy clusters
 
  double invMassTrk = (trkp4Lab[0] + trkp4Lab[1]).M();
  double invMass_CUT = 0.9;
  m_massInvTracks = invMassTrk;   // invariant mass of the two tracks
 
//  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Tree saving
  if (m_saveTree) {
    m_dbgTree_event->Fill();
  }
//  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< Tree saving
 
  bool invMassCutsPassed = invMassTrk > (invMass_CUT * boostrotate.getCMSEnergy());
  if (!invMassCutsPassed) {
    return;
  }
  // Invariable mass of the two tracks are above the minimum
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: m(track 1+2) > " << invMass_CUT << "*E_COM = " << invMass_CUT << " * " << boostrotate.getCMSEnergy() <<
          " : index = " << cutIndexPassed);
 
 
 
  //== Fill output histogram.
  for (int iCharge = 0; iCharge < 2; iCharge++) {
    if (crystalCutsPassed[iCharge]) {
      getObjectPtr<TH2F>("TimevsCrysPrevCrateCalibPrevCrystCalib")->Fill((crystalIDs[iCharge]) + 0.001,
          times_noPreviousCalibrations[iCharge] - ts_prevCalib[iCharge] - tcrate_prevCalib[iCharge], 1);
      getObjectPtr<TH2F>("TimevsCratePrevCrateCalibPrevCrystCalib")->Fill((crateIDs[iCharge]) + 0.001,
          times_noPreviousCalibrations[iCharge]  - ts_prevCalib[iCharge] - tcrate_prevCalib[iCharge], 1);
      getObjectPtr<TH2F>("TimevsCrysNoCalibrations")->Fill((crystalIDs[iCharge]) + 0.001, times_noPreviousCalibrations[iCharge], 1);
      getObjectPtr<TH2F>("TimevsCrateNoCalibrations")->Fill((crateIDs[iCharge]) + 0.001, times_noPreviousCalibrations[iCharge], 1);
      getObjectPtr<TH2F>("TimevsCrysPrevCrateCalibNoCrystCalib")->Fill((crystalIDs[iCharge]) + 0.001,
          times_noPreviousCalibrations[iCharge] - tcrate_prevCalib[iCharge], 1);
      getObjectPtr<TH2F>("TimevsCrateNoCrateCalibPrevCrystCalib")->Fill((crateIDs[iCharge]) + 0.001,
          times_noPreviousCalibrations[iCharge]  - ts_prevCalib[iCharge], 1);
 
      // Record number of crystals used from the event.  Should be exactly two.
      numCrystalsPassingCuts++;
 
    }
  }
 
 
  // Change cutflow method for this bit ... don't call return because we used to call the hadron cluster stuff afterwards
  //
  if (crystalCutsPassed[0] || crystalCutsPassed[1]) {
    // At least one ECL crystal time and quality cuts passed
    cutIndexPassed++;
    getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
    B2DEBUG(22, "Cutflow: At least one crystal time and quality cuts passed: index = " << cutIndexPassed);
 
    getObjectPtr<TH1F>("numCrystalEntriesPerEvent")->Fill(numCrystalsPassingCuts);
  }
 
 
  // Save final information to the tree after all cuts are applied
  for (int iCharge = 0; iCharge < 2; iCharge++) {
    if (crystalCutsPassed[iCharge]) {
      //  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Tree saving
      m_tree_evtNum  = m_EventMetaData->getEvent();
      m_tree_cid      = crystalIDs[iCharge];
      //m_tree_time     = times[iCharge];
      m_tree_time     = times_noPreviousCalibrations[iCharge];
      m_crystalCrate  = crateIDs[iCharge];
      m_runNum        = m_EventMetaData->getRun();
      m_tree_en       = crystalEnergies[iCharge];  // for studies of ts as a function of energy
      m_tree_E1Etot   = crystalEnergies[iCharge] / trkEClustLab[iCharge];
      m_tree_E1E2     = crystalEnergies[iCharge] / crystalEnergies2[iCharge];
      m_tree_E1p      = crystalEnergies[iCharge] / trkpLab[iCharge];
      m_tree_timetsPreviousTimeCalibs = times_noPreviousCalibrations[iCharge] - ts_prevCalib[iCharge] - tcrate_prevCalib[iCharge];
      m_tree_t0       = evt_t0;
      m_tree_t0_ECLclosestCDC   = evt_t0_ECL_closestCDC;
      m_tree_t0_ECL_minChi2   = evt_t0_ECL_minChi2;
      m_tree_tClust = clusterTime[iCharge];
 
      m_massInvTracks = invMassTrk;   // This is probably already set but I'll set it again anyways just so that it is clear
 
      if (m_saveTree) {
        m_dbgTree_allCuts->Fill();
      }
      //  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< Tree saving
    }
  }
 
 
 
 
  if (crystalCutsPassed[0]       &&  crystalCutsPassed[1]        &&
      numClustersPerTrack[0] == 1  &&  numClustersPerTrack[1] == 1) {
    m_tree_enNeg = trkEClustLab[0];
    m_tree_enPlus = trkEClustLab[1];
    m_tree_tClustNeg = clusterTime[0];
    m_tree_tClustPos = clusterTime[1];
    m_tree_maxEcrystPosClust = times_noPreviousCalibrations[0] - ts_prevCalib[0] - tcrate_prevCalib[0];
    m_tree_maxEcrystNegClust = times_noPreviousCalibrations[1] - ts_prevCalib[1] - tcrate_prevCalib[1];
    m_tree_t0       = evt_t0;
    m_tree_t0_ECLclosestCDC   = evt_t0_ECL_closestCDC;
    m_tree_t0_ECL_minChi2   = evt_t0_ECL_minChi2;
 
    //  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Tree saving
    if (m_saveTree) {
      m_dbgTree_evt_allCuts->Fill();
    }
    //  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< Tree saving
  }
 
 
  B2DEBUG(26, "m_tree_maxEcrystPosClust + evt_t0 = " << m_tree_maxEcrystPosClust + evt_t0);
  B2DEBUG(26, "m_tree_maxEcrystNegClust + evt_t0 = " << m_tree_maxEcrystNegClust + evt_t0);
  B2DEBUG(26, "CDC evt_t0 = " << evt_t0);
  B2DEBUG(26, "ECL min chi2 even t0, m_tree_t0_ECL_minChi2 = " << m_tree_t0_ECL_minChi2);
 
 
 
  for (long unsigned int digit_i = 0; digit_i < time_ECLCaldigits_bothClusters.size(); digit_i++) {
    m_runNum        = m_EventMetaData->getRun();
    m_tree_evtNum  = m_EventMetaData->getEvent();
    m_tree_ECLCalDigitTime  = time_ECLCaldigits_bothClusters[digit_i];
    m_tree_ECLCalDigitE = E_ECLCaldigits_bothClusters[digit_i];
    m_tree_ECLDigitAmplitude = amp_ECLDigits_bothClusters[digit_i];
    m_tree_t0       = evt_t0;
    m_tree_t0_ECLclosestCDC   = evt_t0_ECL_closestCDC;
    m_tree_t0_ECL_minChi2   = evt_t0_ECL_minChi2;
    m_tree_timetsPreviousTimeCalibs = times_noPreviousCalibrations[chargeID_ECLCaldigits_bothClusters[digit_i]] -
                                      ts_prevCalib[chargeID_ECLCaldigits_bothClusters[digit_i]] -
                                      tcrate_prevCalib[chargeID_ECLCaldigits_bothClusters[digit_i]];
    m_tree_cid = cid_ECLCaldigits_bothClusters[digit_i];
 
    //  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Tree saving
    if (m_saveTree) {
      m_dbgTree_crys_allCuts->Fill();
    }
    //  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< Tree saving
 
  }
 
 
  B2DEBUG(26, "This was for event number = " << m_tree_evtNum);
 
}

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

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

virtual void finish ( )

inlineprotectedvirtualinherited

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

Reimplemented in MillepedeCollectorModule, CaTestModule, CDCCalibrationCollectorModule, CDCFudgeFactorCalibrationCollectorModule, CDCT0CalibrationCollectorModule, CDCCrudeT0CollectorModule, EKLMAlignmentAlongStripsCollectorModule, KLMStripEfficiencyCollectorModule, KLMTimeCollectorModule, SVDCrossTalkCalibrationsCollectorModule, and SVDOccupancyCalibrationsCollectorModule.

Definition at line 79 of file CalibrationCollectorModule.h.

{}

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.

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

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.

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

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.

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

{ 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://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()

void inDefineHisto ( )

overridevirtual

Replacement for defineHisto() in CalibrationCollector modules.

Reimplemented from CalibrationCollectorModule.

Definition at line 87 of file ECLBhabhaTCollectorModule.cc.

{
  //=== Prepare TTree for debug output
  if (m_saveTree) {    //  /* >>>>>>>>>>>>>>>>>>>>>>>>>>>> if boolean true for saving debug trees  >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
    // Per electron
    m_dbgTree_electrons = new TTree("tree_electrons", "Debug data for bhabha time calibration - one entry per electron");
    m_dbgTree_electrons->Branch("EventNum", &m_tree_evtNum)->SetTitle("Event number");
    m_dbgTree_electrons->Branch("CrystalCellID", &m_tree_cid)->SetTitle("Cell ID, 1..8736");
    m_dbgTree_electrons->Branch("ADCamplitude", &m_tree_amp)->SetTitle("Amplitude, ADC units");
    m_dbgTree_electrons->Branch("maxEcrystalEnergy", &m_tree_en)->SetTitle("Max Energy Crystal Energy, GeV");
    m_dbgTree_electrons->Branch("maxEcrystalEnergyDIVclusterE",
                                &m_tree_E1Etot)->SetTitle("Max Energy Crystal Fraction Energy of Cluster");
    m_dbgTree_electrons->Branch("E1divE2crystal",
                                &m_tree_E1E2)->SetTitle("Max Energy Crystal DIV second max energy crystal in cluster");
    m_dbgTree_electrons->Branch("E1crystal_DIV_p", &m_tree_E1p)->SetTitle("Max Energy Crystal in cluster DIV track p");
    m_dbgTree_electrons->Branch("timetsPreviousTimeCalibs",
                                &m_tree_timetsPreviousTimeCalibs)->SetTitle("Time t_psi after application of previous Ts, ns");
    m_dbgTree_electrons->Branch("E_DIV_p", &m_E_DIV_p)->SetTitle("E DIV p");
    m_dbgTree_electrons->Branch("timeF", &m_tree_timeF)->SetTitle("Time F, ns");
    m_dbgTree_electrons->Branch("time_t_psi", &m_tree_time)->SetTitle("Time t_psi for Ts, ns");
    m_dbgTree_electrons->Branch("quality", &m_tree_quality)->SetTitle("ECL FPGA fit quality, see XWiki article");
    m_dbgTree_electrons->Branch("t0", &m_tree_t0)->SetTitle("T0, ns");
    m_dbgTree_electrons->Branch("t0_unc", &m_tree_t0_unc)->SetTitle("T0 uncertainty, ns");
    m_dbgTree_electrons->Branch("CrateID", &m_crystalCrate)->SetTitle("Crate id for crystal");
    m_dbgTree_electrons->Branch("runNum", &m_runNum)->SetTitle("Run number");
 
    m_dbgTree_electrons->SetAutoSave(10);
 
 
    // Per track
    m_dbgTree_tracks = new TTree("tree_tracks", "Debug data for bhabha time calibration - one entry per track");
    m_dbgTree_tracks->Branch("d0", &m_tree_d0)->SetTitle("d0, cm");
    m_dbgTree_tracks->Branch("z0", &m_tree_z0)->SetTitle("z0, cm");
    m_dbgTree_tracks->Branch("p", &m_tree_p)->SetTitle("track momentum, GeV");
    m_dbgTree_tracks->Branch("charge", &m_charge)->SetTitle("track electric charge");
    m_dbgTree_tracks->Branch("Num_CDC_hits", &m_tree_nCDChits)->SetTitle("Num CDC hits");
 
    m_dbgTree_tracks->SetAutoSave(10);
 
    // Per crystal
    m_dbgTree_crystals = new TTree("tree_crystals",
                                   "Debug data for bhabha time calibration - one entry per electron - one entry per crystal");
    m_dbgTree_crystals->Branch("clustCrysE_DIV_maxEcrys",
                               &m_tree_clustCrysE_DIV_maxEcrys)->SetTitle("E of crystal i from cluster / E of max E crystal");
    m_dbgTree_crystals->Branch("Crystal_E", &m_tree_clustCrysE) ->SetTitle("E of crystal i from cluster");
    m_dbgTree_crystals->Branch("time_t_psi", &m_tree_time)->SetTitle("Time for Ts, ns");
    m_dbgTree_crystals->Branch("Crystal_cell_ID", &m_tree_cid)->SetTitle("Cell ID, 1..8736");
    m_dbgTree_crystals->Branch("quality", &m_tree_quality)->SetTitle("ECL FPGA fit quality, see XWiki article");
 
    m_dbgTree_crystals->SetAutoSave(10);
 
 
    // Per event
    m_dbgTree_event = new TTree("tree_event", "Debug data for bhabha time calibration - one entry per event");
    m_dbgTree_event->Branch("massInvTracks", &m_massInvTracks)->SetTitle("Invariant mass of the two tracks");
 
    m_dbgTree_event->SetAutoSave(10);
 
 
    m_dbgTree_evt_allCuts = new TTree("tree_evt_allCuts",
                                      "Debug data for bhabha time calibration - one entry per event after all the cuts");
    m_dbgTree_evt_allCuts->Branch("EclustPlus", &m_tree_enPlus)->SetTitle("Energy of cluster with +ve charge, GeV");
    m_dbgTree_evt_allCuts->Branch("EclustNeg", &m_tree_enNeg)->SetTitle("Energy of cluster with -ve charge, GeV");
    m_dbgTree_evt_allCuts->Branch("clustTimePos", &m_tree_tClustPos)->SetTitle("Cluster time of cluster with +ve charge, GeV");
    m_dbgTree_evt_allCuts->Branch("clustTimeNeg", &m_tree_tClustNeg)->SetTitle("Cluster time of cluster with -ve charge, GeV");
    m_dbgTree_evt_allCuts->Branch("maxEcrysTimePosClust",
                                  &m_tree_maxEcrystPosClust)->SetTitle("Time of maximum energy crystal in cluster with +ve charge, GeV");
    m_dbgTree_evt_allCuts->Branch("maxEcrysTimeNegClust",
                                  &m_tree_maxEcrystNegClust)->SetTitle("Time of maximum energy crystal in cluster with -ve charge, GeV");
    m_dbgTree_evt_allCuts->Branch("t0", &m_tree_t0)->SetTitle("T0, ns");
    m_dbgTree_evt_allCuts->Branch("t0_ECL_closestCDC", &m_tree_t0_ECLclosestCDC)->SetTitle("T0 ECL closest to CDC t0, ns");
    m_dbgTree_evt_allCuts->Branch("t0_ECL_minChi2", &m_tree_t0_ECL_minChi2)->SetTitle("T0 ECL with smallest chi squared, ns");
 
    m_dbgTree_evt_allCuts->SetAutoSave(10);
 
 
    // Per crystal within each cluster, entry after all the cuts
    m_dbgTree_crys_allCuts = new TTree("m_dbgTree_crys_allCuts",
                                       "Debug data for bhabha time calibration - one entry per crystal per cluster entry after all cuts");
 
    m_dbgTree_crys_allCuts->Branch("runNum", &m_runNum)->SetTitle("Run number");
    m_dbgTree_crys_allCuts->Branch("EventNum", &m_tree_evtNum)->SetTitle("Event number");
    m_dbgTree_crys_allCuts->Branch("m_tree_ECLCalDigitTime",
                                   &m_tree_ECLCalDigitTime)
    ->SetTitle("Time of a crystal within the cluster after application of previous calibrations except t0, ns");
    m_dbgTree_crys_allCuts->Branch("m_tree_ECLCalDigitE", &m_tree_ECLCalDigitE)->SetTitle("Energy of crystal, GeV");
    m_dbgTree_crys_allCuts->Branch("m_tree_ECLDigitAmplitude",
                                   &m_tree_ECLDigitAmplitude)->SetTitle("Amplitude of crystal signal pulse");
    m_dbgTree_crys_allCuts->Branch("timetsPreviousTimeCalibs",
                                   &m_tree_timetsPreviousTimeCalibs)->SetTitle("Time t_psi after application of previous Ts, ns");
    m_dbgTree_crys_allCuts->Branch("t0", &m_tree_t0)->SetTitle("T0, ns");
    m_dbgTree_crys_allCuts->Branch("t0_ECL_closestCDC", &m_tree_t0_ECLclosestCDC)->SetTitle("T0 ECL closest to CDC t0, ns");
    m_dbgTree_crys_allCuts->Branch("t0_ECL_minChi2", &m_tree_t0_ECL_minChi2)->SetTitle("T0 ECL with smallest chi squared, ns");
    m_dbgTree_crys_allCuts->Branch("CrystalCellID", &m_tree_cid)->SetTitle("Cell ID, 1..8736");
 
    m_dbgTree_crys_allCuts->SetAutoSave(10);
 
 
  }   // <<<<<<<<<<<<<<<<<<<<<  if boolean true for saving debug trees <<<<<<<<<<<<<<<<<<<<<<<<<< */
 
 
  // Per max E crystal entry after all the cuts
  //    this tree is always saved
  m_dbgTree_allCuts = new TTree("tree_allCuts",
                                "Debug data for bhabha time calibration - one entry per max E crystal entry after cuts");
 
  m_dbgTree_allCuts->Branch("time_t_psi", &m_tree_time)->SetTitle("Time t_psi for Ts, ns");
  m_dbgTree_allCuts->Branch("crateID", &m_crystalCrate)->SetTitle("Crate id for crystal");
  m_dbgTree_allCuts->Branch("EventNum", &m_tree_evtNum)->SetTitle("Event number");
  m_dbgTree_allCuts->Branch("runNum", &m_runNum)->SetTitle("Run number");
  m_dbgTree_allCuts->Branch("CrystalCellID", &m_tree_cid)->SetTitle("Cell ID, 1..8736");
  m_dbgTree_allCuts->Branch("maxEcrystalEnergy", &m_tree_en)->SetTitle("Max Energy Crystal Energy, GeV");
  m_dbgTree_allCuts->Branch("maxEcrystalEnergyDIVclusterE",
                            &m_tree_E1Etot)->SetTitle("Max Energy Crystal Fraction Energy of Cluster");
  m_dbgTree_allCuts->Branch("E1divE2crystal",
                            &m_tree_E1E2)->SetTitle("Max Energy Crystal DIV second max energy crystal in cluster");
  m_dbgTree_allCuts->Branch("E1crystalDIVp", &m_tree_E1p)->SetTitle("Max Energy Crystal in cluster DIV track p");
  m_dbgTree_allCuts->Branch("timetsPreviousTimeCalibs",
                            &m_tree_timetsPreviousTimeCalibs)->SetTitle("Time t_psi after application of previous Ts, ns");
  m_dbgTree_allCuts->Branch("massInvTracks", &m_massInvTracks)->SetTitle("Invariant mass of the two tracks");
  m_dbgTree_allCuts->Branch("t0", &m_tree_t0)->SetTitle("T0, ns");
  m_dbgTree_allCuts->Branch("t0_ECL_closestCDC", &m_tree_t0_ECLclosestCDC)->SetTitle("T0 ECL closest to CDC t0, ns");
  m_dbgTree_allCuts->Branch("t0_ECL_minChi2", &m_tree_t0_ECL_minChi2)->SetTitle("T0 ECL with smallest chi squared, ns");
 
  m_dbgTree_allCuts->Branch("clusterTime", &m_tree_tClust)->SetTitle("Cluster time of cluster with +ve charge, GeV");
 
  m_dbgTree_allCuts->SetAutoSave(10);
 
}

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

prepare()

void prepare ( )

overridevirtual

Define histograms and read payloads from DB.

Reimplemented from CalibrationCollectorModule.

Definition at line 217 of file ECLBhabhaTCollectorModule.cc.

{
  //=== MetaData
  B2INFO("ECLBhabhaTCollector: Experiment = " << m_EventMetaData->getExperiment() <<
         "  run = " << m_EventMetaData->getRun());
 
 
  //=== Create histograms and register them in the data store
  int nbins = m_timeAbsMax * 8;
  int max_t = m_timeAbsMax;
  int min_t = -m_timeAbsMax;
 
 
  auto TimevsCrysPrevCrateCalibPrevCrystCalib = new TH2F("TimevsCrysPrevCrateCalibPrevCrystCalib",
                                                         "Time t psi - ts - tcrate (previous calibs) vs crystal cell ID;crystal cell ID;Time t_psi with previous calib (ns)",
                                                         ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1, nbins, min_t, max_t);
  registerObject<TH2F>("TimevsCrysPrevCrateCalibPrevCrystCalib", TimevsCrysPrevCrateCalibPrevCrystCalib);
 
  auto TimevsCratePrevCrateCalibPrevCrystCalib = new TH2F("TimevsCratePrevCrateCalibPrevCrystCalib",
                                                          "Time t psi - ts - tcrate (previous calibs) vs crate ID;crate ID;Time t_psi previous calib (ns)",
                                                          52, 1, 52 + 1, nbins, min_t, max_t);
  registerObject<TH2F>("TimevsCratePrevCrateCalibPrevCrystCalib", TimevsCratePrevCrateCalibPrevCrystCalib);
 
  auto TimevsCrysNoCalibrations = new TH2F("TimevsCrysNoCalibrations",
                                           "Time tpsi vs crystal cell ID;crystal cell ID;Time t_psi (ns)", ECLElementNumbers::c_NCrystals, 1,
                                           ECLElementNumbers::c_NCrystals + 1, nbins, min_t, max_t);
  registerObject<TH2F>("TimevsCrysNoCalibrations", TimevsCrysNoCalibrations);
 
  auto TimevsCrateNoCalibrations = new TH2F("TimevsCrateNoCalibrations",
                                            "Time tpsi vs crate ID;crate ID;Time t_psi (ns)", 52, 1, 52 + 1, nbins, min_t, max_t);
  registerObject<TH2F>("TimevsCrateNoCalibrations", TimevsCrateNoCalibrations);
 
  auto TimevsCrysPrevCrateCalibNoCrystCalib = new TH2F("TimevsCrysPrevCrateCalibNoCrystCalib",
                                                       "Time tpsi - tcrate (previous calib) vs crystal cell ID;crystal cell ID;Time t_psi including previous crate calib (ns)",
                                                       ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1, nbins, min_t, max_t);
  registerObject<TH2F>("TimevsCrysPrevCrateCalibNoCrystCalib", TimevsCrysPrevCrateCalibNoCrystCalib);
 
  auto TimevsCrateNoCrateCalibPrevCrystCalib = new TH2F("TimevsCrateNoCrateCalibPrevCrystCalib",
                                                        "Time tpsi - ts (previous calib) vs crate ID;crate ID;Time t_psi including previous crystal calib (ns)",
                                                        52, 1, 52 + 1, nbins, min_t, max_t);
  registerObject<TH2F>("TimevsCrateNoCrateCalibPrevCrystCalib", TimevsCrateNoCrateCalibPrevCrystCalib);
 
 
  auto TsDatabase = new TH1F("TsDatabase", ";cell id;Ts from database", ECLElementNumbers::c_NCrystals, 1,
                             ECLElementNumbers::c_NCrystals + 1);
  registerObject<TH1F>("TsDatabase", TsDatabase);
 
  auto TsDatabaseUnc = new TH1F("TsDatabaseUnc", ";cell id;Ts uncertainty from database", ECLElementNumbers::c_NCrystals, 1,
                                ECLElementNumbers::c_NCrystals + 1);
  registerObject<TH1F>("TsDatabaseUnc", TsDatabaseUnc);
 
  auto TcrateDatabase = new TH1F("TcrateDatabase", ";cell id;Tcrate from database", ECLElementNumbers::c_NCrystals, 1,
                                 ECLElementNumbers::c_NCrystals + 1);
  registerObject<TH1F>("TcrateDatabase", TcrateDatabase);
 
  auto TcrateUncDatabase = new TH1F("TcrateUncDatabase", ";cell id;Tcrate uncertainty from database", ECLElementNumbers::c_NCrystals,
                                    1, ECLElementNumbers::c_NCrystals + 1);
  registerObject<TH1F>("TcrateUncDatabase", TcrateUncDatabase);
 
 
  auto tcrateDatabase_ns = new TH1F("tcrateDatabase_ns", ";crate id;tcrate derived from database", 52, 1, 52 + 1);
  registerObject<TH1F>("tcrateDatabase_ns", tcrateDatabase_ns);
 
 
  auto databaseCounter = new TH1I("databaseCounter",
                                  ";A database was read in;Number of times database was saved to histogram", 1, 1, 2);
  registerObject<TH1I>("databaseCounter", databaseCounter);
 
 
  auto numCrystalEntriesPerEvent = new TH1F("numCrystalEntriesPerEvent",
                                            ";Number crystal entries;Number of events", 15, 0, 15);
  registerObject<TH1F>("numCrystalEntriesPerEvent", numCrystalEntriesPerEvent);
 
  auto cutflow = new TH1F("cutflow", ";Cut label number;Number of events passing cut", 20, 0, 20);
  registerObject<TH1F>("cutflow", cutflow);
 
  auto maxEcrsytalEnergyFraction = new TH1F("maxEcrsytalEnergyFraction",
                                            ";Maximum energy crystal energy / (sum) cluster energy;Number", 22, 0, 1.1);
  registerObject<TH1F>("maxEcrsytalEnergyFraction", maxEcrsytalEnergyFraction);
 
  auto refCrysIDzeroingCrate = new TH1F("refCrysIDzeroingCrate", ";cell id;Boolean - is reference crystal",
                                        ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
  registerObject<TH1F>("refCrysIDzeroingCrate", refCrysIDzeroingCrate);
 
  auto CDCEventT0Correction = new TH1F("CDCEventT0Correction", ";;CDC event t0 offset correction  [ns]", 1, 1, 2);
  registerObject<TH1F>("CDCEventT0Correction", CDCEventT0Correction);
 
 
  //=== Required data objects
  m_eventT0.isRequired();
  tracks.isRequired();
  m_eclClusterArray.isRequired();
  m_eclCalDigitArray.isRequired();
  m_eclDigitArray.isRequired();
 
  B2INFO("hadronEventT0_TO_bhabhaEventT0_correction = " <<  m_hadronEventT0_TO_bhabhaEventT0_correction <<
         " ns correction to CDC event t0 will be applied");
 
  B2INFO("skipTrgSel = " << skipTrgSel);
 
}

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.

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

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.

{}

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_channelMapDB

DBObjPtr<Belle2::ECLChannelMap> m_channelMapDB

private

Mapper of ecl channels to various other objects, like crates.

database object

Definition at line 123 of file ECLBhabhaTCollectorModule.h.

m_charge

int m_charge = intNaN

private

particle charge, for debug TTree output

Definition at line 194 of file ECLBhabhaTCollectorModule.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_CrateTime

std::vector<float> m_CrateTime

private

vector obtained from DB object

Definition at line 115 of file ECLBhabhaTCollectorModule.h.

m_CrateTimeDB

DBObjPtr<ECLCrystalCalib> m_CrateTimeDB

private

Time offset from crate time calibration (also this calibration) from database.

database object

Definition at line 114 of file ECLBhabhaTCollectorModule.h.

m_CrateTimeUnc

std::vector<float> m_CrateTimeUnc

private

uncertainty vector obtained from DB object

Definition at line 116 of file ECLBhabhaTCollectorModule.h.

m_crystalCrate

int m_crystalCrate = intNaN

private

Crate id for the crystal.

Definition at line 225 of file ECLBhabhaTCollectorModule.h.

m_crystalMapper

std::unique_ptr< Belle2::ECL::ECLChannelMapper> m_crystalMapper

private

Initial value:

=
      std::make_unique<Belle2::ECL::ECLChannelMapper>()

ECL object for keeping track of mapping between crystals and crates etc.

Definition at line 80 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_allCuts

TTree* m_dbgTree_allCuts = nullptr

private

Debug TTree output after all cuts.

Definition at line 133 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_crys_allCuts

TTree* m_dbgTree_crys_allCuts = nullptr

private

Debug TTree output per crystal after all cuts.

Definition at line 135 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_crystals

TTree* m_dbgTree_crystals = nullptr

private

Debug TTree output per crystal.

Definition at line 131 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_electrons

TTree* m_dbgTree_electrons = nullptr

private

Output tree with detailed event data.

Debug TTree output per electron

Definition at line 129 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_event

TTree* m_dbgTree_event = nullptr

private

Debug TTree output per event.

Definition at line 132 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_evt_allCuts

TTree* m_dbgTree_evt_allCuts = nullptr

private

Debug TTree output per event after all cuts.

Definition at line 134 of file ECLBhabhaTCollectorModule.h.

m_dbgTree_tracks

TTree* m_dbgTree_tracks = nullptr

private

Debug TTree output per track.

Definition at line 130 of file ECLBhabhaTCollectorModule.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_E_DIV_p

double m_E_DIV_p = realNaN

private

Energy divided by momentum, for debug TTree output.

Definition at line 195 of file ECLBhabhaTCollectorModule.h.

m_eclCalDigitArray

StoreArray<ECLCalDigit> m_eclCalDigitArray

private

Required input array of ECLCalDigits.

Definition at line 203 of file ECLBhabhaTCollectorModule.h.

m_eclCalDigitID

std::vector<int> m_eclCalDigitID

private

ECL cal digit id sorter.

Definition at line 207 of file ECLBhabhaTCollectorModule.h.

m_eclClusterArray

StoreArray<ECLCluster> m_eclClusterArray

private

Required input array of ECLClusters.

Definition at line 204 of file ECLBhabhaTCollectorModule.h.

m_eclDigitArray

StoreArray<ECLDigit> m_eclDigitArray

private

Required input array of ECLDigits.

Definition at line 202 of file ECLBhabhaTCollectorModule.h.

m_eclDigitID

std::vector<int> m_eclDigitID

private

ECL digit id sorter.

Definition at line 208 of file ECLBhabhaTCollectorModule.h.

m_ECLTimeUtil

std::unique_ptr< Belle2::ECL::ECLTimingUtilities > m_ECLTimeUtil

private

Initial value:

=
      std::make_unique<Belle2::ECL::ECLTimingUtilities>()

ECL timing tools.

Definition at line 234 of file ECLBhabhaTCollectorModule.h.

m_Electronics

std::vector<float> m_Electronics

private

vector obtained from DB object

Definition at line 98 of file ECLBhabhaTCollectorModule.h.

m_ElectronicsDB

DBObjPtr<ECLCrystalCalib> m_ElectronicsDB

private

electronics amplitude calibration from database Scale amplitudefor each crystal and for dead pre-amps

database object

Definition at line 97 of file ECLBhabhaTCollectorModule.h.

m_ElectronicsTime

std::vector<float> m_ElectronicsTime

private

vector obtained from DB object

Definition at line 102 of file ECLBhabhaTCollectorModule.h.

m_ElectronicsTimeDB

DBObjPtr<ECLCrystalCalib> m_ElectronicsTimeDB

private

Time offset from electronics calibration from database.

database object

Definition at line 101 of file ECLBhabhaTCollectorModule.h.

m_emd

StoreObjPtr<EventMetaData> m_emd

protectedinherited

Current EventMetaData.

Definition at line 96 of file CalibrationCollectorModule.h.

m_EperCrys

std::vector<float> m_EperCrys

private

ECL cal digit energy for each crystal.

Definition at line 206 of file ECLBhabhaTCollectorModule.h.

m_EventMetaData

StoreObjPtr<EventMetaData> m_EventMetaData

private

Event metadata.

Definition at line 93 of file ECLBhabhaTCollectorModule.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

StoreObjPtr for T0.

The event t0 class has an overall event t0

Definition at line 90 of file ECLBhabhaTCollectorModule.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_FlightTime

std::vector<float> m_FlightTime

private

vector obtained from DB object

Definition at line 106 of file ECLBhabhaTCollectorModule.h.

m_FlightTimeDB

DBObjPtr<ECLCrystalCalib> m_FlightTimeDB

private

Time offset from flight time b/w IP and crystal from database.

database object

Definition at line 105 of file ECLBhabhaTCollectorModule.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_hadronEventT0_TO_bhabhaEventT0_correction

double m_hadronEventT0_TO_bhabhaEventT0_correction

private

correction to apply to CDC event t0 values in bhabha events to correct for CDC event t0 bias compared to CDC event t0 in hadronic events in ns

Definition at line 239 of file ECLBhabhaTCollectorModule.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_looseTrkD0

double m_looseTrkD0 = realNaN

private

Loose track d0 minimum cut.

Definition at line 222 of file ECLBhabhaTCollectorModule.h.

m_looseTrkZ0

double m_looseTrkZ0 = realNaN

private

Loose track z0 minimum cut.

Definition at line 220 of file ECLBhabhaTCollectorModule.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_massInvTracks

double m_massInvTracks = realNaN

private

invariant mass of the two tracks, for debug TTree output

Definition at line 196 of file ECLBhabhaTCollectorModule.h.

m_maxCrystal

int m_maxCrystal = intNaN

private

Last CellId to handle.

Definition at line 217 of file ECLBhabhaTCollectorModule.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_minCrystal

int m_minCrystal = intNaN

private

First CellId to handle.

Definition at line 216 of file ECLBhabhaTCollectorModule.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_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_PreviousCrystalTime

std::vector<float> m_PreviousCrystalTime

private

vector obtained from DB object

Definition at line 110 of file ECLBhabhaTCollectorModule.h.

m_PreviousCrystalTimeDB

DBObjPtr<ECLCrystalCalib> m_PreviousCrystalTimeDB

private

Time offset from previous crystal time calibration (this calibration) from database.

database object

Definition at line 109 of file ECLBhabhaTCollectorModule.h.

m_PreviousCrystalTimeUnc

std::vector<float> m_PreviousCrystalTimeUnc

private

vector obtained from DB object

Definition at line 111 of file ECLBhabhaTCollectorModule.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_RefCrystalsCalib

std::vector<short> m_RefCrystalsCalib

private

vector obtained from DB object

Definition at line 120 of file ECLBhabhaTCollectorModule.h.

m_RefCrystalsCalibDB

DBObjPtr<ECLReferenceCrystalPerCrateCalib> m_RefCrystalsCalibDB

private

Crystal IDs of the one reference crystal per crate from database.

database object

Definition at line 119 of file ECLBhabhaTCollectorModule.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_runNum

int m_runNum = intNaN

private

run number

Definition at line 226 of file ECLBhabhaTCollectorModule.h.

m_runRange

RunRange* m_runRange

protectedinherited

Overall list of runs processed.

Definition at line 90 of file CalibrationCollectorModule.h.

m_saveTree

bool m_saveTree

private

If true, save TTree with more detailed event info.

Definition at line 71 of file ECLBhabhaTCollectorModule.h.

m_storeCalib

bool m_storeCalib = true

private

Boolean for whether or not to store the previous calibration calibration constants.

Definition at line 228 of file ECLBhabhaTCollectorModule.h.

m_tightTrkD0

double m_tightTrkD0 = realNaN

private

Tight track d0 minimum cut.

Definition at line 223 of file ECLBhabhaTCollectorModule.h.

m_tightTrkZ0

double m_tightTrkZ0 = realNaN

private

Tight track z0 minimum cut.

Definition at line 221 of file ECLBhabhaTCollectorModule.h.

m_timeAbsMax

short m_timeAbsMax

private

Events with abs(time) > m_timeAbsMax are excluded, mostly for histogram x-range purposes.

Definition at line 214 of file ECLBhabhaTCollectorModule.h.

m_tree_amp

int m_tree_amp = intNaN

private

Fitting amplitude from ECL for debug TTree output.

Definition at line 141 of file ECLBhabhaTCollectorModule.h.

m_tree_cid

int m_tree_cid = intNaN

private

ECL Cell ID (1..ECLElementNumbers::c_NCrystals) for debug TTree output.

Definition at line 140 of file ECLBhabhaTCollectorModule.h.

m_tree_clustCrysE

double m_tree_clustCrysE = realNaN

private

crystal energy, only for the crystals that meet all the selection criteria for debug TTree output

Definition at line 169 of file ECLBhabhaTCollectorModule.h.

m_tree_clustCrysE_DIV_maxEcrys

double m_tree_clustCrysE_DIV_maxEcrys = realNaN

private

ratio of crystal energy to energy of the crystal that has the maximum energy, only for the crystals that meet all the selection criteria for debug TTree output

Definition at line 166 of file ECLBhabhaTCollectorModule.h.

m_tree_d0

double m_tree_d0 = realNaN

private

Track d0 for debug TTree output.

Definition at line 162 of file ECLBhabhaTCollectorModule.h.

m_tree_E1E2

double m_tree_E1E2 = realNaN

private

Energy of crystal with maximum energy within ECL cluster divided by second most energetic crystal in the cluster, unitless for debug TTree output.

Definition at line 146 of file ECLBhabhaTCollectorModule.h.

m_tree_E1Etot

double m_tree_E1Etot = realNaN

private

Energy of crystal with maximum energy within ECL cluster divided by total cluster energy, unitless for debug TTree output.

Definition at line 143 of file ECLBhabhaTCollectorModule.h.

m_tree_E1p

double m_tree_E1p = realNaN

private

Energy of crystal with maximum energy within ECL cluster divided by total cluster energy divided by the track momentum, unitless for debug TTree output.

Definition at line 149 of file ECLBhabhaTCollectorModule.h.

m_tree_ECLCalDigitE

double m_tree_ECLCalDigitE = realNaN

private

Energy of an ECLCalDigit within a cluster, GeV for debug TTree output.

Definition at line 189 of file ECLBhabhaTCollectorModule.h.

m_tree_ECLCalDigitTime

double m_tree_ECLCalDigitTime = realNaN

private

Time of an ECLCalDigit within a cluster, ns for debug TTree output.

Definition at line 188 of file ECLBhabhaTCollectorModule.h.

m_tree_ECLDigitAmplitude

double m_tree_ECLDigitAmplitude = realNaN

private

Amplitude (used to calculate energy) of an ECLDigit within a cluster, for debug TTree output.

Definition at line 190 of file ECLBhabhaTCollectorModule.h.

m_tree_en

double m_tree_en = realNaN

private

Energy of crystal with maximum energy within ECL cluster, GeV for debug TTree output.

Definition at line 142 of file ECLBhabhaTCollectorModule.h.

m_tree_enNeg

double m_tree_enNeg = realNaN

private

Energy of cluster associated to negatively charged track, GeV for debug TTree output.

Definition at line 174 of file ECLBhabhaTCollectorModule.h.

m_tree_enPlus

double m_tree_enPlus = realNaN

private

Energy of cluster associated to positively charged track, GeV for debug TTree output.

Definition at line 173 of file ECLBhabhaTCollectorModule.h.

m_tree_evtNum

int m_tree_evtNum = intNaN

private

Event number for debug TTree output.

Definition at line 139 of file ECLBhabhaTCollectorModule.h.

m_tree_maxEcrystNegClust

double m_tree_maxEcrystNegClust = realNaN

private

Time of the highest energy crystal in the cluster associated to negatively charged track, ns for debug TTree output.

Definition at line 183 of file ECLBhabhaTCollectorModule.h.

m_tree_maxEcrystPosClust

double m_tree_maxEcrystPosClust = realNaN

private

Time of the highest energy crystal in the cluster associated to positively charged track, ns for debug TTree output.

Definition at line 181 of file ECLBhabhaTCollectorModule.h.

m_tree_nCDChits

double m_tree_nCDChits = realNaN

private

Number of CDC hits along the track for debug TTree output.

Definition at line 165 of file ECLBhabhaTCollectorModule.h.

m_tree_p

double m_tree_p = realNaN

private

Track momentum for debug TTree output.

Definition at line 164 of file ECLBhabhaTCollectorModule.h.

m_tree_quality

int m_tree_quality = intNaN

private

ECL fit quality for debug TTree output.

Definition at line 152 of file ECLBhabhaTCollectorModule.h.

m_tree_t0

double m_tree_t0 = realNaN

private

EventT0 (not from ECL) for debug TTree output.

Definition at line 158 of file ECLBhabhaTCollectorModule.h.

m_tree_t0_ECL_minChi2

double m_tree_t0_ECL_minChi2 = realNaN

private

EventT0 (from ECL) min chi2 for debug TTree output.

Definition at line 161 of file ECLBhabhaTCollectorModule.h.

m_tree_t0_ECLclosestCDC

double m_tree_t0_ECLclosestCDC = realNaN

private

EventT0 (from ECL) closest to CDC for debug TTree output.

Definition at line 160 of file ECLBhabhaTCollectorModule.h.

m_tree_t0_unc

double m_tree_t0_unc = realNaN

private

EventT0 uncertainty for debug TTree output.

Definition at line 159 of file ECLBhabhaTCollectorModule.h.

m_tree_tClust

double m_tree_tClust = realNaN

private

Cluster time of a cluster, ns for debug TTree output.

Definition at line 186 of file ECLBhabhaTCollectorModule.h.

m_tree_tClustNeg

double m_tree_tClustNeg = realNaN

private

Cluster time of cluster associated to negatively charged track, ns for debug TTree output.

Definition at line 179 of file ECLBhabhaTCollectorModule.h.

m_tree_tClustPos

double m_tree_tClustPos = realNaN

private

Cluster time of cluster associated to positively charged track, ns for debug TTree output.

Definition at line 177 of file ECLBhabhaTCollectorModule.h.

m_tree_time

double m_tree_time = realNaN

private

Time for Ts distribution for debug TTree output.

Definition at line 154 of file ECLBhabhaTCollectorModule.h.

m_tree_timeF

double m_tree_timeF = realNaN

private

ECL fitting time for debug TTree output.

Definition at line 153 of file ECLBhabhaTCollectorModule.h.

m_tree_timetsPreviousTimeCalibs

double m_tree_timetsPreviousTimeCalibs = realNaN

private

Time for Ts distribution after application of previous time calibrations for debug TTree output.

Definition at line 155 of file ECLBhabhaTCollectorModule.h.

m_tree_z0

double m_tree_z0 = realNaN

private

Track z0 for debug TTree output.

Definition at line 163 of file ECLBhabhaTCollectorModule.h.

m_TrgResult

StoreObjPtr<SoftwareTriggerResult> m_TrgResult

private

Store array for Trigger selection.

Definition at line 84 of file ECLBhabhaTCollectorModule.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.

skipTrgSel

bool skipTrgSel

private

flag to skip the trigger skim selection in the module

Definition at line 241 of file ECLBhabhaTCollectorModule.h.

tracks

StoreArray<Track> tracks

private

StoreArray for tracks.

Definition at line 74 of file ECLBhabhaTCollectorModule.h.

---

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

• ecl/modules/eclBhabhaTCollector/include/ECLBhabhaTCollectorModule.h
• ecl/modules/eclBhabhaTCollector/src/ECLBhabhaTCollectorModule.cc