The MaterialScan module. More...

#include <MaterialScan.h>

Inheritance diagram for MaterialScanModule:

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
void	initialize () override
	Initialize the output file and check the parameters.

void	beginRun () override
	Do the actual scanning.

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

virtual void	event ()
	This method is the core of the module.

virtual void	endRun ()
	This method is called if the current run ends.

virtual void	terminate ()
	This method is called at the end of the event processing.

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
G4ThreeVector	getAxis (char name)
	Return a vector along the axis with the given name.

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
TFile *	m_rootFile
	Pointer to the ROOT file for the histograms.

std::string	m_filename
	Filename for the ROOT output.

std::string	m_planeName
	Name of the plane to use for scanning.

MaterialScan2D::ScanParams	m_spherical
	Scan parameters for the spherical scan.

MaterialScan2D::ScanParams	m_planar
	Scan parameters for the planar scan.

std::vector< double >	m_customPlane
	Custom plane definition if m_planName is "custom".

std::vector< double >	m_sphericalOrigin
	Origin for spherical scan.

std::vector< double >	m_rayOrigin {0, 0, 0}
	Origin of the ray if a ray scan is performed

std::vector< std::string >	m_rayIgnoredMaterials
	Materials ignored when ray scanning.

std::optional< std::vector< double > >	m_rayDirection
	Direction of the ray, cannot be set at the same time as Theta and Phi.

double	m_rayTheta {0}
	Theta direction of the ray if custom direction is not set.

double	m_rayPhi {0}
	Phi direction of the ray if custom direction is not set.

double	m_rayOpening {0}
	Opening angle of the ray.

double	m_raySampleDepth {0.1}
	Sample depth of the ray: create one bin every x cm.

double	m_rayMaxDepth {1000}
	Max depth of the ray before stopping.

unsigned int	m_rayCount {0}
	Number of rays to shoot (if opening angle is >0)

bool	m_doSpherical
	Wether or not to do a spherical scan.

bool	m_doPlanar
	Wether or not to do a planar scan.

bool	m_doCosTheta
	Perform the spherical scan uniform in cos(theta) instead of theta.

bool	m_doRay
	Perform a material ray scan: scan along a certain direction with a given opening angle and plot material vs ray depth.

bool	m_raySplitByMaterials {false}
	If true Split by materials instead of regions when doing ray scan.

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

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

The MaterialScan module.

This Module is intended to scan the material budget of the geometry. Currently, there are two different kinds of scans available: Spherical and Planar scan.

Spherical scan will shoot rays from the origin of the detector and scan along the polar and azimuth angle.
Planar scan will shoot rays perpendicular to a given plane.

Definition at line 311 of file MaterialScan.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

◆ MaterialScanModule()

MaterialScanModule ( )

