A module to study background campaigns and produce histograms. More...

#include <ECLBackgroundModule.h>

Inheritance diagram for ECLBackgroundModule:

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

virtual	~ECLBackgroundModule ()
	Destructor.

virtual void	initialize () override
	Initialize variables.

virtual void	beginRun () override
	beginRun

virtual void	event () override
	Event method

virtual void	endRun () override
	endRun

virtual void	terminate () override
	terminate

virtual void	defineHisto () override
	Initialize the histograms.

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

const std::string &	getName () const
	Returns the name of the module.

const std::string &	getType () const
	Returns the type of the module (i.e.

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module.

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

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

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module.

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.

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

void	setDescription (const std::string &description)
	Sets the description of the module.

void	setType (const std::string &type)
	Set the module type.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.

void	setReturnValue (int value)
	Sets the return value for this module as integer.

void	setReturnValue (bool value)
	Sets the return value for this module as bool.

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
int	FillARICHBeamBack (BeamBackHit *aBBHit)
	Populate ARICH HAPD dose and flux histograms (from the BeamBack hits array)

int	BuildECL ()
	Builds geometry (fill Crystal look-up arrays)

int	SetPosHistos (TH1F h, TH2F hFWD, TH2F hBAR, TH2F hBWD)
	Create 2D histograms indicating the position of each crystals.

TH2F *	BuildPosHisto (TH1F h, const char sub)
	Convert histogram vs crystal index to geometrical positions.

TH1F *	BuildThetaIDWideHisto (TH1F *h_cry)
	Convert histogram vs crystal index to average per theta-ID (wide binning)

TH1F *	BuildARICHringIDHisto (TH1F *h_cell)
	Convert histogram vs ARICH channel ID to average per ring ID.

int	ARICHmod2row (int modID)
	Get ARICH ring ID from the module index.

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
StoreArray< ECLSimHit >	m_eclArray
	Store array: ECLSimHit.

StoreArray< MCParticle >	m_mcParticles
	Store array: MCParticle.

StoreArray< BeamBackHit >	m_BeamBackArray
	Store array: BeamBackHit.

StoreArray< ECLShower >	m_eclShowerArray
	Store array: ECLShower.

int	m_sampleTime
	length of sample in us

bool	m_doARICH
	Whether or not the ARICH plots are produced.

std::vector< int >	m_CryInt
	Cell ID of crystal(s) of interest.

int	m_nEvent {0}
	Event counter.

TH1F *	h_nECLSimHits {nullptr}
	ECL Sim Hits.

TH1F *	h_CrystalRadDoseTheta {nullptr}
	Crystal Radiation Dose, actual Theta.

TH1F *	h_CrystalRadDose {nullptr}
	Crystal Radiation Dose.

TH1F *	h_CrystalThetaID2 {nullptr}
	Crystal Radiation Dose, ThetaID=2.

TH1F *	h_CrystalThetaID67 {nullptr}
	Crystal Radiation Dose, ThetaID=67.

TH2F *	h_HitLocations {nullptr}
	Hit locations.

TH1F *	h_BarrelDose {nullptr}
	Crystal Radiation Dose in Barrel, 12<thetaID<59.

TH1F *	hEdepPerRing {nullptr}
	Energy averaged per ring.

TH1F *	hNevtPerRing {nullptr}
	Event counter averaged per ring (theta-id)

TH1F *	h_DiodeRadDose {nullptr}
	Diode Radiation Dose.

TH1F *	h_NeutronFlux {nullptr}
	Neutron Flux in Diodes.

TH1F *	h_NeutronFluxThetaID2 {nullptr}
	Neutron flux in Diodes, ThetaID=2.

TH1F *	h_NeutronFluxThetaID67 {nullptr}
	Neutron flux in Diodes, ThetaID=67.

TH1F *	h_NeutronE {nullptr}
	Neutron Energy.

TH1F *	h_NeutronEThetaID0 {nullptr}
	Neutron Energy, First Crystal.

TH1F *	h_PhotonE {nullptr}
	Photon Energy.

TH2F *	h_ShowerVsTheta {nullptr}
	Shower Energy distribution vs theta.

TH1F *	h_Shower {nullptr}
	Shower Energy distribution.

TH1F *	h_ProdVert {nullptr}
	Production Vertex.

TH2F *	h_ProdVertvsThetaId {nullptr}
	Production Vertex vs thetaID.

const double	usInYr = 1e13
	us in a year

const double	GeVtoJ = 1.6e-10
	Joules in a GeV.

ECLCrystalData *	Crystal [ECLElementNumbers::c_NCrystals] {0}
	Store crystal geometry and mass data.

const double	DiodeArea = 2 * 2
	Frontal area [cm*cm] of Diodes.

const double	DiodeThk = 0.1
	Thickness [cm] of Diodes.

const double	SiRho = 2.33e-3
	Density (silicium) [kg*cm^{-3}] of Si.

const double	DiodeMass = DiodeArea * DiodeThk * SiRho
	Mass [kg] of Diodes.

const double	HAPDarea = 7.5 * 7.5
	ARICH geometry parameters.

const double	HAPDthickness = 0.2
	ARICH: Thickness (cm) of the HAPD boards.

const double	HAPDmass = 47.25e-3
	ARICH: Mass (kg) of the HAPD boards.

const int	nHAPD = 420
	ARICH parameter.

const int	nHAPDrings = 7
	ARICH parameter.

const int	nHAPDperRing [7] = {42, 48, 54, 60, 66, 72, 78}
	ARICH parameter.

TH1F *	hEMDose {nullptr}
	Radiation Dose per cell.

TH1F *	hEnergyPerCrystal {nullptr}
	Energy per cell.

TH1F *	hDiodeFlux {nullptr}
	Diode Neutron Flux per cell.

TH1F *	hEgamma {nullptr}
	Log Spectrum of the photons hitting the crystals / 1 MeV.

TH1F *	hEneu {nullptr}
	Log Spectrum of the neutrons hitting the diodes / 1 MeV.

TH1F *	hARICHDoseBB {nullptr}
	ARICH Yearly dose (rad) vs module index.

TH1F *	hHAPDFlux {nullptr}
	ARICH Yearly neutron flux vs module index.

TH2F *	hEnergyPerCrystalECF {nullptr}
	Energy per crystal Forward Calorimeter.

TH2F *	hEnergyPerCrystalECB {nullptr}
	Energy per crystal Backward Calorimeter.

TH2F *	hEnergyPerCrystalBAR {nullptr}
	Energy per crystal Barrel.

TH1F *	hEnergyPerCrystalWideTID {nullptr}
	Energy per crystal Wide bins.

TH2F *	hEMDoseECF {nullptr}
	Radiation Dose Forward Calorimeter.

TH2F *	hEMDoseECB {nullptr}
	Radiation Dose Backward Calorimeter.

TH2F *	hEMDoseBAR {nullptr}
	Radiation Dose Barrel.

TH1F *	hEMDoseWideTID {nullptr}
	Radiation Dose Wide bins.

TH2F *	hDiodeFluxECF {nullptr}
	Diode Neutron Flux Forward Calorimeter.

TH2F *	hDiodeFluxECB {nullptr}
	Diode Neutron Flux Backward Calorimeter.

TH2F *	hDiodeFluxBAR {nullptr}
	Diode Neutron Flux Barrel.

TH1F *	hDiodeFluxWideTID {nullptr}
	Diode Neutron Flux Wide bins.

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.

Static Private Attributes
static const int	nECLThetaID = 69
	Number of thetaID values.

Detailed Description

A module to study background campaigns and produce histograms.

Definition at line 41 of file ECLBackgroundModule.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

◆ ECLBackgroundModule()

ECLBackgroundModule ( )

Constructor.

Definition at line 44 of file ECLBackgroundModule.cc.

                                         : HistoModule()
{
  //Set module properties
  setDescription("Processes background campaigns and produces histograms. Requires HistoManager");
 
  std::vector<int> empty;
  addParam("sampleTime", m_sampleTime,     "Length of sample, in us", 1000);
  addParam("doARICH",    m_doARICH,        "If true, some ARICH plots (for shielding studies) will be produced",  false);
  addParam("crystalsOfInterest", m_CryInt, "Cell ID of crystals of interest. Dose will be printed at end of run", empty);
 
}

◆ ~ECLBackgroundModule()

~ECLBackgroundModule ( )

virtual

Destructor.

Definition at line 56 of file ECLBackgroundModule.cc.

57{

58}

Member Function Documentation

◆ ARICHmod2row()

int ARICHmod2row ( int modID )

private

Get ARICH ring ID from the module index.

Definition at line 598 of file ECLBackgroundModule.cc.

{
  if (modID <= 42) return 0;
  else if (modID <= 90) return 1;
  else if (modID <= 144) return 2;
  else if (modID <= 204) return 3;
  else if (modID <= 270) return 4;
  else if (modID <= 342) return 5;
  else if (modID <= 420) return 6;
 
  B2WARNING("ECLBackgroundModule: ARICHmod2row: modID out of bound; can't get ring index");
  return -1;
}

◆ beginRun()

void beginRun ( void )

overridevirtual

beginRun

Reimplemented from HistoModule.

Definition at line 173 of file ECLBackgroundModule.cc.

174{

175}

◆ BuildECL()

int BuildECL ( )

private

Builds geometry (fill Crystal look-up arrays)

Definition at line 464 of file ECLBackgroundModule.cc.

{
  for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++) {
    Crystal[i] = new ECLCrystalData(i);
  }
  return 1;
}

