VRMLWriterModule Class Reference

The VRML-writer module. More...

#include <VRMLWriterModule.h>

Inheritance diagram for VRMLWriterModule:

Collaboration diagram for VRMLWriterModule:

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
	VRMLWriterModule ()
	Constructor of the module.
void	initialize () override
	Initialize at the start of a job.
void	event () override
	Called for each event: this runs the VRML writer only for the first event.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
virtual void	beginRun ()
	Called when entering a new run.
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
void	assignName (std::vector< std::string > *, unsigned int, const G4String &, int)
	Create unique and legal name for each solid.
void	describeSolid (G4VSolid *, const std::string &, bool)
	Emit VRML for each solid.
void	describeLogicalVolume (G4LogicalVolume *, const std::string &, const std::string &, bool)
	Emit VRML for each logical volume.
void	describePhysicalVolume (G4VPhysicalVolume *)
	Access next physical volume in the tree (recursive)
void	descendAndDescribe (G4VPhysicalVolume *, const std::string &, int)
	Emit VRML for a physical volume (recursive)
void	writePreamble (void)
	Emit VRML for the start of the file.
void	writePolyhedron (const G4Polyhedron *, const std::string &)
	Emit VRML for the solid's polyhedron.
void	writePhysicalVolume (const G4VPhysicalVolume *, const std::string &, const std::string &, bool)
	Emit VRML for each daughter of a logical volume.
HepPolyhedron *	getBooleanSolidPolyhedron (G4VSolid *)
	Create polyhedron for a boolean solid (recursive)
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
bool	m_First {true}
	Once-only flag to write VRML only on the first event.
std::string	m_Filename {"belle2.wrl"}
	User-specified output filename.
std::ofstream	m_File
	Output file.
std::vector< std::string > *	m_PVName {nullptr}
	Modified (legal-character and unique) physical-volume name.
std::vector< std::string > *	m_LVName {nullptr}
	Modified (legal-character and unique) logical-volume name.
std::vector< std::string > *	m_SolidName {nullptr}
	Modified (legal-character and unique) solid name.
std::vector< bool > *	m_IsCylinder {nullptr}
	Flag to indicate that a solid can be rendered as a VMRL cylinder.
std::vector< std::vector< int > > *	m_PVIndex {nullptr}
	Indices (in G4PhysicalVolumeStore) of the logical volume's physical-volume daughters.
std::vector< bool > *	m_LVWritten {nullptr}
	Flag to indicate that the logical volume has already been written.
std::vector< bool > *	m_PVWritten {nullptr}
	Flag to indicate that the physical volume has already been written.
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 VRML-writer module.

This module goes through all volumes of the Belle II detector geometry and write a VRML 2.0 file. Unlike the VRML writer in GEANT4, which creates a flat model, this writes the hierarchical model.

This module requires a valid geometry. Therefore, a geometry building module should have been executed before this module is called.

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

VRMLWriterModule()

VRMLWriterModule

(

)

Constructor of the module.

Definition at line 36 of file VRMLWriterModule.cc.

{
  //Set module properties and the description
  setDescription("Write the detector geometry in a hierarchical VRML format.");
 
  //Parameter definition
  addParam("outputFile", m_Filename, "Output filename", std::string("belle2.wrl"));
}

Member Function Documentation

assignName()

void assignName ( std::vector< std::string > *  names, unsigned int  index, const G4String &  originalName, int  select  )

private

Create unique and legal name for each solid.

Definition at line 126 of file VRMLWriterModule.cc.

{
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
 
  G4String name = originalName;
  if (name.length() == 0) { name = "anonymous"; }
  // Replace problematic characters with underscore (there may be more!)
  for (char c : " .,:;?'\"*+-=|^!/@#$\\%{}[]()<>") std::replace(name.begin(), name.end(), c, '_');
  // Avoid duplicate names for solids that will be written to VRML file
  for (int j = (int)index - 1; j >= 0; --j) {
    if ((*names)[j].length() == 0) continue;
    int match = 0;
    switch (select) {
      case 0:
        match = (*pvStore)[j]->GetName().compare((*pvStore)[index]->GetName()); break;
      case 1:
        match = (*lvStore)[j]->GetName().compare((*lvStore)[index]->GetName()); break;
      case 2:
        match = (*solidStore)[j]->GetName().compare((*solidStore)[index]->GetName()); break;
    }
    if (match == 0) {
      if (name.length() == (*names)[j].length()) {
        (*names)[j].append("_1");
      }
      int n = std::stoi((*names)[j].substr(name.length() + 1), nullptr);
      name.append("_");
      name.append(std::to_string(n + 1));
      break;
    }
  }
  (*names)[index] = name;
}