Definition at line 336 of file MaterialScan.cc.

                                      : m_rootFile(0), m_sphericalOrigin(3, 0), m_doCosTheta(false)
{
  //Set module properties
  setDescription("This Module is intended to scan the material budget of the "
                 "geometry.  Currently, there are two different kinds of scans "
                 "available: Spherical and Planar scan. \n"
                 "Spherical scan will shoot rays from the origin of the "
                 "detector and scan along the polar and azimuth angle.\n"
                 "Planar scan will shoot rays perpendicular to a given "
                 "plane.");
 
  //Set default ignored Materials
  m_spherical.ignoredMaterials.push_back("Vacuum");
  m_spherical.ignoredMaterials.push_back("Air");
  m_spherical.ignoredMaterials.push_back("G4_AIR");
  m_planar.ignoredMaterials = m_spherical.ignoredMaterials;
  m_rayIgnoredMaterials = m_spherical.ignoredMaterials;
 
  addParam("Filename",            m_filename,
           "The filename where the material scan will be stored",
           string("MaterialScan.root"));
  addParam("spherical",           m_doSpherical,
           "Do a spherical scan, that is shooting rays from the origin with "
           "varying angles", true);
  addParam("spherical.origin",    m_sphericalOrigin,
           "Origin for the spherical scan", m_sphericalOrigin);
  addParam("spherical.nTheta",    m_spherical.nU,
           "Number of rays in theta", 200);
  addParam("spherical.minTheta",  m_spherical.minU,
           "Theta start angle", 17.);
  addParam("spherical.maxTheta",  m_spherical.maxU,
           "Theta stop angle", 150.);
  addParam("spherical.nPhi",      m_spherical.nV,
           "Number of rays in phi", 200);
  addParam("spherical.minPhi",    m_spherical.minV,
           "Phi start angle", 0.);
  addParam("spherical.maxPhi",    m_spherical.maxV,
           "Phi stop angle", 360.);
  addParam("spherical.maxDepth",  m_spherical.maxDepth,
           "Maximum scan depth in cm. The ray will be killed after having "
           "reached the maximum Depth. <=0 means no Limit.", -1.0);
  addParam("spherical.ignored",      m_spherical.ignoredMaterials,
           "Names of Materials which should be ignored when doing the scan", m_spherical.ignoredMaterials);
  addParam("spherical.splitByMaterials", m_spherical.splitByMaterials,
           "If True, split output by material names instead of by regions", false);
  addParam("spherical.cosTheta", m_doCosTheta,
           "If True, perform the spherical scan uniform in cos(theta) instead of theta", false);
 
  addParam("planar",              m_doPlanar,
           "Do a plane scan, that is shooting parallel rays from a defined "
           "plane", true);
  addParam("planar.plane",        m_planeName,
           "Plane to use for scanning, available are all two letter "
           "combinations of X,Y and Z like XY and XZ and custom", string("ZX"));
  addParam("planar.nU",           m_planar.nU,
           "Number of rays in U", 200);
  addParam("planar.minU",         m_planar.minU,
           "U start", -400.0);
  addParam("planar.maxU",         m_planar.maxU,
           "U stop", 400.0);
  addParam("planar.nV",           m_planar.nV,
           "Number of rays in V", 200);
  addParam("planar.minV",         m_planar.minV,
           "V start", -400.0);
  addParam("planar.maxV",         m_planar.maxV,
           "V stop", 400.0);
  addParam("planar.maxDepth",     m_planar.maxDepth,
           "Maximum scan depth in cm. The ray will be killed after having "
           "reached the maximum Depth. <=0 means no Limit.", -1.0);
  addParam("planar.custom",       m_customPlane,
           "Parameters of the plane when choosing custom. This is supposed to "
           "be a list of 9 values: The first three are the coordinates of the "
           "plane origin. The second three are the direction of U in the "
           "r-phi coordinates. The last three are the direction of V in the "
           "coordinates parallel to the detector axis (beamline). ", m_customPlane);
  addParam("planar.ignored",      m_planar.ignoredMaterials,
           "Names of Materials which should be ignored when doing the scan", m_planar.ignoredMaterials);
  addParam("planar.splitByMaterials", m_planar.splitByMaterials,
           "If True, split output by material names instead of by regions", false);
 
  addParam("ray", m_doRay, "Do a ray scan: Shoot from the given origin in a "
           "given direction and record the material encountered along the way", false);
  addParam("ray.origin", m_rayOrigin, "Origin for the ray", m_rayOrigin);
  addParam("ray.theta", m_rayTheta, "Theta angle for the ray in degrees", m_rayTheta);
  addParam("ray.phi", m_rayPhi, "Phi angle of the ray in degrees", m_rayPhi);
  addParam("ray.direction", m_rayDirection, "Set the ray direction as vector "
           "[x,y,z]. You cannot set this and theta/phi at the same time",
           m_rayDirection);
  addParam("ray.opening", m_rayOpening, "Opening angle for the ray in degrees. "
           "If bigger than 0 then multiple rays (``ray.count``) will be shot "
           "randomly inside the opening angle uniformly distributed in area "
           "(cosine of the angle)", m_rayOpening);
  addParam("ray.count", m_rayCount, "Count of rays if the opening angle is >0",
           m_rayCount);
  addParam("ray.sampleDepth", m_raySampleDepth, "Distance in which to sample the "
           "material", m_raySampleDepth);
  addParam("ray.maxDepth", m_rayMaxDepth, "Max distance for the ray before it's "
           "stopped, 0 for no limit. The actual depth can be smaller if the "
           "simulation volume ends earlier", m_rayMaxDepth);
  addParam("ray.ignored", m_rayIgnoredMaterials, "Names of Materials which "
           "should be ignored when doing the scan", m_rayIgnoredMaterials);
}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