◆ BuildPosHisto()

TH2F * BuildPosHisto	(	TH1F *	h,
		const char *	sub
	)

private

Convert histogram vs crystal index to geometrical positions.

Definition at line 501 of file ECLBackgroundModule.cc.

{
 
  // Initialize variables
  TH2F* h_out = nullptr;
 
  // Forward endcap value vs (x,y)
  if (!strcmp(sub, "forward")) {
    std::string _name = h->GetName() + std::string("FWD");
    std::string _title = h->GetTitle() + std::string(" -- Forward Endcap;x(cm);y(cm)");
    h_out = new TH2F(_name.c_str(), _title.c_str(), 90, -150, 150, 90, -150, 150); //position in cm
    h_out->Sumw2();
    for (int i = 0; i < ECLElementNumbers::c_NCrystalsForward; i++)  {
      double value = h->GetBinContent(i + 1);
      h_out->Fill(floor(Crystal[i]->GetX()),
                  floor(Crystal[i]->GetY()),
                  value);
    }
 
    // Backward endcap value vs (x,y)
  } else if (!strcmp(sub, "backward")) {
    std::string _name = h->GetName() + std::string("BWD");
    std::string _title = h->GetTitle() + std::string(" -- Backward Endcap;x(cm);y(cm)");
    h_out = new TH2F(_name.c_str(), _title.c_str(), 90, -150, 150, 90, -150, 150); //position in cm
    h_out->Sumw2();
    for (int i = ECLElementNumbers::c_NCrystalsForwardBarrel; i < ECLElementNumbers::c_NCrystals; i++) {
      double value = h->GetBinContent(i + 1);
      h_out->Fill(floor(Crystal[i]->GetX()),
                  floor(Crystal[i]->GetY()),
                  value);
    }
 
 
    // The rest: barrel value vs (theta_ID, phi_ID)
  } else if (!strcmp(sub, "barrel")) {
    std::string _name = h->GetName() + std::string("BAR");
    std::string _title = h->GetTitle() + std::string(" -- Barrel;#theta_{ID};#phi_{ID}");
    h_out = new TH2F(_name.c_str(), _title.c_str(), 47, 12, 59, 144, 0, 144); //position in cm (along z and along r*phi)
    h_out->Sumw2();
    for (int i = ECLElementNumbers::c_NCrystalsForward; i < ECLElementNumbers::c_NCrystalsForwardBarrel; i++) {
      double value = h->GetBinContent(i + 1);
      h_out->Fill(Crystal[i]->GetThetaID(),  Crystal[i]->GetPhiID(), value);
    }
 
  } else {
    B2WARNING("ECLBackgroundModule: Unable to BuildPosHisto. Check Arguments.");
    h_out =  new TH2F("(empty)", "(empty)", 1, 0, 1, 1, 0, 1);
  }
 
  return h_out;
}