beginRun()

virtual void beginRun ( )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented in EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, CreateFieldMapModule, ExportGeometryModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, and PyModule.

Definition at line 147 of file Module.h.

{};

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

descendAndDescribe()

void descendAndDescribe ( G4VPhysicalVolume *  physVol, const std::string &  lvName, int  replica  )

private

Emit VRML for a physical volume (recursive)

Definition at line 423 of file VRMLWriterModule.cc.

{
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
 
  int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
  if ((*m_PVWritten)[pvIndex]) return;
 
  // Descend to the leaves of the tree
  G4LogicalVolume* logVol = physVol->GetLogicalVolume();
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
  for (size_t daughter = 0; daughter < logVol->GetNoDaughters(); ++daughter) {
    G4VPhysicalVolume* dPhysVol = logVol->GetDaughter(daughter);
    (*m_PVIndex)[lvIndex].push_back(std::find(pvStore->begin(), pvStore->end(), dPhysVol) - pvStore->begin());
    describePhysicalVolume(dPhysVol);
  }
  // Write out the physical volume and its corresponding logical volume as we ascend the recursive tree
  int solidIndex = std::find(solidStore->begin(), solidStore->end(), logVol->GetSolid()) - solidStore->begin();
  if (replica <= 0) describeLogicalVolume(logVol, lvName, (*m_SolidName)[solidIndex], (*m_IsCylinder)[solidIndex]);
}

describeLogicalVolume()

void describeLogicalVolume ( G4LogicalVolume *  logVol, const std::string &  lvName, const std::string &  solidName, bool  isCylinder  )

private

Emit VRML for each logical volume.

Definition at line 196 of file VRMLWriterModule.cc.