Do the actual scanning.

Reimplemented from Module.

Definition at line 478 of file MaterialScan.cc.

{
  G4EventManager* eventManager = G4EventManager::GetEventManager();
 
  //First we save all user actions
  G4UserEventAction*    vanillaEventAction    = eventManager->GetUserEventAction();
  G4UserStackingAction* vanillaStackingAction = eventManager->GetUserStackingAction();
  G4UserTrackingAction* vanillaTrackingAction = eventManager->GetUserTrackingAction();
  G4UserSteppingAction* vanillaSteppingAction = eventManager->GetUserSteppingAction();
 
  //Then we clear the user actions
  eventManager->SetUserAction((G4UserEventAction*)0);
  eventManager->SetUserAction((G4UserStackingAction*)0);
  eventManager->SetUserAction((G4UserTrackingAction*)0);
 
  //We create our own stepping actions which will
  //- create the vectors for shooting rays
  //- record the material budget for each ray
  vector<MaterialScanBase*> scans;
  if (m_doSpherical) {
    G4ThreeVector origin(m_sphericalOrigin[0], m_sphericalOrigin[1], m_sphericalOrigin[2]);
    scans.push_back(new MaterialScanSpherical(m_rootFile, origin, m_spherical, m_doCosTheta));
  }
  if (m_doPlanar) {
    G4ThreeVector origin(0, 0, 0);
    G4ThreeVector uDir;
    G4ThreeVector vDir;
    if (m_planeName == "custom") {
      origin.set(m_customPlane[0], m_customPlane[1], m_customPlane[2]);
      uDir.set(m_customPlane[3], m_customPlane[4], m_customPlane[5]);
      vDir.set(m_customPlane[6], m_customPlane[7], m_customPlane[8]);
    } else {
      uDir = getAxis(m_planeName[0]);
      vDir = getAxis(m_planeName[1]);
    }
    scans.push_back(new MaterialScanPlanar(m_rootFile, origin, uDir, vDir, m_planar));
  }
 
  if (m_doRay) {
    G4ThreeVector origin(m_sphericalOrigin[0], m_sphericalOrigin[1], m_sphericalOrigin[2]);
    G4ThreeVector dir;
    if (m_rayDirection) {
      for (int i = 0; i < 3; ++i) dir[0] = (*m_rayDirection)[0];
      dir = dir.unit();
    } else {
      dir.setRThetaPhi(1., m_rayTheta * Unit::deg, m_rayPhi * Unit::deg);
    }
    scans.push_back(new MaterialScanRay(m_rootFile, origin, dir, m_rayOpening * Unit::deg, m_rayCount,
                                        m_raySampleDepth / Unit::mm, m_rayMaxDepth / Unit::mm,
                                        m_raySplitByMaterials, m_rayIgnoredMaterials));
  }
 
  //Do each configured scan
  for (MaterialScanBase* scan : scans) {
    //Set the Scan as steppingaction to see material
    eventManager->SetUserAction(scan);
    //Now we can scan
    G4RayShooter rayShooter;
    G4ThreeVector origin;
    G4ThreeVector direction;
    int maxRays = scan->getNRays();
    int curRay(0);
    int lastPercent(-1);
    double start = Utils::getClock();
    //Create one event per ray and process it
    while (scan->createNext(origin, direction)) {
      G4Event* event = new G4Event(++curRay);
      rayShooter.Shoot(event, origin, direction);
      eventManager->ProcessOneEvent(event);
      delete event;
 
      //Show progress
      int donePercent = 100 * curRay / maxRays;
      if (donePercent > lastPercent) {
        double perRay = (Utils::getClock() - start) / curRay;
        double eta = perRay * (maxRays - curRay);
        B2INFO(boost::format("%s Scan: %3d%%, %.3f ms per ray, ETA: %.2f seconds")
               % scan->getName() % donePercent
               % (perRay / Unit::ms) % (eta / Unit::s));
        lastPercent = donePercent;
      }
    }
  }
  m_rootFile->Write();
  // free the scan objects which also deletes the histograms ...
  for (MaterialScanBase* scan : scans) {
    delete scan;
  }
  // and delete the file, which we could not do before because that would also delete the histograms ...
  m_rootFile->Close();
  delete m_rootFile;
  m_rootFile = nullptr;
  //And now we reset the user actions
  eventManager->SetUserAction(vanillaEventAction);
  eventManager->SetUserAction(vanillaStackingAction);
  eventManager->SetUserAction(vanillaTrackingAction);
  eventManager->SetUserAction(vanillaSteppingAction);
}

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