◆ BuildThetaIDWideHisto()

TH1F * BuildThetaIDWideHisto ( TH1F * h_cry )

private

Convert histogram vs crystal index to average per theta-ID (wide binning)

Definition at line 554 of file ECLBackgroundModule.cc.

{
 
  //Define the boundaries of the bins
  static const int    _nbins = 21;
  static const double _xbins[] = { -0.5,  0.5,  4.5,  8.5, 11.5, 12.5,
                                   16.5, 20.5, 24.5, 28.5, 32.5,
                                   36.5, 40.5, 44.5, 48.5, 52.5,
                                   56.5, 58.5, 59.5, 63.5, 67.5, 68.5
                                 };
 
 
  std::string _title = h_cry->GetTitle() + std::string(" vs #theta_{ID} -- averages");
  std::string _name = h_cry->GetName() + std::string("vsTheWide");
 
  //New pointer to the returned histogram ...
  TH1F* h_out  = new TH1F(_name.c_str(), _title.c_str(), 1, 0, 1);
  // ... but only temp variables to the temporary ones
  TH1F h_mass("h_mass", "Total Mass per Theta-ID", 1, 0, 1);
  TH1F h_N("h_N", "Entries (unweighted) per Theta-ID bin", 1, 0, 1);
 
  //Apply all the same binning
  h_out->SetBins(_nbins, _xbins);
  h_mass.SetBins(_nbins, _xbins);
  h_N.SetBins(_nbins, _xbins);
 
  h_out->SetTitle(_title.c_str());
  h_out->Sumw2();
 
  //Make histo for total mass, then divide!
  for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)  {
    h_out->Fill(Crystal[i]->GetThetaID(), h_cry->GetBinContent(i + 1) * Crystal[i]->GetMass());
    h_mass.Fill(Crystal[i]->GetThetaID(), Crystal[i]->GetMass());
    h_mass.SetBinError(Crystal[i]->GetThetaID(), 0);
    h_N.Fill(Crystal[i]->GetThetaID());
  }
  h_out->SetXTitle("#theta_{ID}");
  h_out->SetYTitle(h_cry->GetYaxis()->GetTitle());
  h_out->Divide(&h_mass);
 
  return h_out;
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ defineHisto()

void defineHisto ( )

overridevirtual

Initialize the histograms.

Reimplemented from HistoModule.

Definition at line 61 of file ECLBackgroundModule.cc.