{
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
  if ((*m_LVWritten)[lvIndex]) return; // at most one PROTO in VRML for each logical volume
  (*m_LVWritten)[lvIndex] = true;
  G4Color color(0.0, 1.0, 0.0, 0.5); // default is semi-transparent green
  if ((lvName.compare(0, 23, "eclBarrelCrystalLogical") == 0) ||
      (lvName.compare(0, 20, "eclFwdCrystalLogical") == 0) ||
      (lvName.compare(0, 20, "eclBwdCrystalLogical") == 0)) {
    color = G4Color(1.0, 0.25, 0.0, 0.7); // orange since ECL crystals have no G4VisAttribute :(
  }
  std::string visible = "";
  G4String materialName = logVol->GetMaterial()->GetName();
  // Hide containers that have vacuum, air or gas
  if (materialName == "Vacuum") visible = "#";
  if (materialName == "G4_AIR") visible = "#";
  if (materialName == "CDCGas") visible = "#";
  if (materialName == "ColdAir") visible = "#";
  if (materialName == "STR-DryAir") visible = "#";
  if (materialName == "TOPAir") visible = "#";
  if (materialName == "TOPVacuum") visible = "#";
  const G4VisAttributes* visAttr = logVol->GetVisAttributes();
  if (visAttr) {
    color = const_cast<G4Color&>(logVol->GetVisAttributes()->GetColor());
    if (!(visAttr->IsVisible())) visible = "#";
  } else {
    visible = "#";
  }
  bool hasDaughters = (visible.length() == 0) || ((*m_PVIndex)[lvIndex].size() > 0);
  if (logVol->GetSensitiveDetector() != nullptr) visible = "";
  m_File << "# LogicalVolume " << logVol->GetName() << " containing " << materialName << std::endl <<
         "PROTO lv_" << lvName << " [ ] {" << std::endl <<
         " Group {" << std::endl <<
         "  " << (hasDaughters ? "" : "#") << "children [" << std::endl;
  if (isCylinder) {
    // VRML cylinder is along y axis but G4Tubs is along z axis => rotate here
    m_File << "   " << visible << "Transform {" << std::endl <<
           "   " << visible << " rotation 1 0 0 " << M_PI_2 << std::endl <<
           "   " << visible << " children [" << std::endl;
    visible.append("  ");
  }
  m_File << "   " << visible << "Shape {" << std::endl <<
         "   " << visible << " appearance Appearance {" << std::endl <<
         "   " << visible << "  material Material {" << std::endl <<
         "   " << visible << "   diffuseColor " << color.GetRed() << " " <<
         color.GetGreen() << " " <<
         color.GetBlue() << std::endl <<
         "   " << visible << "   " << (color.GetAlpha() == 1.0 ? "#" : "") <<
         "transparency " << 1.0 - color.GetAlpha() << std::endl <<
         "   " << visible << "  }" << std::endl <<
         "   " << visible << " }" << std::endl <<
         "   " << visible << " geometry solid_" << solidName << "{}" << std::endl <<
         "   " << visible << "}" << std::endl;
  if (isCylinder) {
    visible.resize(visible.length() - 2);
    m_File << "   " << visible << " ]" << std::endl <<
           "   " << visible << "}" << std::endl;
  }
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  for (int daughter : (*m_PVIndex)[lvIndex]) {
    G4VPhysicalVolume* physVol = (*pvStore)[daughter];
    std::string pvNameDaughter = (*m_PVName)[daughter];
    int lvDaughter = std::find(lvStore->begin(), lvStore->end(), physVol->GetLogicalVolume()) - lvStore->begin();
    std::string lvNameDaughter = (*m_LVName)[lvDaughter];
    if (physVol->IsReplicated()) {
      G4VSolid* solid = logVol->GetSolid();
      EAxis axis;
      G4int nReplicas;
      G4double width;
      G4double offset;
      G4bool consuming;
      physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
      G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
      if (physParameterisation) { // parameterised volume
        for (int replica = 0; replica < nReplicas; ++replica) {
          std::string pvNameReplica = pvNameDaughter;
          std::string lvNameReplica = lvNameDaughter;
          pvNameReplica.append("_");
          pvNameReplica.append(std::to_string(replica));
          physVol->SetCopyNo(replica);
          physParameterisation->ComputeTransformation(replica, physVol);
          G4VSolid* solidReplica = physParameterisation->ComputeSolid(replica, physVol);
          if (solidReplica != solid) { // not sure if this works ...
            lvNameReplica.append("_");
            lvNameReplica.append(std::to_string(replica));
          }
          writePhysicalVolume(physVol, pvNameReplica, lvNameReplica, false);
        }
      } else { // plain replicated volume
        G4ThreeVector originalTranslation = physVol->GetTranslation();
        G4RotationMatrix* originalRotation = physVol->GetRotation();
        for (int replica = 0; replica < nReplicas; ++replica) {
          G4ThreeVector translation; // No translation
          G4RotationMatrix rotation; // No rotation
          std::string pvNameReplica = pvNameDaughter;
          std::string lvNameReplica = lvNameDaughter;
          pvNameReplica.append("_");
          pvNameReplica.append(std::to_string(replica));
          physVol->SetCopyNo(replica);
          switch (axis) {
            default:
            case kXAxis:
              translation.setX(width * (replica - 0.5 * (nReplicas - 1)));
              physVol->SetTranslation(translation);
              break;
            case kYAxis:
              translation.setY(width * (replica - 0.5 * (nReplicas - 1)));
              physVol->SetTranslation(translation);
              break;
            case kZAxis:
              translation.setZ(width * (replica - 0.5 * (nReplicas - 1)));
              physVol->SetTranslation(translation);
              break;
            case kRho:
              if (solid->GetEntityType() == "G4Tubs") {
                lvNameReplica.append("_");
                lvNameReplica.append(std::to_string(replica));
              } else {
                B2WARNING("Built-in volumes replicated along radius for " << solid->GetEntityType() <<
                          " (solid " << solid->GetName() << ") are not visualisable.");
              }
              break;
            case kPhi:
              physVol->SetRotation(&(rotation.rotateZ(-(offset + (replica + 0.5) * width))));
              break;
          }
          writePhysicalVolume(physVol, pvNameReplica, lvNameReplica, false);
        }
        // Restore originals...
        physVol->SetTranslation(originalTranslation);
        physVol->SetRotation(originalRotation);
      }
    } else {
      writePhysicalVolume(physVol, pvNameDaughter, lvNameDaughter, (*m_PVWritten)[daughter]);
    }
    (*m_PVWritten)[daughter] = true;
  }
  G4VisExtent extent = logVol->GetSolid()->GetExtent();
  double xMin = extent.GetXmin();
  double xMax = extent.GetXmax();
  double yMin = extent.GetYmin();
  double yMax = extent.GetYmax();
  double zMin = extent.GetZmin();
  double zMax = extent.GetZmax();
  double xCenter = 0.5 * (xMin + xMax);
  double yCenter = 0.5 * (yMin + yMax);
  double zCenter = 0.5 * (zMin + zMax);
  bool atOrigin = (std::fabs(xCenter) + std::fabs(yCenter) + std::fabs(zCenter) > 1.0e-12);
  m_File << "  " << (hasDaughters ? "" : "#") << "]" << std::endl <<
         "  " << (atOrigin ? "" : "#") <<
         "bboxCenter " << xCenter << " " << yCenter << " " << zCenter << std::endl <<
         "  bboxSize " << xMax - xMin << " " <<
         (isCylinder ? zMax - zMin : yMax - yMin) << " " <<
         (isCylinder ? yMax - yMin : zMax - zMin) << std::endl <<
         " }" << std::endl <<
         "} # end of " << lvName << std::endl;
}