◆ 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

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

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

virtual void event ( void )

inlinevirtualinherited

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

This method can be implemented by subclasses.

Definition at line 157 of file Module.h.

157{};

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getAxis()

G4ThreeVector getAxis ( char name )

private

Return a vector along the axis with the given name.

Parameters

name	Name of the axis

Definition at line 577 of file MaterialScan.cc.

{
  switch (name) {
    case 'x': return G4ThreeVector(1, 0, 0);
    case 'y': return G4ThreeVector(0, 1, 0);
    case 'z': return G4ThreeVector(0, 0, 1);
    default:
      B2FATAL("Unknown axis: " << name);
  }
  return G4ThreeVector(0, 0, 0);
}

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize the output file and check the parameters.

Reimplemented from Module.

Definition at line 439 of file MaterialScan.cc.

{
  m_rootFile = TFile::Open(m_filename.c_str(), "RECREATE");
  if (!m_rootFile || m_rootFile->IsZombie()) {
    B2ERROR("Cannot open rootfile for writing" << LogVar("rootfile", m_filename));
    return;
  }
 
  boost::to_lower(m_planeName);
  boost::trim(m_planeName);
  //Check if plane definition makes sense
  if (m_planeName == "custom") {
    if (m_customPlane.size() < 9) {
      B2ERROR("planar.custom: At least 9 values needed to define custom plane, only " << m_customPlane.size() << " provided");
    }
  } else if (m_planeName.size() != 2 || !boost::all(m_planeName, boost::is_any_of("xyz"))) {
    B2ERROR("planar.plane: Only custom or any two letter combinations of X,Y and Z are recognized");
  } else if (m_planeName[0] == m_planeName[1]) {
    B2ERROR("planar.plane: " << m_planeName << " not valid, cannot use the same axis twice");
  }
 
  //Check if we have enough values to define the origin
  if (m_sphericalOrigin.size() < 3) {
    B2ERROR("spherical.origin: Three values are needed to define a point, only " << m_sphericalOrigin.size() << " given.");
  }
 
  //Convert plane definition to mm since Geant4 is of course using other units
  for (double& value : m_customPlane) value /= Unit::mm;
  for (double& value : m_sphericalOrigin) value /= Unit::mm;
  for (double& value : m_rayOrigin) value /= Unit::mm;
  if (m_rayDirection) {
    if (getParam<double>("ray.theta").isSetInSteering() || getParam<double>("ray.phi").isSetInSteering()) {
      B2ERROR("Cannot set ray.theta/ray.phi and ray.direction at the same time, please only set one");
      return;
    }
    for (double& value : *m_rayDirection) value /= Unit::mm;
  }
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

virtual void terminate ( void )

inlinevirtualinherited

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

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Definition at line 176 of file Module.h.

176{};

Member Data Documentation

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_customPlane

std::vector<double> m_customPlane

private

Custom plane definition if m_planName is "custom".

Definition at line 341 of file MaterialScan.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_doCosTheta

bool m_doCosTheta

private

Perform the spherical scan uniform in cos(theta) instead of theta.

Definition at line 367 of file MaterialScan.h.

◆ m_doPlanar

bool m_doPlanar

private

Wether or not to do a planar scan.

Definition at line 365 of file MaterialScan.h.

◆ m_doRay

bool m_doRay

private

Perform a material ray scan: scan along a certain direction with a given opening angle and plot material vs ray depth.

Definition at line 370 of file MaterialScan.h.

◆ m_doSpherical

bool m_doSpherical

private

Wether or not to do a spherical scan.

Definition at line 363 of file MaterialScan.h.

◆ m_filename

std::string m_filename

private

Filename for the ROOT output.

Definition at line 333 of file MaterialScan.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_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_planar

MaterialScan2D::ScanParams m_planar

private

Scan parameters for the planar scan.

Definition at line 339 of file MaterialScan.h.

◆ m_planeName

std::string m_planeName

private

Name of the plane to use for scanning.

Definition at line 335 of file MaterialScan.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_rayCount

unsigned int m_rayCount {0}

private

Number of rays to shoot (if opening angle is >0)

Definition at line 361 of file MaterialScan.h.

◆ m_rayDirection

std::optional<std::vector<double> > m_rayDirection

private

Direction of the ray, cannot be set at the same time as Theta and Phi.

Definition at line 349 of file MaterialScan.h.

◆ m_rayIgnoredMaterials

std::vector<std::string> m_rayIgnoredMaterials

private

Materials ignored when ray scanning.

Definition at line 347 of file MaterialScan.h.

◆ m_rayMaxDepth

double m_rayMaxDepth {1000}

private

Max depth of the ray before stopping.

Definition at line 359 of file MaterialScan.h.

◆ m_rayOpening

double m_rayOpening {0}

private

Opening angle of the ray.

Definition at line 355 of file MaterialScan.h.

◆ m_rayOrigin

std::vector<double> m_rayOrigin {0, 0, 0}

private

Origin of the ray if a ray scan is performed

Definition at line 345 of file MaterialScan.h.

◆ m_rayPhi

double m_rayPhi {0}

private

Phi direction of the ray if custom direction is not set.

Definition at line 353 of file MaterialScan.h.

◆ m_raySampleDepth

double m_raySampleDepth {0.1}

private

Sample depth of the ray: create one bin every x cm.

Definition at line 357 of file MaterialScan.h.

◆ m_raySplitByMaterials

bool m_raySplitByMaterials {false}

private

If true Split by materials instead of regions when doing ray scan.

Definition at line 372 of file MaterialScan.h.

◆ m_rayTheta

double m_rayTheta {0}

private

Theta direction of the ray if custom direction is not set.

Definition at line 351 of file MaterialScan.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_rootFile

TFile* m_rootFile

private

Pointer to the ROOT file for the histograms.

Definition at line 331 of file MaterialScan.h.

◆ m_spherical

MaterialScan2D::ScanParams m_spherical

private

Scan parameters for the spherical scan.

Definition at line 337 of file MaterialScan.h.

◆ m_sphericalOrigin

std::vector<double> m_sphericalOrigin

private

Origin for spherical scan.

Definition at line 343 of file MaterialScan.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.

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

simulation/modules/include/MaterialScan.h
simulation/modules/src/MaterialScan.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ MaterialScanModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getAxis()

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

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_conditions

◆ m_customPlane

◆ m_description

◆ m_doCosTheta

◆ m_doPlanar

◆ m_doRay

◆ m_doSpherical

◆ m_filename

◆ m_hasReturnValue

◆ m_logConfig

◆ m_moduleParamList

◆ m_name

◆ m_package

◆ m_planar