{
  std::ostringstream s;
  s << m_sampleTime;
 
  //initialize histograms
  h_nECLSimHits = new TH1F("ECL_Sim_Hits", "ECL Sim Hits", 100, 0, 100);
 
 
  //Radiation dose
  h_CrystalRadDose = new TH1F("Crystal_Rad_Dose", "Crystal Radiation Dose vs #theta_{ID};#theta_{ID};Gy/yr", 69, -0.5, 68.5);
  h_CrystalRadDoseTheta = new TH1F("Crystal_Rad_Dose_Theta", "Crystal Radiation Dose vs #theta;#theta (deg);Gy/yr", 100,   12, 152);
  h_CrystalThetaID2 = new TH1F("Crystal_Dose_ThetaID_2", "Crystal Radiation Dose vs #phi_{ID}, #theta_{ID}=2; #phi_{ID};Gy/yr", 64,
                               -0.5, 63.5);
  h_CrystalThetaID67 = new TH1F("Crystal_Dose_ThetaID_67", "Crystal Radiation Dose vs #phi_{ID}, #theta_{ID}=67; #phi_{ID};Gy/yr", 64,
                                -0.5, 63.5);
  h_BarrelDose = new TH1F("Crystal_Dose_Barrel", "Crystal Radiation Dose in Barrel, 12<#theta_{ID}<59; #phi_{ID}; Gy/yr", 144, -0.5,
                          143.5);
  h_DiodeRadDose = new TH1F("Diode_Rad_Dose", "Diode Radiation Dose vs #theta_{ID};#theta_{ID};Gy/yr", 69, -0.5, 68.5);
 
  //hit locations
  h_ProdVert = new TH1F("MCProd_Vert", "Production Vertex;z (cm)", 125, -200, 300);
  h_HitLocations = new TH2F("Hit_Locations", "Hit locations;z (cm); r (cm)", 250, -200, 300, 80,    0, 160);
  h_ProdVertvsThetaId = new TH2F("MCProd_Vert_vs_ThetaID", "Production Vertex vs #theta_{ID};#theta_{ID};z (cm)", 69, -0.5, 68.5, 125,
                                 -200, 300);
  hEdepPerRing = new TH1F("hEdepPerRing", "Energy deposited per #theta_{ID};#theta_{ID}; GeV", 69, -0.5, 68.5);
  hNevtPerRing = new TH1F("hNevtPerRing", "Number of events #theta_{ID} (for pile-up);#theta_{ID};N_{event}", 69, -0.5, 68.5);
 
 
 
  //Neutrons
  h_NeutronFluxThetaID2 = new TH1F("Neutron_Flux_ThetaID_2", "Diode Neutron Flux, #theta_{ID}=2;#phi_{ID}; yr^{-1}/cm^{-2}", 64, -0.5,
                                   63.5);
  h_NeutronFluxThetaID67 = new TH1F("Neutron_Flux_ThetaID_67", "Diode Neutron Flux, #theta_{ID}=67;#phi_{ID}; yr^{-1}/cm^{-2}", 64,
                                    -0.5, 63.5);
  h_NeutronFlux = new TH1F("Neutron_Flux", "Diode Neutron Flux vs #theta_{ID};#theta_{ID}; yr^{-1}/cm^{-2}", 69, -0.5, 68.5);
  h_NeutronE = new TH1F("Neutron_Energy", "Neutron Energy; Energy (MeV)", 200, 0, 0.5);
  h_NeutronEThetaID0 = new TH1F("Neutron_Energy_ThetaID0", "Neutron Energy, First Crystal; Energy (MeV)", 50, 0, 0.5);
 
  h_PhotonE = new TH1F("Photon_Energy", "Energy of photons creating hits in ECL; Energy (MeV)",   200, 0, 10);
 
  //showers
  TString stime = s.str();
  h_Shower = new TH1F("Shower_E_Dist", "Shower Energy distribution " + stime + " #mu s;GeV;# of showers", 100, 0, 0.5);
  h_ShowerVsTheta = new TH2F("Shower_E_Dist_vs_theta", "Shower Energy distribution " + stime + " #mu s;GeV;#theta (deg)", 100, 0, 0.5,
                             180, 0, 180);
 
 
 
  //
  // Below are for the ECL shields studies
  //
 
  //Doses
  hEMDose = new TH1F("hEMDose",  "Crystal Radiation Dose; Cell ID ; Gy/yr", ECLElementNumbers::c_NCrystals, 0,
                     ECLElementNumbers::c_NCrystals);
  hEnergyPerCrystal = new TH1F("hEnergyPerCrystal", "Energy per crystal; Cell ID; GeV", ECLElementNumbers::c_NCrystals, 0,
                               ECLElementNumbers::c_NCrystals);
 
  //Diodes
  hDiodeFlux  = new TH1F("hDiodeFlux",  "Diode Neutron Flux ; Cell ID ; 1MeV-equiv / cm^{2} yr", ECLElementNumbers::c_NCrystals, 0,
                         ECLElementNumbers::c_NCrystals);
 
  //Radiation spectra
  hEgamma = new TH1F("hEgamma", "Log Spectrum of the photons hitting the crystals / 1 MeV; log_{10}(E_{#gamma}/1MeV) ", 500, -4, 3);
  hEneu   = new TH1F("hEneu",   "Log Spectrum of the neutrons hitting the diodes / 1 MeV; log_{10}(E_{n}/1MeV)",        500, -10, 2);
 
  //ARICH plots
  if (m_doARICH) {
    hARICHDoseBB = new TH1F("hARICHDoseBB", "Radiation dose in ARICH boards (cBB); Ring-ID; Gy/yr", 7, -0.5, 6.5);
    hHAPDFlux    = new TH1F("hARICHnFlux",  "1-MeV equivalent neutron flux in ARICH diodes (BB) ; Ring-ID ; 1-MeV-equiv / cm^{2} yr", 7,
                            -0.5, 6.5);
  }
 
  hEMDoseECF     = new TH2F();
  hEMDoseECB     = new TH2F();
  hEMDoseBAR     = new TH2F();
  hEMDoseWideTID = new TH1F();
 
  hDiodeFluxECF     = new TH2F();
  hDiodeFluxECB     = new TH2F();
  hDiodeFluxBAR     = new TH2F();
  hDiodeFluxWideTID = new TH1F();
 
  hEnergyPerCrystalECF     = new TH2F();
  hEnergyPerCrystalECB     = new TH2F();
  hEnergyPerCrystalBAR     = new TH2F();
  hEnergyPerCrystalWideTID = new TH1F();
 
 
 
}

◆ endRun()

void endRun ( void )

overridevirtual

endRun

Reimplemented from HistoModule.

Definition at line 380 of file ECLBackgroundModule.cc.

{
  B2INFO("ECLBackgroundModule: Total Number of events: "  << m_nEvent);
 
  //print doses of crystals of interest
  for (int i = 0; i < (int)m_CryInt.size(); i++) {
    if (m_CryInt[i] > ECLElementNumbers::c_NCrystals) {
      B2WARNING("ECLBackgroundModule: Invalid cell ID. must be less than 8736");
      continue;
    }
    double dose = hEMDose->GetBinContent(m_CryInt[i] + 1); //add 1 since bin #1 corresponds to cell ID #0
    int thetaID = Crystal[m_CryInt[i]]->GetThetaID();
    int phiID   = Crystal[m_CryInt[i]]->GetPhiID();
    B2RESULT("Dose in Crystal " << m_CryInt[i] << ": " << dose << " ThetaID=" << thetaID << ", PhiID=" << phiID);
  }
 
 
  hEnergyPerCrystalECF = BuildPosHisto(hEnergyPerCrystal, "forward");
  hEnergyPerCrystalECB = BuildPosHisto(hEnergyPerCrystal, "backward");
  hEnergyPerCrystalBAR = BuildPosHisto(hEnergyPerCrystal, "barrel");
  hEnergyPerCrystalWideTID = BuildThetaIDWideHisto(hEnergyPerCrystal);
 
 
  hEMDoseECF = BuildPosHisto(hEMDose, "forward");
  hEMDoseECB = BuildPosHisto(hEMDose, "backward");
  hEMDoseBAR = BuildPosHisto(hEMDose, "barrel");
  hEMDoseWideTID = BuildThetaIDWideHisto(hEMDose);
 
  hDiodeFluxECF  = BuildPosHisto(hDiodeFlux, "forward");
  hDiodeFluxECB  = BuildPosHisto(hDiodeFlux, "backward");
  hDiodeFluxBAR  = BuildPosHisto(hDiodeFlux, "barrel");
  hDiodeFluxWideTID = BuildThetaIDWideHisto(hDiodeFlux);
 
  hEMDose->SetTitle("Crystal Radiation Dose vs Cell ID");
  hDiodeFlux->SetTitle("Diode Neutron Flux vs Cell ID");
 
}