describePhysicalVolume()

void describePhysicalVolume ( G4VPhysicalVolume *  physVol )

private

Access next physical volume in the tree (recursive)

Definition at line 356 of file VRMLWriterModule.cc.

{
  G4LogicalVolume* logVol = physVol->GetLogicalVolume();
  G4VSolid* solid = logVol->GetSolid();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
  std::string lvName = (*m_LVName)[lvIndex];
  if (physVol->IsReplicated()) {
    G4SolidStore* solidStore = G4SolidStore::GetInstance();
    int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
    std::string solidName = (*m_SolidName)[solidIndex];
    EAxis axis;
    G4int nReplicas;
    G4double width;
    G4double offset;
    G4bool consuming;
    physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
    G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
    if (physParameterisation) { // user-parameterised volume
      for (int replica = 0; replica < nReplicas; ++replica) {
        std::string lvNameReplica = lvName;
        G4VSolid* solidReplica = physParameterisation->ComputeSolid(replica, physVol);
        if (solidReplica != solid) { // not sure if this works ...
          solidReplica->ComputeDimensions(physParameterisation, replica, physVol);
          std::string solidNameReplica = solidName;
          solidNameReplica.append("_");
          solidNameReplica.append(std::to_string(replica));
          lvNameReplica.append("_");
          lvNameReplica.append(std::to_string(replica));
          describeSolid(solidReplica, solidNameReplica, (*m_IsCylinder)[solidIndex]);
          describeLogicalVolume(logVol, lvNameReplica, solidNameReplica, (*m_IsCylinder)[solidIndex]);
        }
        descendAndDescribe(physVol, lvNameReplica, replica);
      }
    } else { // plain replicated volume - "divisions"
      for (int replica = 0; replica < nReplicas; ++replica) {
        if (axis == kRho) {
          if (solid->GetEntityType() == "G4Tubs") {
            double originalRMin = ((G4Tubs*)solid)->GetInnerRadius();
            double originalRMax = ((G4Tubs*)solid)->GetOuterRadius();
            ((G4Tubs*)solid)->SetInnerRadius(offset + width * replica);
            ((G4Tubs*)solid)->SetOuterRadius(offset + width * (replica + 1));
            std::string solidNameReplica = solidName;
            solidNameReplica.append("_");
            solidNameReplica.append(std::to_string(replica));
            std::string lvNameReplica = lvName;
            lvNameReplica.append("_");
            lvNameReplica.append(std::to_string(replica));
            describeSolid(solid, solidNameReplica, (*m_IsCylinder)[solidIndex]);
            ((G4Tubs*)solid)->SetInnerRadius(originalRMin);
            ((G4Tubs*)solid)->SetOuterRadius(originalRMax);
            describeLogicalVolume(logVol, lvNameReplica, solidNameReplica, (*m_IsCylinder)[solidIndex]);
            descendAndDescribe(physVol, lvNameReplica, replica);
          } else {
            B2WARNING("Built-in volumes replicated along radius for " << solid->GetEntityType() <<
                      " (solid " << solid->GetName() << ") are not visualisable.");
          }
        } else {
          descendAndDescribe(physVol, lvName, replica);
        }
      }
    }
  } else { // non-replicated volume
    descendAndDescribe(physVol, lvName, -1);
  }
}

describeSolid()

void describeSolid ( G4VSolid *  solid, const std::string &  solidName, bool  isCylinder  )

private

Emit VRML for each solid.

Definition at line 161 of file VRMLWriterModule.cc.

{
  m_File << "# Solid " << solid->GetName() << " of type " << solid->GetEntityType() << std::endl;
  if (isCylinder) {
    auto* tube = (G4Tubs*)solid;
    // VRML cylinder is along y axis but G4Tubs is along z axis => rotate in logical volume
    m_File << "PROTO solid_" << solidName << " [ ] {" << std::endl <<
           " Cylinder {" << std::endl << std::setprecision(10) <<
           "  radius " << tube->GetOuterRadius() << std::endl <<
           "  height " << tube->GetZHalfLength() * 2.0 << std::endl <<
           " }" << std::endl <<
           "}" << std::endl;
  } else if (solid->GetEntityType() == "G4Box") {
    auto* box = (G4Box*)solid;
    m_File << "PROTO solid_" << solidName << " [ ] {" << std::endl <<
           " Box {" << std::endl << std::setprecision(10) <<
           "  size " << box->GetXHalfLength() * 2.0 << " " <<
           box->GetYHalfLength() * 2.0 << " " <<
           box->GetZHalfLength() * 2.0 << std::endl <<
           " }" << std::endl <<
           "}" << std::endl;
  } else if ((solid->GetEntityType() == "G4IntersectionSolid") ||
             (solid->GetEntityType() == "G4UnionSolid") ||
             (solid->GetEntityType() == "G4SubtractionSolid") ||
             (solid->GetEntityType() == "G4BooleanSolid")) {
    HepPolyhedron* polyhedron = getBooleanSolidPolyhedron(solid);
    auto* g4polyhedron = new G4Polyhedron(*polyhedron);
    writePolyhedron(g4polyhedron, solidName);
    delete polyhedron;
    delete g4polyhedron;
  } else {
    writePolyhedron(solid->GetPolyhedron(), solidName);
  }
}

endRun()

virtual void endRun ( )

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.

Reimplemented in CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, AWESOMEBasicModule, and PyModule.

Definition at line 166 of file Module.h.

{};

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

overridevirtual

Called for each event: this runs the VRML writer only for the first event.

Reimplemented from Module.

Definition at line 50 of file VRMLWriterModule.cc.

{
  if (!m_First) return;
  m_First = false;
  G4VPhysicalVolume* topVol = geometry::GeometryManager::getInstance().getTopVolume();
  if (!topVol) {
    B2ERROR("No geometry found: add the Geometry module to the path before the VRMLWriter module.");
    return;
  }
  m_File.open(m_Filename, std::ios_base::trunc);
  writePreamble();
 
  G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  G4SolidStore* solidStore = G4SolidStore::GetInstance();
 
  m_PVName = new std::vector<std::string>(pvStore->size(), "");
  m_LVName = new std::vector<std::string>(lvStore->size(), "");
  m_SolidName = new std::vector<std::string>(solidStore->size(), "");
 
  // Assign legal and unique names to each used physical volume, logical volume and solid
  for (G4VPhysicalVolume* physVol : *pvStore) {
    int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
    if ((*m_PVName)[pvIndex].length() == 0)
      assignName(m_PVName, pvIndex, (*pvStore)[pvIndex]->GetName(), 0);
    G4LogicalVolume* logVol = physVol->GetLogicalVolume();
    int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
    if ((*m_LVName)[lvIndex].length() == 0)
      assignName(m_LVName, lvIndex, (*lvStore)[lvIndex]->GetName(), 1);
    G4VSolid* solid = logVol->GetSolid();
    int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
    if ((*m_SolidName)[solidIndex].length() == 0)
      assignName(m_SolidName, solidIndex, (*solidStore)[solidIndex]->GetName(), 2);
  }
 
  // Write all explicitly-referenced solids as PROTOs (replicas are written later)
  // Use implicit prefix "solid_" to avoid name clashes with logical- and physical-volume names
  m_IsCylinder = new std::vector<bool>(solidStore->size(), false);
  for (unsigned int solidIndex = 0; solidIndex < solidStore->size(); ++solidIndex) {
    if ((*m_SolidName)[solidIndex].length() != 0) {
      if ((*solidStore)[solidIndex]->GetEntityType() == "G4Tubs") {
        auto* tube = (G4Tubs*)((*solidStore)[solidIndex]);
        (*m_IsCylinder)[solidIndex] = ((tube->GetInnerRadius() == 0.0) && (tube->GetDeltaPhiAngle() == 2.0 * M_PI));
      }
      describeSolid((*solidStore)[solidIndex], (*m_SolidName)[solidIndex], (*m_IsCylinder)[solidIndex]);
    }
  }
 
  // Recursively write all physical volumes (as DEFs) and logical volumes (as PROTOs).
  // Deepest volumes are written first; top volume is written last. Use implicit prefix
  // "lv_" for logical-volume names to avoid name clashes with solid and physical-volume names.
  m_PVIndex = new std::vector<std::vector<int> >(lvStore->size(), std::vector<int>());
  m_LVWritten = new std::vector<bool>(lvStore->size(), false);
  m_PVWritten = new std::vector<bool>(pvStore->size(), false);
  describePhysicalVolume(topVol);
 
  // Now tell VRML to draw the top physical volume (and, recursively, all daughters)
  int pvIndex = std::find(pvStore->begin(), pvStore->end(), topVol) - pvStore->begin();
  int lvIndex = std::find(lvStore->begin(), lvStore->end(), topVol->GetLogicalVolume()) - lvStore->begin();
  m_File << "# PhysicalVolume " << topVol->GetName() << std::endl <<
         "DEF " << (*m_PVName)[pvIndex] << " Transform {" << std::endl <<
         " children lv_" << (*m_LVName)[lvIndex] << "{}" << std::endl <<
         "}" << std::endl;
  m_File.close();
  B2INFO("VRML written to " << m_Filename);
 
  delete m_PVName;
  delete m_LVName;
  delete m_SolidName;
  delete m_IsCylinder;
  delete m_PVIndex;
  delete m_LVWritten;
  delete m_PVWritten;
 
}

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