◆ evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns: True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

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

◆ event()

void event ( void )

overridevirtual

Event method

Reimplemented from HistoModule.

Definition at line 177 of file ECLBackgroundModule.cc.

{
 
 
 
  //some variables that will be used many times
  int m_cellID, m_thetaID, m_phiID, pid, NperRing;
  double edep, theta, Energy, diodeDose, weightedFlux;
 
  //ignore events with huge number of SimHits (usually a glitchy event)
  if (m_eclArray.getEntries() > 4000) {
    B2INFO("ECLBackgroundModule: Skipping event #" << m_nEvent << " due to large number of ECLSimHits");
    m_nEvent++;
    return;
  }
 
  bool isE = false;
  //bool EinTheta[nECLThetaID] = {false};
 
  double edepSum = 0;
  //double edepSumTheta[nECLThetaID] = {0};
  //double E_tot[ECLElementNumbers::c_NCrystals] = {0};
 
 
  auto edepSumTheta = new double[nECLThetaID]();
  auto E_tot = new double[ECLElementNumbers::c_NCrystals]();
 
  auto EinTheta = new bool[nECLThetaID]();
  std::fill_n(EinTheta, nECLThetaID, false);
 
 
  h_nECLSimHits->Fill(m_eclArray.getEntries()); //number of ECL hits in an event
 
  //MC ID of photon hits
  vector<int> MCPhotonIDs;
 
  int hitNum = m_eclArray.getEntries();
  for (int i = 0; i < hitNum; i++) { //loop over ECLSimHits
    ECLSimHit* aECLHit = m_eclArray[i];
    m_cellID    = aECLHit->getCellId() - 1; //cell ID
    edep        = aECLHit->getEnergyDep();  //energy deposited
    G4ThreeVector hitPosn   = aECLHit->getPosition();   //position of hit
    pid         = aECLHit->getPDGCode();
    float Mass  = Crystal[m_cellID]->GetMass();
    m_thetaID   = Crystal[m_cellID]->GetThetaID();
    m_phiID     = Crystal[m_cellID]->GetPhiID();
    NperRing    = Crystal[m_cellID]->GetNperThetaID();   //number of crystals in this theta ring
    theta       = Crystal[m_cellID]->GetTheta();
 
 
    //get Track ID of photons which create the SimHits
    if (pid == 22) MCPhotonIDs.push_back(aECLHit->getTrackId());
 
    edepSum = edepSum + edep;
    E_tot[m_cellID] = edep + E_tot[m_cellID]; //sum energy deposited in this crystal
    edepSumTheta[m_thetaID] = edepSumTheta[m_thetaID] + edep;   //sum of energy for this thetaID value
    EinTheta[m_thetaID] = true;                                 //there is an energy deposit in this theta ring. used later
    isE = true;
 
 
    //fill histograms
    //radiation dose for this SimHit
    double dose = edep * GeVtoJ * usInYr / (m_sampleTime * Mass);
 
    h_CrystalRadDoseTheta->Fill(theta, dose / NperRing);
    h_CrystalRadDose->AddBinContent(m_thetaID + 1,  dose / NperRing);
    hEMDose->AddBinContent(m_cellID + 1, dose);
    hEnergyPerCrystal->AddBinContent(m_cellID + 1, edep);
 
    //2nd thetaID ring
    if (m_thetaID == 2) {
      h_CrystalThetaID2->AddBinContent(m_phiID + 1,  dose);
    }
    //67th thetaID ring
    if (m_thetaID == 67) {
      h_CrystalThetaID67->AddBinContent(m_phiID + 1, dose);
    }
    //Barrel
    if (m_thetaID < 59 && m_thetaID > 12) {
      h_BarrelDose->AddBinContent(m_phiID + 1, dose / 46);
    }
 
    //location of the hit
    h_HitLocations->Fill(hitPosn.z(), hitPosn.perp());
 
  }
 
 
  //for pileup noise estimation. To properly produce pileup noise plot, see comment at EOF.
  for (int iECLCell = 0; iECLCell < ECLElementNumbers::c_NCrystals; iECLCell++) {
    edep      = E_tot[iECLCell];
    m_thetaID = Crystal[iECLCell]->GetThetaID();
    NperRing  = Crystal[iECLCell]->GetNperThetaID();
    if (edep > 0.000000000001) {
      hNevtPerRing->Fill(m_thetaID, 1.0 / NperRing);
      hEdepPerRing->Fill(m_thetaID, edep / NperRing);
    }
 
  }
 
 
  //One track can create several ECLSimHits. Remove the duplicates
  sort(MCPhotonIDs.begin(), MCPhotonIDs.end());
  vector<int>::iterator it;
  it = std::unique(MCPhotonIDs.begin(), MCPhotonIDs.end());
  MCPhotonIDs.resize(std::distance(MCPhotonIDs.begin(), it));
 
 
  //loop over MCParticles to find the photons that caused the simhits
  for (int i = 0; i < (int)MCPhotonIDs.size(); i++) {
    for (int j = 0; j < m_mcParticles.getEntries(); j++) {
      if (m_mcParticles[j]->getIndex() == MCPhotonIDs[i]) {
        h_PhotonE->Fill(m_mcParticles[j]->getEnergy() * 1000);
        hEgamma->Fill(log10(m_mcParticles[j]->getEnergy() * 1000));
        break;         //once the correct MCParticle is found, stop looping over MCParticles
      }
    }
  }
 
  //*****************end of crystal analysis
 
  //start of diode analysis
  int neuHits = m_BeamBackArray.getEntries();
  for (int iHits = 0; iHits < neuHits; iHits++) { //loop over m_BeamBackArray
    BeamBackHit* aBeamBackSimHit = m_BeamBackArray[iHits];
 
    //get relevant values
    m_cellID = aBeamBackSimHit->getIdentifier();
    double damage = aBeamBackSimHit->getNeutronWeight();
    edep          = aBeamBackSimHit->getEnergyDeposit();
    pid           = aBeamBackSimHit->getPDG();
    int SubDet    = aBeamBackSimHit->getSubDet();
    Energy = aBeamBackSimHit->getEnergy();
    //ROOT::Math::XYZVector rHit          = aBeamBackSimHit->getPosition(); //currently not used
 
 
    if (SubDet == 6) { //ECL
 
      m_thetaID = Crystal[m_cellID]->GetThetaID();
      m_phiID   = Crystal[m_cellID]->GetPhiID();
      NperRing  = Crystal[m_cellID]->GetNperThetaID();
      diodeDose = edep * GeVtoJ * usInYr / (m_sampleTime * DiodeMass);
      h_DiodeRadDose->AddBinContent(m_thetaID + 1, diodeDose / NperRing); //diode radiation dose plot
 
      if (pid == 2112) {
 
        weightedFlux = damage * usInYr / (m_sampleTime * DiodeArea) ;           //neutrons per cm^2 per year
 
        //neutron plots
        if (m_thetaID == 0) h_NeutronEThetaID0->Fill(Energy * 1000);
        h_NeutronE->Fill(Energy * 1000);
        hEneu->Fill(log10(Energy * 1000));
 
        h_NeutronFlux->AddBinContent(m_thetaID + 1, weightedFlux / NperRing);
        hDiodeFlux->AddBinContent(m_cellID + 1,  weightedFlux);
 
        if (m_thetaID == 2)  h_NeutronFluxThetaID2->AddBinContent(m_phiID + 1, weightedFlux);
        if (m_thetaID == 67) h_NeutronFluxThetaID67->AddBinContent(m_phiID + 1, weightedFlux);
 
 
      }
 
    } else if (SubDet == 4 && m_doARICH) { //ARICH
      FillARICHBeamBack(aBeamBackSimHit);
    }
  }
 
  int nShower = m_eclShowerArray.getEntries();
  for (int i = 0; i < nShower; i++) {
    ECLShower* aShower = m_eclShowerArray[i];
 
    Energy = aShower->getEnergy();
    theta = aShower->getTheta();
 
    //get number of background showers with energy above 20MeV
    if (Energy > 0.02) {
      h_Shower->Fill(Energy);
      h_ShowerVsTheta->Fill(Energy, theta * TMath::RadToDeg());
    }
  }
 
 
  for (int i = 0; i < nECLThetaID; i++) {
    if (EinTheta[i]) {
      //0th McParticle in an event is the origin of all particles
      h_ProdVertvsThetaId->Fill(i, m_mcParticles[0]->getProductionVertex().z(), edepSumTheta[i]);
    }
  }
 
 
  if (isE) {
    h_ProdVert->Fill(m_mcParticles[0]->getProductionVertex().z(), edepSum);
  }
 
  if (m_nEvent % ((int)m_sampleTime * 100) == 0) B2INFO("ECLBackgroundModule: At Event #" << m_nEvent);
  m_nEvent++;
 
  delete[] edepSumTheta;
  delete[] E_tot;
  delete[] EinTheta;
 
}

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