getBooleanSolidPolyhedron()

HepPolyhedron * getBooleanSolidPolyhedron ( G4VSolid *  solid )

private

Create polyhedron for a boolean solid (recursive)

Definition at line 568 of file VRMLWriterModule.cc.

{
  G4VSolid* solidA = solid->GetConstituentSolid(0);
  G4VSolid* solidB = solid->GetConstituentSolid(1);
  HepPolyhedron* polyhedronA = nullptr;
  if ((solidA->GetEntityType() == "G4IntersectionSolid") ||
      (solidA->GetEntityType() == "G4UnionSolid") ||
      (solidA->GetEntityType() == "G4SubtractionSolid") ||
      (solidA->GetEntityType() == "G4BooleanSolid")) {
    polyhedronA = getBooleanSolidPolyhedron(solidA);
  } else {
    polyhedronA = new HepPolyhedron(*(solidA->GetPolyhedron()));
  }
  HepPolyhedron* polyhedronB = nullptr;
  G4VSolid* solidB2 = solidB;
  if (solidB->GetEntityType() == "G4DisplacedSolid") {
    solidB2 = ((G4DisplacedSolid*)solidB)->GetConstituentMovedSolid();
  }
  if ((solidB2->GetEntityType() == "G4IntersectionSolid") ||
      (solidB2->GetEntityType() == "G4UnionSolid") ||
      (solidB2->GetEntityType() == "G4SubtractionSolid") ||
      (solidB2->GetEntityType() == "G4BooleanSolid")) {
    polyhedronB = getBooleanSolidPolyhedron(solidB2);
    if (solidB != solidB2) { // was solidB a G4DisplacedSolid?
      polyhedronB->Transform(G4Transform3D(
                               ((G4DisplacedSolid*)solidB)->GetObjectRotation(),
                               ((G4DisplacedSolid*)solidB)->GetObjectTranslation()));
    }
  } else {
    polyhedronB = new HepPolyhedron(*(solidB->GetPolyhedron()));
  }
  auto* result = new HepPolyhedron();
  if (solid->GetEntityType() == "G4UnionSolid") {
    *result = polyhedronA->add(*polyhedronB);
  } else if (solid->GetEntityType() == "G4SubtractionSolid") {
    *result = polyhedronA->subtract(*polyhedronB);
  } else if (solid->GetEntityType() == "G4IntersectionSolid") {
    *result = polyhedronA->intersect(*polyhedronB);
  } else {
    B2WARNING("getBooleanSolidPolyhedron(): Unrecognized boolean solid " << solid->GetName() <<
              " of type " << solid->GetEntityType());
  }
  delete polyhedronA;
  delete polyhedronB;
  return result;
}

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

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

overridevirtual

Initialize at the start of a job.

Reimplemented from Module.

Definition at line 45 of file VRMLWriterModule.cc.

{
  m_First = true;
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

terminate()

virtual void terminate ( )

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.

Reimplemented in CurlTaggerModule, EventKinematicsModule, FlavorTaggerInfoFillerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleKinematicFitterModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, RemoveParticlesNotInListsModule, SkimFilterModule, TreeFitterModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, MergeDataStoreModule, SubEventModule, SwitchDataStoreModule, ProgressBarModule, RandomBarrierModule, HistoManagerModule, ProfileModule, RootInputModule, RootOutputModule, SeqRootInputModule, SeqRootOutputModule, AsyncWrapper, RxModule, TxModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, ZMQTxWorkerModule, GeometryModule, MVAExpertModule, MVAMultipleExpertsModule, AWESOMEBasicModule, and PyModule.

Definition at line 176 of file Module.h.

{};

writePhysicalVolume()

void writePhysicalVolume ( const G4VPhysicalVolume *  physVol, const std::string &  pvName, const std::string &  lvName, bool  written  )

private

Emit VRML for each daughter of a logical volume.

Definition at line 516 of file VRMLWriterModule.cc.

{
  if (written) {
    m_File << "   USE " << pvName << std::endl; // this never happens, as it turns out
  } else {
    m_File << "   # PhysicalVolume " << physVol->GetName() << " copy " << physVol->GetCopyNo() << std::endl <<
           "   DEF " << pvName << " Transform {" << std::endl; // DEF provides object name when importing VRML into Unity
    G4RotationMatrix* rot = physVol->GetObjectRotation();
    G4ThreeVector move = physVol->GetObjectTranslation();
    double yaw = std::atan2(rot->yx(), rot->xx());
    double pitch = -std::asin(rot->zx());
    double roll = std::atan2(rot->zy(), rot->zz());
    std::cout << physVol->GetName() << " translation: " << move.x() << "," << move.y() << "," << move.z() << std::endl;
    std::cout << physVol->GetName() << " rotation: " << yaw * 180.0 / M_PI << "," << pitch * 180.0 / M_PI << "," << roll * 180.0 / M_PI
              << std::endl;
    if (move.mag2() != 0.0) {
      m_File << "    translation " << std::setprecision(10) <<
             move.x() << " " << move.y() << " " << move.z() << std::endl;
    }
    if (!(rot->isIdentity())) {
      double trace = std::max(-1.0, std::min(3.0, rot->xx() + rot->yy() + rot->zz()));
      double angle = std::acos(0.5 * (trace - 1.0));
      G4ThreeVector rotA(rot->zy() - rot->yz(), rot->xz() - rot->zx(), rot->yx() - rot->xy());
      if ((rotA.x() == 0.0) && (rotA.y() == 0.0) && (rotA.z() == 0.0)) {
        // The assignment along x, y or z axis in Hep3Vector::axis() is wrong. The proper axis of
        // rotation is given by kernel(r - I), which is the cross product of two non-proportional rows
        if (rot->xx() > 0.0) {
          rotA.setX((rot->yy() - 1.0) * (rot->zz() - 1.0) -  rot->yz()        *  rot->zy());
          rotA.setY(rot->yz()        *  rot->zx()        -  rot->yx()        * (rot->zz() - 1.0));
          rotA.setZ(rot->yx()        *  rot->zy()        -  rot->zx()        * (rot->yy() - 1.0));
        } else if (rot->yy() > 0.0) {
          rotA.setX(rot->xy()        * (rot->zz() - 1.0) -  rot->xz()        *  rot->zy());
          rotA.setY(rot->xz()        *  rot->zx()        - (rot->xx() - 1.0) * (rot->zz() - 1.0));
          rotA.setZ((rot->xx() - 1.0) *  rot->zy()        -  rot->xy()        *  rot->zx());
        } else {
          rotA.setX(rot->xy()        *  rot->yz()        -  rot->xz()        * (rot->yy() - 1.0));
          rotA.setY(rot->xz()        *  rot->yx()        -  rot->yz()        * (rot->xx() - 1.0));
          rotA.setZ((rot->xx() - 1.0) * (rot->yy() - 1.0) -  rot->xy()        *  rot->yx());
        }
      }
      rotA.setMag(1.0);
      m_File << "    rotation " << std::setprecision(10) <<
             rotA.x() << " " << rotA.y() << " " << rotA.z() << " " << angle << std::endl;
    }
    m_File << "    children lv_" << lvName << "{}" << std::endl <<
           "   }" << std::endl;
  }
}

writePolyhedron()

void writePolyhedron ( const G4Polyhedron *  polyhedron, const std::string &  name  )

private

Emit VRML for the solid's polyhedron.

Definition at line 483 of file VRMLWriterModule.cc.

{
  if (polyhedron) {
    m_File << "PROTO solid_" << name << " [ ] {" << std::endl <<
           " IndexedFaceSet {" << std::endl <<
           "  coord Coordinate {" << std::endl <<
           "   point [" << std::endl;
    for (int j = 1; j <= polyhedron->GetNoVertices(); ++j) {
      m_File << "    " << polyhedron->GetVertex(j).x() << " " <<
             polyhedron->GetVertex(j).y() << " " <<
             polyhedron->GetVertex(j).z() << std::endl;
    }
    m_File << "   ]" << std::endl <<
           "  }" << std::endl <<
           "  coordIndex [" << std::endl;
    for (int j = 0; j < polyhedron->GetNoFacets(); ++j) {
      G4bool notLastEdge = true;
      G4int ndx = -1, edgeFlag = 1;
      m_File << "   ";
      do {
        notLastEdge = polyhedron->GetNextVertexIndex(ndx, edgeFlag);
        m_File << " " << ndx - 1;
      } while (notLastEdge);
      m_File << " -1" << std::endl;
    }
    m_File << "  ]" << std::endl <<
           " }" << std::endl <<
           "}" << std::endl;
  } else {
    B2INFO("Polyhedron representation of solid " << name << " cannot be created");
  }
}

writePreamble()

void writePreamble ( void  )

private

Emit VRML for the start of the file.

Definition at line 445 of file VRMLWriterModule.cc.

{
  m_File << "#VRML V2.0 utf8" << std::endl << std::endl <<
         "WorldInfo {" << std::endl <<
         "  info [ \"(c) The Belle II Collaboration\" ]" << std::endl <<
         "  title \"The Belle II Detector\"" << std::endl <<
         "}" << std::endl <<
         "Viewpoint {" << std::endl <<
         " position 0 0 15000" << std::endl <<
         " description \"front\"" << std::endl <<
         "}" << std::endl <<
         "Viewpoint {" << std::endl <<
         " position 0 0 -15000" << std::endl <<
         " orientation 0 1 0 3.141593" << std::endl <<
         " description \"back\"" << std::endl <<
         "}" << std::endl <<
         "Viewpoint {" << std::endl <<
         " position 0 15000 0" << std::endl <<
         " orientation 1 0 0 -1.570796" << std::endl <<
         " description \"top\"" << std::endl <<
         "}" << std::endl <<
         "Viewpoint {" << std::endl <<
         " position 0 -15000 0" << std::endl <<
         " orientation 1 0 0 1.570796" << std::endl <<
         " description \"bottom\"" << std::endl <<
         "}" << std::endl <<
         "Viewpoint {" << std::endl <<
         " position 15000 0 0" << std::endl <<
         " orientation 0 1 0 1.570796" << std::endl <<
         " description \"right\"" << std::endl <<
         "}" << std::endl <<
         "Viewpoint {" << std::endl <<
         " position -15000 0 0" << std::endl <<
         " orientation 0 1 0 -1.570796" << std::endl <<
         " description \"left\"" << std::endl <<
         "}" << std::endl;
}

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_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_File

std::ofstream m_File

private

Output file.

Definition at line 90 of file VRMLWriterModule.h.

m_Filename

std::string m_Filename {"belle2.wrl"}

private

User-specified output filename.

Definition at line 87 of file VRMLWriterModule.h.

m_First

bool m_First {true}

private

Once-only flag to write VRML only on the first event.

Definition at line 84 of file VRMLWriterModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_IsCylinder

std::vector<bool>* m_IsCylinder {nullptr}

private

Flag to indicate that a solid can be rendered as a VMRL cylinder.

Definition at line 102 of file VRMLWriterModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_LVName

std::vector<std::string>* m_LVName {nullptr}

private

Modified (legal-character and unique) logical-volume name.

Definition at line 96 of file VRMLWriterModule.h.

m_LVWritten

std::vector<bool>* m_LVWritten {nullptr}

private

Flag to indicate that the logical volume has already been written.

Definition at line 108 of file VRMLWriterModule.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_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_PVIndex

std::vector<std::vector<int> >* m_PVIndex {nullptr}

private

Indices (in G4PhysicalVolumeStore) of the logical volume's physical-volume daughters.

Definition at line 105 of file VRMLWriterModule.h.

m_PVName

std::vector<std::string>* m_PVName {nullptr}

private

Modified (legal-character and unique) physical-volume name.

Definition at line 93 of file VRMLWriterModule.h.

m_PVWritten

std::vector<bool>* m_PVWritten {nullptr}

private

Flag to indicate that the physical volume has already been written.

Definition at line 111 of file VRMLWriterModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_SolidName

std::vector<std::string>* m_SolidName {nullptr}

private

Modified (legal-character and unique) solid name.

Definition at line 99 of file VRMLWriterModule.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:

• geometry/modules/vrmlWriter/include/VRMLWriterModule.h
• geometry/modules/vrmlWriter/src/VRMLWriterModule.cc