◆ FillARICHBeamBack()

int FillARICHBeamBack ( BeamBackHit * aBBHit )

private

Populate ARICH HAPD dose and flux histograms (from the BeamBack hits array)

Definition at line 461 of file ECLBackgroundModule.cc.

461{ return 1;}

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

void if_false	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

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

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

void if_true	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

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

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

void if_value	(	const std::string &	expression,
		const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize variables.

Reimplemented from HistoModule.

Definition at line 155 of file ECLBackgroundModule.cc.

{
 
  REG_HISTOGRAM
 
  if (m_doARICH)  {
    B2INFO("ECLBackgroundModule: ARICH plots are being produced");
    // Initialize variables
#ifdef DOARICH
    m_arichgp = ARICHGeometryPar::Instance();
#endif
  }
 
  m_nEvent = 0;
  BuildECL();
 
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note: The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict & dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

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

Definition at line 249 of file Module.cc.

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

◆ SetPosHistos()

int SetPosHistos	(	TH1F *	h,
		TH2F *	hFWD,
		TH2F *	hBAR,
		TH2F *	hBWD
	)

private

Create 2D histograms indicating the position of each crystals.

Definition at line 473 of file ECLBackgroundModule.cc.

{
  // Currently not used
  //std::string FWDtitle = h->GetTitle() + std::string(" -- Forward Endcap");
  //std::string BWDtitle = h->GetTitle() + std::string(" -- Backward Endcap");
  //std::string BARtitle = h->GetTitle() + std::string(" -- Barrel");
  //std::string FWDname = h->GetTitle() + std::string("FWD");
  //std::string BWDname = h->GetTitle() + std::string("BWD");
  //std::string BARname = h->GetTitle() + std::string("BAR");
 
  // Fill 2D histograms with the values in the 1D histogram
  for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)  {
    float value = h->GetBinContent(i + 1);
 
    if (i < ECLElementNumbers::c_NCrystalsForward) {
      hFWD->Fill(floor(Crystal[i]->GetX()), floor(Crystal[i]->GetY()), value);
 
    } else if (i >= ECLElementNumbers::c_NCrystalsForwardBarrel) {
      hBWD->Fill(floor(Crystal[i]->GetX()), floor(Crystal[i]->GetY()), value);
 
    } else
      hBAR->Fill(floor(Crystal[i]->GetZ()), floor(Crystal[i]->GetR() * (Crystal[i]->GetPhi() - 180) * TMath::DegToRad()), value);
  }
 
  return 1;
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

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

◆ terminate()

void terminate ( void )

overridevirtual

terminate

Reimplemented from HistoModule.

Definition at line 418 of file ECLBackgroundModule.cc.

419{

420}

Member Data Documentation

◆ Crystal

ECLCrystalData* Crystal[ECLElementNumbers::c_NCrystals] {0}

private

Store crystal geometry and mass data.

Definition at line 151 of file ECLBackgroundModule.h.

◆ DiodeArea

const double DiodeArea = 2 * 2

private

Frontal area [cm*cm] of Diodes.

Definition at line 176 of file ECLBackgroundModule.h.

◆ DiodeMass

const double DiodeMass = DiodeArea * DiodeThk * SiRho

private

Mass [kg] of Diodes.

Definition at line 182 of file ECLBackgroundModule.h.

◆ DiodeThk

const double DiodeThk = 0.1

private

Thickness [cm] of Diodes.

Definition at line 178 of file ECLBackgroundModule.h.

◆ GeVtoJ

const double GeVtoJ = 1.6e-10

private

Joules in a GeV.

Definition at line 148 of file ECLBackgroundModule.h.

◆ h_BarrelDose

TH1F* h_BarrelDose {nullptr}

private

Crystal Radiation Dose in Barrel, 12<thetaID<59.

Definition at line 109 of file ECLBackgroundModule.h.

◆ h_CrystalRadDose

TH1F* h_CrystalRadDose {nullptr}

private

Crystal Radiation Dose.

Definition at line 101 of file ECLBackgroundModule.h.

◆ h_CrystalRadDoseTheta

TH1F* h_CrystalRadDoseTheta {nullptr}

private

Crystal Radiation Dose, actual Theta.

Definition at line 99 of file ECLBackgroundModule.h.

◆ h_CrystalThetaID2

TH1F* h_CrystalThetaID2 {nullptr}

private

Crystal Radiation Dose, ThetaID=2.

Definition at line 103 of file ECLBackgroundModule.h.

◆ h_CrystalThetaID67

TH1F* h_CrystalThetaID67 {nullptr}

private

Crystal Radiation Dose, ThetaID=67.

Definition at line 105 of file ECLBackgroundModule.h.

◆ h_DiodeRadDose

TH1F* h_DiodeRadDose {nullptr}

private

Diode Radiation Dose.

Definition at line 120 of file ECLBackgroundModule.h.

◆ h_HitLocations

TH2F* h_HitLocations {nullptr}

private

Hit locations.

Definition at line 107 of file ECLBackgroundModule.h.

◆ h_nECLSimHits

TH1F* h_nECLSimHits {nullptr}

private

ECL Sim Hits.

Definition at line 96 of file ECLBackgroundModule.h.

◆ h_NeutronE

TH1F* h_NeutronE {nullptr}

private

Neutron Energy.

Definition at line 128 of file ECLBackgroundModule.h.

◆ h_NeutronEThetaID0

TH1F* h_NeutronEThetaID0 {nullptr}

private

Neutron Energy, First Crystal.

Definition at line 130 of file ECLBackgroundModule.h.

◆ h_NeutronFlux

TH1F* h_NeutronFlux {nullptr}

private

Neutron Flux in Diodes.

Definition at line 122 of file ECLBackgroundModule.h.

◆ h_NeutronFluxThetaID2

TH1F* h_NeutronFluxThetaID2 {nullptr}

private

Neutron flux in Diodes, ThetaID=2.

Definition at line 124 of file ECLBackgroundModule.h.

◆ h_NeutronFluxThetaID67

TH1F* h_NeutronFluxThetaID67 {nullptr}

private

Neutron flux in Diodes, ThetaID=67.

Definition at line 126 of file ECLBackgroundModule.h.

◆ h_PhotonE

TH1F* h_PhotonE {nullptr}

private

Photon Energy.

Definition at line 132 of file ECLBackgroundModule.h.

◆ h_ProdVert

TH1F* h_ProdVert {nullptr}

private

Production Vertex.

Definition at line 141 of file ECLBackgroundModule.h.

◆ h_ProdVertvsThetaId

TH2F* h_ProdVertvsThetaId {nullptr}

private

Production Vertex vs thetaID.

Definition at line 143 of file ECLBackgroundModule.h.

◆ h_Shower

TH1F* h_Shower {nullptr}

private

Shower Energy distribution.

Definition at line 138 of file ECLBackgroundModule.h.

◆ h_ShowerVsTheta

TH2F* h_ShowerVsTheta {nullptr}

private

Shower Energy distribution vs theta.

Definition at line 136 of file ECLBackgroundModule.h.

◆ HAPDarea

const double HAPDarea = 7.5 * 7.5

private

ARICH geometry parameters.

ARICH: Area (cm^2) of the HAPD boards

Definition at line 194 of file ECLBackgroundModule.h.

◆ HAPDmass

const double HAPDmass = 47.25e-3

private

ARICH: Mass (kg) of the HAPD boards.

Definition at line 198 of file ECLBackgroundModule.h.

◆ HAPDthickness

const double HAPDthickness = 0.2

private

ARICH: Thickness (cm) of the HAPD boards.

Definition at line 196 of file ECLBackgroundModule.h.

◆ hARICHDoseBB

TH1F* hARICHDoseBB {nullptr}

private

ARICH Yearly dose (rad) vs module index.

Based on energy of all BeamBackgrounds

Definition at line 226 of file ECLBackgroundModule.h.

◆ hDiodeFlux

TH1F* hDiodeFlux {nullptr}

private

Diode Neutron Flux per cell.

Definition at line 217 of file ECLBackgroundModule.h.

◆ hDiodeFluxBAR

TH2F* hDiodeFluxBAR {nullptr}

private

Diode Neutron Flux Barrel.

Definition at line 254 of file ECLBackgroundModule.h.

◆ hDiodeFluxECB

TH2F* hDiodeFluxECB {nullptr}

private

Diode Neutron Flux Backward Calorimeter.

Definition at line 252 of file ECLBackgroundModule.h.

◆ hDiodeFluxECF

TH2F* hDiodeFluxECF {nullptr}

private

Diode Neutron Flux Forward Calorimeter.

Definition at line 250 of file ECLBackgroundModule.h.

◆ hDiodeFluxWideTID

TH1F* hDiodeFluxWideTID {nullptr}

private

Diode Neutron Flux Wide bins.

Definition at line 256 of file ECLBackgroundModule.h.

◆ hEdepPerRing

TH1F* hEdepPerRing {nullptr}

private

Energy averaged per ring.

Definition at line 112 of file ECLBackgroundModule.h.

◆ hEgamma

TH1F* hEgamma {nullptr}

private

Log Spectrum of the photons hitting the crystals / 1 MeV.

Definition at line 220 of file ECLBackgroundModule.h.

◆ hEMDose

TH1F* hEMDose {nullptr}

private

Radiation Dose per cell.

Definition at line 211 of file ECLBackgroundModule.h.

◆ hEMDoseBAR

TH2F* hEMDoseBAR {nullptr}

private

Radiation Dose Barrel.

Definition at line 245 of file ECLBackgroundModule.h.

◆ hEMDoseECB

TH2F* hEMDoseECB {nullptr}

private

Radiation Dose Backward Calorimeter.

Definition at line 243 of file ECLBackgroundModule.h.

◆ hEMDoseECF

TH2F* hEMDoseECF {nullptr}

private

Radiation Dose Forward Calorimeter.

Definition at line 241 of file ECLBackgroundModule.h.

◆ hEMDoseWideTID

TH1F* hEMDoseWideTID {nullptr}

private

Radiation Dose Wide bins.

Definition at line 247 of file ECLBackgroundModule.h.

◆ hEnergyPerCrystal

TH1F* hEnergyPerCrystal {nullptr}

private

Energy per cell.

Definition at line 214 of file ECLBackgroundModule.h.

◆ hEnergyPerCrystalBAR

TH2F* hEnergyPerCrystalBAR {nullptr}

private

Energy per crystal Barrel.

Definition at line 235 of file ECLBackgroundModule.h.

◆ hEnergyPerCrystalECB

TH2F* hEnergyPerCrystalECB {nullptr}

private

Energy per crystal Backward Calorimeter.

Definition at line 233 of file ECLBackgroundModule.h.

◆ hEnergyPerCrystalECF

TH2F* hEnergyPerCrystalECF {nullptr}

private

Energy per crystal Forward Calorimeter.

Definition at line 231 of file ECLBackgroundModule.h.

◆ hEnergyPerCrystalWideTID

TH1F* hEnergyPerCrystalWideTID {nullptr}

private

Energy per crystal Wide bins.

Definition at line 237 of file ECLBackgroundModule.h.

◆ hEneu

TH1F* hEneu {nullptr}

private

Log Spectrum of the neutrons hitting the diodes / 1 MeV.

Definition at line 222 of file ECLBackgroundModule.h.

◆ hHAPDFlux

TH1F* hHAPDFlux {nullptr}

private

ARICH Yearly neutron flux vs module index.

Based on energy of all BeamBackgrounds

Definition at line 228 of file ECLBackgroundModule.h.

◆ hNevtPerRing

TH1F* hNevtPerRing {nullptr}

private

Event counter averaged per ring (theta-id)

Definition at line 115 of file ECLBackgroundModule.h.

◆ m_BeamBackArray

StoreArray<BeamBackHit> m_BeamBackArray

private

Store array: BeamBackHit.

Definition at line 78 of file ECLBackgroundModule.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_CryInt

std::vector<int> m_CryInt

private

Cell ID of crystal(s) of interest.

Definition at line 90 of file ECLBackgroundModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_doARICH

bool m_doARICH

private

Whether or not the ARICH plots are produced.

Definition at line 87 of file ECLBackgroundModule.h.

◆ m_eclArray

StoreArray<ECLSimHit> m_eclArray

private

Store array: ECLSimHit.

Definition at line 72 of file ECLBackgroundModule.h.

◆ m_eclShowerArray

StoreArray<ECLShower> m_eclShowerArray

private

Store array: ECLShower.

Definition at line 81 of file ECLBackgroundModule.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_mcParticles

StoreArray<MCParticle> m_mcParticles

private

Store array: MCParticle.

Definition at line 75 of file ECLBackgroundModule.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_nEvent

int m_nEvent {0}

private

Event counter.

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

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_sampleTime

int m_sampleTime

private

length of sample in us

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

◆ nECLThetaID

const int nECLThetaID = 69

staticprivate

Number of thetaID values.

Definition at line 172 of file ECLBackgroundModule.h.

◆ nHAPD

const int nHAPD = 420

private

ARICH parameter.

Definition at line 202 of file ECLBackgroundModule.h.

◆ nHAPDperRing

const int nHAPDperRing[7] = {42, 48, 54, 60, 66, 72, 78}

private

ARICH parameter.

Definition at line 206 of file ECLBackgroundModule.h.

◆ nHAPDrings

const int nHAPDrings = 7

private

ARICH parameter.

Definition at line 204 of file ECLBackgroundModule.h.

◆ SiRho

const double SiRho = 2.33e-3

private

Density (silicium) [kg*cm^{-3}] of Si.

Definition at line 180 of file ECLBackgroundModule.h.

◆ usInYr

const double usInYr = 1e13

private

us in a year

Definition at line 146 of file ECLBackgroundModule.h.

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

ecl/modules/eclBackgroundStudy/include/ECLBackgroundModule.h
ecl/modules/eclBackgroundStudy/src/ECLBackgroundModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLBackgroundModule()

◆ ~ECLBackgroundModule()

Member Function Documentation

◆ ARICHmod2row()

◆ beginRun()

◆ BuildECL()

◆ BuildPosHisto()

◆ BuildThetaIDWideHisto()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ defineHisto()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ FillARICHBeamBack()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ SetPosHistos()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ Crystal

◆ DiodeArea

◆ DiodeMass

◆ DiodeThk

◆ GeVtoJ

◆ h_BarrelDose