Belle II Software light-2406-ragdoll
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.
 
LogConfiggetLogConfig ()
 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 ModuleConditiongetCondition () 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< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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< ModulePtrgetModules () 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< ModuleConditionm_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

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.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ VRMLWriterModule()

Constructor of the module.

Definition at line 36 of file VRMLWriterModule.cc.

37{
38 //Set module properties and the description
39 setDescription("Write the detector geometry in a hierarchical VRML format.");
40
41 //Parameter definition
42 addParam("outputFile", m_Filename, "Output filename", std::string("belle2.wrl"));
43}
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
std::string m_Filename
User-specified output filename.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

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.

127{
128 G4SolidStore* solidStore = G4SolidStore::GetInstance();
129 G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
130 G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
131
132 G4String name = originalName;
133 if (name.length() == 0) { name = "anonymous"; }
134 // Replace problematic characters with underscore (there may be more!)
135 for (char c : " .,:;?'\"*+-=|^!/@#$\\%{}[]()<>") std::replace(name.begin(), name.end(), c, '_');
136 // Avoid duplicate names for solids that will be written to VRML file
137 for (int j = (int)index - 1; j >= 0; --j) {
138 if ((*names)[j].length() == 0) continue;
139 int match = 0;
140 switch (select) {
141 case 0:
142 match = (*pvStore)[j]->GetName().compare((*pvStore)[index]->GetName()); break;
143 case 1:
144 match = (*lvStore)[j]->GetName().compare((*lvStore)[index]->GetName()); break;
145 case 2:
146 match = (*solidStore)[j]->GetName().compare((*solidStore)[index]->GetName()); break;
147 }
148 if (match == 0) {
149 if (name.length() == (*names)[j].length()) {
150 (*names)[j].append("_1");
151 }
152 int n = std::stoi((*names)[j].substr(name.length() + 1), nullptr);
153 name.append("_");
154 name.append(std::to_string(n + 1));
155 break;
156 }
157 }
158 (*names)[index] = name;
159}

◆ beginRun()

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

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ 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(); }
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(); }
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(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }
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(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

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

424{
425 G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
426 G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
427 G4SolidStore* solidStore = G4SolidStore::GetInstance();
428
429 int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
430 if ((*m_PVWritten)[pvIndex]) return;
431
432 // Descend to the leaves of the tree
433 G4LogicalVolume* logVol = physVol->GetLogicalVolume();
434 int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
435 for (size_t daughter = 0; daughter < logVol->GetNoDaughters(); ++daughter) {
436 G4VPhysicalVolume* dPhysVol = logVol->GetDaughter(daughter);
437 (*m_PVIndex)[lvIndex].push_back(std::find(pvStore->begin(), pvStore->end(), dPhysVol) - pvStore->begin());
438 describePhysicalVolume(dPhysVol);
439 }
440 // Write out the physical volume and its corresponding logical volume as we ascend the recursive tree
441 int solidIndex = std::find(solidStore->begin(), solidStore->end(), logVol->GetSolid()) - solidStore->begin();
442 if (replica <= 0) describeLogicalVolume(logVol, lvName, (*m_SolidName)[solidIndex], (*m_IsCylinder)[solidIndex]);
443}
std::vector< bool > * m_IsCylinder
Flag to indicate that a solid can be rendered as a VMRL cylinder.
std::vector< bool > * m_PVWritten
Flag to indicate that the physical volume has already been written.
std::vector< std::string > * m_SolidName
Modified (legal-character and unique) solid name.
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)

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

198{
199 G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
200 int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
201 if ((*m_LVWritten)[lvIndex]) return; // at most one PROTO in VRML for each logical volume
202 (*m_LVWritten)[lvIndex] = true;
203 G4Color color(0.0, 1.0, 0.0, 0.5); // default is semi-transparent green
204 if ((lvName.compare(0, 23, "eclBarrelCrystalLogical") == 0) ||
205 (lvName.compare(0, 20, "eclFwdCrystalLogical") == 0) ||
206 (lvName.compare(0, 20, "eclBwdCrystalLogical") == 0)) {
207 color = G4Color(1.0, 0.25, 0.0, 0.7); // orange since ECL crystals have no G4VisAttribute :(
208 }
209 std::string visible = "";
210 G4String materialName = logVol->GetMaterial()->GetName();
211 // Hide containers that have vacuum, air or gas
212 if (materialName == "Vacuum") visible = "#";
213 if (materialName == "G4_AIR") visible = "#";
214 if (materialName == "CDCGas") visible = "#";
215 if (materialName == "ColdAir") visible = "#";
216 if (materialName == "STR-DryAir") visible = "#";
217 if (materialName == "TOPAir") visible = "#";
218 if (materialName == "TOPVacuum") visible = "#";
219 const G4VisAttributes* visAttr = logVol->GetVisAttributes();
220 if (visAttr) {
221 color = const_cast<G4Color&>(logVol->GetVisAttributes()->GetColor());
222 if (!(visAttr->IsVisible())) visible = "#";
223 } else {
224 visible = "#";
225 }
226 bool hasDaughters = (visible.length() == 0) || ((*m_PVIndex)[lvIndex].size() > 0);
227 if (logVol->GetSensitiveDetector() != nullptr) visible = "";
228 m_File << "# LogicalVolume " << logVol->GetName() << " containing " << materialName << std::endl <<
229 "PROTO lv_" << lvName << " [ ] {" << std::endl <<
230 " Group {" << std::endl <<
231 " " << (hasDaughters ? "" : "#") << "children [" << std::endl;
232 if (isCylinder) {
233 // VRML cylinder is along y axis but G4Tubs is along z axis => rotate here
234 m_File << " " << visible << "Transform {" << std::endl <<
235 " " << visible << " rotation 1 0 0 " << M_PI_2 << std::endl <<
236 " " << visible << " children [" << std::endl;
237 visible.append(" ");
238 }
239 m_File << " " << visible << "Shape {" << std::endl <<
240 " " << visible << " appearance Appearance {" << std::endl <<
241 " " << visible << " material Material {" << std::endl <<
242 " " << visible << " diffuseColor " << color.GetRed() << " " <<
243 color.GetGreen() << " " <<
244 color.GetBlue() << std::endl <<
245 " " << visible << " " << (color.GetAlpha() == 1.0 ? "#" : "") <<
246 "transparency " << 1.0 - color.GetAlpha() << std::endl <<
247 " " << visible << " }" << std::endl <<
248 " " << visible << " }" << std::endl <<
249 " " << visible << " geometry solid_" << solidName << "{}" << std::endl <<
250 " " << visible << "}" << std::endl;
251 if (isCylinder) {
252 visible.resize(visible.length() - 2);
253 m_File << " " << visible << " ]" << std::endl <<
254 " " << visible << "}" << std::endl;
255 }
256 G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
257 for (int daughter : (*m_PVIndex)[lvIndex]) {
258 G4VPhysicalVolume* physVol = (*pvStore)[daughter];
259 std::string pvNameDaughter = (*m_PVName)[daughter];
260 int lvDaughter = std::find(lvStore->begin(), lvStore->end(), physVol->GetLogicalVolume()) - lvStore->begin();
261 std::string lvNameDaughter = (*m_LVName)[lvDaughter];
262 if (physVol->IsReplicated()) {
263 G4VSolid* solid = logVol->GetSolid();
264 EAxis axis;
265 G4int nReplicas;
266 G4double width;
267 G4double offset;
268 G4bool consuming;
269 physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
270 G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
271 if (physParameterisation) { // parameterised volume
272 for (int replica = 0; replica < nReplicas; ++replica) {
273 std::string pvNameReplica = pvNameDaughter;
274 std::string lvNameReplica = lvNameDaughter;
275 pvNameReplica.append("_");
276 pvNameReplica.append(std::to_string(replica));
277 physVol->SetCopyNo(replica);
278 physParameterisation->ComputeTransformation(replica, physVol);
279 G4VSolid* solidReplica = physParameterisation->ComputeSolid(replica, physVol);
280 if (solidReplica != solid) { // not sure if this works ...
281 lvNameReplica.append("_");
282 lvNameReplica.append(std::to_string(replica));
283 }
284 writePhysicalVolume(physVol, pvNameReplica, lvNameReplica, false);
285 }
286 } else { // plain replicated volume
287 G4ThreeVector originalTranslation = physVol->GetTranslation();
288 G4RotationMatrix* originalRotation = physVol->GetRotation();
289 for (int replica = 0; replica < nReplicas; ++replica) {
290 G4ThreeVector translation; // No translation
291 G4RotationMatrix rotation; // No rotation
292 std::string pvNameReplica = pvNameDaughter;
293 std::string lvNameReplica = lvNameDaughter;
294 pvNameReplica.append("_");
295 pvNameReplica.append(std::to_string(replica));
296 physVol->SetCopyNo(replica);
297 switch (axis) {
298 default:
299 case kXAxis:
300 translation.setX(width * (replica - 0.5 * (nReplicas - 1)));
301 physVol->SetTranslation(translation);
302 break;
303 case kYAxis:
304 translation.setY(width * (replica - 0.5 * (nReplicas - 1)));
305 physVol->SetTranslation(translation);
306 break;
307 case kZAxis:
308 translation.setZ(width * (replica - 0.5 * (nReplicas - 1)));
309 physVol->SetTranslation(translation);
310 break;
311 case kRho:
312 if (solid->GetEntityType() == "G4Tubs") {
313 lvNameReplica.append("_");
314 lvNameReplica.append(std::to_string(replica));
315 } else {
316 B2WARNING("Built-in volumes replicated along radius for " << solid->GetEntityType() <<
317 " (solid " << solid->GetName() << ") are not visualisable.");
318 }
319 break;
320 case kPhi:
321 physVol->SetRotation(&(rotation.rotateZ(-(offset + (replica + 0.5) * width))));
322 break;
323 }
324 writePhysicalVolume(physVol, pvNameReplica, lvNameReplica, false);
325 }
326 // Restore originals...
327 physVol->SetTranslation(originalTranslation);
328 physVol->SetRotation(originalRotation);
329 }
330 } else {
331 writePhysicalVolume(physVol, pvNameDaughter, lvNameDaughter, (*m_PVWritten)[daughter]);
332 }
333 (*m_PVWritten)[daughter] = true;
334 }
335 G4VisExtent extent = logVol->GetSolid()->GetExtent();
336 double xMin = extent.GetXmin();
337 double xMax = extent.GetXmax();
338 double yMin = extent.GetYmin();
339 double yMax = extent.GetYmax();
340 double zMin = extent.GetZmin();
341 double zMax = extent.GetZmax();
342 double xCenter = 0.5 * (xMin + xMax);
343 double yCenter = 0.5 * (yMin + yMax);
344 double zCenter = 0.5 * (zMin + zMax);
345 bool atOrigin = (std::fabs(xCenter) + std::fabs(yCenter) + std::fabs(zCenter) > 1.0e-12);
346 m_File << " " << (hasDaughters ? "" : "#") << "]" << std::endl <<
347 " " << (atOrigin ? "" : "#") <<
348 "bboxCenter " << xCenter << " " << yCenter << " " << zCenter << std::endl <<
349 " bboxSize " << xMax - xMin << " " <<
350 (isCylinder ? zMax - zMin : yMax - yMin) << " " <<
351 (isCylinder ? yMax - yMin : zMax - zMin) << std::endl <<
352 " }" << std::endl <<
353 "} # end of " << lvName << std::endl;
354}
void writePhysicalVolume(const G4VPhysicalVolume *, const std::string &, const std::string &, bool)
Emit VRML for each daughter of a logical volume.
std::ofstream m_File
Output file.
std::vector< std::vector< int > > * m_PVIndex
Indices (in G4PhysicalVolumeStore) of the logical volume's physical-volume daughters.
std::vector< bool > * m_LVWritten
Flag to indicate that the logical volume has already been written.

◆ describePhysicalVolume()

void describePhysicalVolume ( G4VPhysicalVolume *  physVol)
private

Access next physical volume in the tree (recursive)

Definition at line 356 of file VRMLWriterModule.cc.

357{
358 G4LogicalVolume* logVol = physVol->GetLogicalVolume();
359 G4VSolid* solid = logVol->GetSolid();
360 G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
361 int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
362 std::string lvName = (*m_LVName)[lvIndex];
363 if (physVol->IsReplicated()) {
364 G4SolidStore* solidStore = G4SolidStore::GetInstance();
365 int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
366 std::string solidName = (*m_SolidName)[solidIndex];
367 EAxis axis;
368 G4int nReplicas;
369 G4double width;
370 G4double offset;
371 G4bool consuming;
372 physVol->GetReplicationData(axis, nReplicas, width, offset, consuming);
373 G4VPVParameterisation* physParameterisation = physVol->GetParameterisation();
374 if (physParameterisation) { // user-parameterised volume
375 for (int replica = 0; replica < nReplicas; ++replica) {
376 std::string lvNameReplica = lvName;
377 G4VSolid* solidReplica = physParameterisation->ComputeSolid(replica, physVol);
378 if (solidReplica != solid) { // not sure if this works ...
379 solidReplica->ComputeDimensions(physParameterisation, replica, physVol);
380 std::string solidNameReplica = solidName;
381 solidNameReplica.append("_");
382 solidNameReplica.append(std::to_string(replica));
383 lvNameReplica.append("_");
384 lvNameReplica.append(std::to_string(replica));
385 describeSolid(solidReplica, solidNameReplica, (*m_IsCylinder)[solidIndex]);
386 describeLogicalVolume(logVol, lvNameReplica, solidNameReplica, (*m_IsCylinder)[solidIndex]);
387 }
388 descendAndDescribe(physVol, lvNameReplica, replica);
389 }
390 } else { // plain replicated volume - "divisions"
391 for (int replica = 0; replica < nReplicas; ++replica) {
392 if (axis == kRho) {
393 if (solid->GetEntityType() == "G4Tubs") {
394 double originalRMin = ((G4Tubs*)solid)->GetInnerRadius();
395 double originalRMax = ((G4Tubs*)solid)->GetOuterRadius();
396 ((G4Tubs*)solid)->SetInnerRadius(offset + width * replica);
397 ((G4Tubs*)solid)->SetOuterRadius(offset + width * (replica + 1));
398 std::string solidNameReplica = solidName;
399 solidNameReplica.append("_");
400 solidNameReplica.append(std::to_string(replica));
401 std::string lvNameReplica = lvName;
402 lvNameReplica.append("_");
403 lvNameReplica.append(std::to_string(replica));
404 describeSolid(solid, solidNameReplica, (*m_IsCylinder)[solidIndex]);
405 ((G4Tubs*)solid)->SetInnerRadius(originalRMin);
406 ((G4Tubs*)solid)->SetOuterRadius(originalRMax);
407 describeLogicalVolume(logVol, lvNameReplica, solidNameReplica, (*m_IsCylinder)[solidIndex]);
408 descendAndDescribe(physVol, lvNameReplica, replica);
409 } else {
410 B2WARNING("Built-in volumes replicated along radius for " << solid->GetEntityType() <<
411 " (solid " << solid->GetName() << ") are not visualisable.");
412 }
413 } else {
414 descendAndDescribe(physVol, lvName, replica);
415 }
416 }
417 }
418 } else { // non-replicated volume
419 descendAndDescribe(physVol, lvName, -1);
420 }
421}
void describeSolid(G4VSolid *, const std::string &, bool)
Emit VRML for each solid.
void descendAndDescribe(G4VPhysicalVolume *, const std::string &, int)
Emit VRML for a physical volume (recursive)

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

162{
163 m_File << "# Solid " << solid->GetName() << " of type " << solid->GetEntityType() << std::endl;
164 if (isCylinder) {
165 auto* tube = (G4Tubs*)solid;
166 // VRML cylinder is along y axis but G4Tubs is along z axis => rotate in logical volume
167 m_File << "PROTO solid_" << solidName << " [ ] {" << std::endl <<
168 " Cylinder {" << std::endl << std::setprecision(10) <<
169 " radius " << tube->GetOuterRadius() << std::endl <<
170 " height " << tube->GetZHalfLength() * 2.0 << std::endl <<
171 " }" << std::endl <<
172 "}" << std::endl;
173 } else if (solid->GetEntityType() == "G4Box") {
174 auto* box = (G4Box*)solid;
175 m_File << "PROTO solid_" << solidName << " [ ] {" << std::endl <<
176 " Box {" << std::endl << std::setprecision(10) <<
177 " size " << box->GetXHalfLength() * 2.0 << " " <<
178 box->GetYHalfLength() * 2.0 << " " <<
179 box->GetZHalfLength() * 2.0 << std::endl <<
180 " }" << std::endl <<
181 "}" << std::endl;
182 } else if ((solid->GetEntityType() == "G4IntersectionSolid") ||
183 (solid->GetEntityType() == "G4UnionSolid") ||
184 (solid->GetEntityType() == "G4SubtractionSolid") ||
185 (solid->GetEntityType() == "G4BooleanSolid")) {
186 HepPolyhedron* polyhedron = getBooleanSolidPolyhedron(solid);
187 auto* g4polyhedron = new G4Polyhedron(*polyhedron);
188 writePolyhedron(g4polyhedron, solidName);
189 delete polyhedron;
190 delete g4polyhedron;
191 } else {
192 writePolyhedron(solid->GetPolyhedron(), solidName);
193 }
194}
void writePolyhedron(const G4Polyhedron *, const std::string &)
Emit VRML for the solid's polyhedron.
HepPolyhedron * getBooleanSolidPolyhedron(G4VSolid *)
Create polyhedron for a boolean solid (recursive)

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

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

51{
52 if (!m_First) return;
53 m_First = false;
54 G4VPhysicalVolume* topVol = geometry::GeometryManager::getInstance().getTopVolume();
55 if (!topVol) {
56 B2ERROR("No geometry found: add the Geometry module to the path before the VRMLWriter module.");
57 return;
58 }
59 m_File.open(m_Filename, std::ios_base::trunc);
61
62 G4PhysicalVolumeStore* pvStore = G4PhysicalVolumeStore::GetInstance();
63 G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
64 G4SolidStore* solidStore = G4SolidStore::GetInstance();
65
66 m_PVName = new std::vector<std::string>(pvStore->size(), "");
67 m_LVName = new std::vector<std::string>(lvStore->size(), "");
68 m_SolidName = new std::vector<std::string>(solidStore->size(), "");
69
70 // Assign legal and unique names to each used physical volume, logical volume and solid
71 for (G4VPhysicalVolume* physVol : *pvStore) {
72 int pvIndex = std::find(pvStore->begin(), pvStore->end(), physVol) - pvStore->begin();
73 if ((*m_PVName)[pvIndex].length() == 0)
74 assignName(m_PVName, pvIndex, (*pvStore)[pvIndex]->GetName(), 0);
75 G4LogicalVolume* logVol = physVol->GetLogicalVolume();
76 int lvIndex = std::find(lvStore->begin(), lvStore->end(), logVol) - lvStore->begin();
77 if ((*m_LVName)[lvIndex].length() == 0)
78 assignName(m_LVName, lvIndex, (*lvStore)[lvIndex]->GetName(), 1);
79 G4VSolid* solid = logVol->GetSolid();
80 int solidIndex = std::find(solidStore->begin(), solidStore->end(), solid) - solidStore->begin();
81 if ((*m_SolidName)[solidIndex].length() == 0)
82 assignName(m_SolidName, solidIndex, (*solidStore)[solidIndex]->GetName(), 2);
83 }
84
85 // Write all explicitly-referenced solids as PROTOs (replicas are written later)
86 // Use implicit prefix "solid_" to avoid name clashes with logical- and physical-volume names
87 m_IsCylinder = new std::vector<bool>(solidStore->size(), false);
88 for (unsigned int solidIndex = 0; solidIndex < solidStore->size(); ++solidIndex) {
89 if ((*m_SolidName)[solidIndex].length() != 0) {
90 if ((*solidStore)[solidIndex]->GetEntityType() == "G4Tubs") {
91 auto* tube = (G4Tubs*)((*solidStore)[solidIndex]);
92 (*m_IsCylinder)[solidIndex] = ((tube->GetInnerRadius() == 0.0) && (tube->GetDeltaPhiAngle() == 2.0 * M_PI));
93 }
94 describeSolid((*solidStore)[solidIndex], (*m_SolidName)[solidIndex], (*m_IsCylinder)[solidIndex]);
95 }
96 }
97
98 // Recursively write all physical volumes (as DEFs) and logical volumes (as PROTOs).
99 // Deepest volumes are written first; top volume is written last. Use implicit prefix
100 // "lv_" for logical-volume names to avoid name clashes with solid and physical-volume names.
101 m_PVIndex = new std::vector<std::vector<int> >(lvStore->size(), std::vector<int>());
102 m_LVWritten = new std::vector<bool>(lvStore->size(), false);
103 m_PVWritten = new std::vector<bool>(pvStore->size(), false);
105
106 // Now tell VRML to draw the top physical volume (and, recursively, all daughters)
107 int pvIndex = std::find(pvStore->begin(), pvStore->end(), topVol) - pvStore->begin();
108 int lvIndex = std::find(lvStore->begin(), lvStore->end(), topVol->GetLogicalVolume()) - lvStore->begin();
109 m_File << "# PhysicalVolume " << topVol->GetName() << std::endl <<
110 "DEF " << (*m_PVName)[pvIndex] << " Transform {" << std::endl <<
111 " children lv_" << (*m_LVName)[lvIndex] << "{}" << std::endl <<
112 "}" << std::endl;
113 m_File.close();
114 B2INFO("VRML written to " << m_Filename);
115
116 delete m_PVName;
117 delete m_LVName;
118 delete m_SolidName;
119 delete m_IsCylinder;
120 delete m_PVIndex;
121 delete m_LVWritten;
122 delete m_PVWritten;
123
124}
void writePreamble(void)
Emit VRML for the start of the file.
bool m_First
Once-only flag to write VRML only on the first event.
void assignName(std::vector< std::string > *, unsigned int, const G4String &, int)
Create unique and legal name for each solid.
std::vector< std::string > * m_PVName
Modified (legal-character and unique) physical-volume name.
std::vector< std::string > * m_LVName
Modified (legal-character and unique) logical-volume name.
G4VPhysicalVolume * getTopVolume()
Return a pointer to the top volume.
static GeometryManager & getInstance()
Return a reference to the instance.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getBooleanSolidPolyhedron()

HepPolyhedron * getBooleanSolidPolyhedron ( G4VSolid *  solid)
private

Create polyhedron for a boolean solid (recursive)

Definition at line 568 of file VRMLWriterModule.cc.

569{
570 G4VSolid* solidA = solid->GetConstituentSolid(0);
571 G4VSolid* solidB = solid->GetConstituentSolid(1);
572 HepPolyhedron* polyhedronA = nullptr;
573 if ((solidA->GetEntityType() == "G4IntersectionSolid") ||
574 (solidA->GetEntityType() == "G4UnionSolid") ||
575 (solidA->GetEntityType() == "G4SubtractionSolid") ||
576 (solidA->GetEntityType() == "G4BooleanSolid")) {
577 polyhedronA = getBooleanSolidPolyhedron(solidA);
578 } else {
579 polyhedronA = new HepPolyhedron(*(solidA->GetPolyhedron()));
580 }
581 HepPolyhedron* polyhedronB = nullptr;
582 G4VSolid* solidB2 = solidB;
583 if (solidB->GetEntityType() == "G4DisplacedSolid") {
584 solidB2 = ((G4DisplacedSolid*)solidB)->GetConstituentMovedSolid();
585 }
586 if ((solidB2->GetEntityType() == "G4IntersectionSolid") ||
587 (solidB2->GetEntityType() == "G4UnionSolid") ||
588 (solidB2->GetEntityType() == "G4SubtractionSolid") ||
589 (solidB2->GetEntityType() == "G4BooleanSolid")) {
590 polyhedronB = getBooleanSolidPolyhedron(solidB2);
591 if (solidB != solidB2) { // was solidB a G4DisplacedSolid?
592 polyhedronB->Transform(G4Transform3D(
593 ((G4DisplacedSolid*)solidB)->GetObjectRotation(),
594 ((G4DisplacedSolid*)solidB)->GetObjectTranslation()));
595 }
596 } else {
597 polyhedronB = new HepPolyhedron(*(solidB->GetPolyhedron()));
598 }
599 auto* result = new HepPolyhedron();
600 if (solid->GetEntityType() == "G4UnionSolid") {
601 *result = polyhedronA->add(*polyhedronB);
602 } else if (solid->GetEntityType() == "G4SubtractionSolid") {
603 *result = polyhedronA->subtract(*polyhedronB);
604 } else if (solid->GetEntityType() == "G4IntersectionSolid") {
605 *result = polyhedronA->intersect(*polyhedronB);
606 } else {
607 B2WARNING("getBooleanSolidPolyhedron(): Unrecognized boolean solid " << solid->GetName() <<
608 " of type " << solid->GetEntityType());
609 }
610 delete polyhedronA;
611 delete polyhedronB;
612 return result;
613}

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

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ 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;}
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, and RootOutputModule.

Definition at line 134 of file Module.h.

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

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

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

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

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

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

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ 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
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

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

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( )
overridevirtual

Initialize at the start of a job.

Reimplemented from Module.

Definition at line 45 of file VRMLWriterModule.cc.

46{
47 m_First = true;
48}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ 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
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ 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
nameThe 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ terminate()

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

518{
519 if (written) {
520 m_File << " USE " << pvName << std::endl; // this never happens, as it turns out
521 } else {
522 m_File << " # PhysicalVolume " << physVol->GetName() << " copy " << physVol->GetCopyNo() << std::endl <<
523 " DEF " << pvName << " Transform {" << std::endl; // DEF provides object name when importing VRML into Unity
524 G4RotationMatrix* rot = physVol->GetObjectRotation();
525 G4ThreeVector move = physVol->GetObjectTranslation();
526 double yaw = std::atan2(rot->yx(), rot->xx());
527 double pitch = -std::asin(rot->zx());
528 double roll = std::atan2(rot->zy(), rot->zz());
529 std::cout << physVol->GetName() << " translation: " << move.x() << "," << move.y() << "," << move.z() << std::endl;
530 std::cout << physVol->GetName() << " rotation: " << yaw * 180.0 / M_PI << "," << pitch * 180.0 / M_PI << "," << roll * 180.0 / M_PI
531 << std::endl;
532 if (move.mag2() != 0.0) {
533 m_File << " translation " << std::setprecision(10) <<
534 move.x() << " " << move.y() << " " << move.z() << std::endl;
535 }
536 if (!(rot->isIdentity())) {
537 double trace = std::max(-1.0, std::min(3.0, rot->xx() + rot->yy() + rot->zz()));
538 double angle = std::acos(0.5 * (trace - 1.0));
539 G4ThreeVector rotA(rot->zy() - rot->yz(), rot->xz() - rot->zx(), rot->yx() - rot->xy());
540 if ((rotA.x() == 0.0) && (rotA.y() == 0.0) && (rotA.z() == 0.0)) {
541 // The assignment along x, y or z axis in Hep3Vector::axis() is wrong. The proper axis of
542 // rotation is given by kernel(r - I), which is the cross product of two non-proportional rows
543 if (rot->xx() > 0.0) {
544 rotA.setX((rot->yy() - 1.0) * (rot->zz() - 1.0) - rot->yz() * rot->zy());
545 rotA.setY(rot->yz() * rot->zx() - rot->yx() * (rot->zz() - 1.0));
546 rotA.setZ(rot->yx() * rot->zy() - rot->zx() * (rot->yy() - 1.0));
547 } else if (rot->yy() > 0.0) {
548 rotA.setX(rot->xy() * (rot->zz() - 1.0) - rot->xz() * rot->zy());
549 rotA.setY(rot->xz() * rot->zx() - (rot->xx() - 1.0) * (rot->zz() - 1.0));
550 rotA.setZ((rot->xx() - 1.0) * rot->zy() - rot->xy() * rot->zx());
551 } else {
552 rotA.setX(rot->xy() * rot->yz() - rot->xz() * (rot->yy() - 1.0));
553 rotA.setY(rot->xz() * rot->yx() - rot->yz() * (rot->xx() - 1.0));
554 rotA.setZ((rot->xx() - 1.0) * (rot->yy() - 1.0) - rot->xy() * rot->yx());
555 }
556 }
557 rotA.setMag(1.0);
558 m_File << " rotation " << std::setprecision(10) <<
559 rotA.x() << " " << rotA.y() << " " << rotA.z() << " " << angle << std::endl;
560 }
561 m_File << " children lv_" << lvName << "{}" << std::endl <<
562 " }" << std::endl;
563 }
564}

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

484{
485 if (polyhedron) {
486 m_File << "PROTO solid_" << name << " [ ] {" << std::endl <<
487 " IndexedFaceSet {" << std::endl <<
488 " coord Coordinate {" << std::endl <<
489 " point [" << std::endl;
490 for (int j = 1; j <= polyhedron->GetNoVertices(); ++j) {
491 m_File << " " << polyhedron->GetVertex(j).x() << " " <<
492 polyhedron->GetVertex(j).y() << " " <<
493 polyhedron->GetVertex(j).z() << std::endl;
494 }
495 m_File << " ]" << std::endl <<
496 " }" << std::endl <<
497 " coordIndex [" << std::endl;
498 for (int j = 0; j < polyhedron->GetNoFacets(); ++j) {
499 G4bool notLastEdge = true;
500 G4int ndx = -1, edgeFlag = 1;
501 m_File << " ";
502 do {
503 notLastEdge = polyhedron->GetNextVertexIndex(ndx, edgeFlag);
504 m_File << " " << ndx - 1;
505 } while (notLastEdge);
506 m_File << " -1" << std::endl;
507 }
508 m_File << " ]" << std::endl <<
509 " }" << std::endl <<
510 "}" << std::endl;
511 } else {
512 B2INFO("Polyhedron representation of solid " << name << " cannot be created");
513 }
514}

◆ writePreamble()

void writePreamble ( void  )
private

Emit VRML for the start of the file.

Definition at line 445 of file VRMLWriterModule.cc.

446{
447 m_File << "#VRML V2.0 utf8" << std::endl << std::endl <<
448 "WorldInfo {" << std::endl <<
449 " info [ \"(c) The Belle II Collaboration\" ]" << std::endl <<
450 " title \"The Belle II Detector\"" << std::endl <<
451 "}" << std::endl <<
452 "Viewpoint {" << std::endl <<
453 " position 0 0 15000" << std::endl <<
454 " description \"front\"" << std::endl <<
455 "}" << std::endl <<
456 "Viewpoint {" << std::endl <<
457 " position 0 0 -15000" << std::endl <<
458 " orientation 0 1 0 3.141593" << std::endl <<
459 " description \"back\"" << std::endl <<
460 "}" << std::endl <<
461 "Viewpoint {" << std::endl <<
462 " position 0 15000 0" << std::endl <<
463 " orientation 1 0 0 -1.570796" << std::endl <<
464 " description \"top\"" << std::endl <<
465 "}" << std::endl <<
466 "Viewpoint {" << std::endl <<
467 " position 0 -15000 0" << std::endl <<
468 " orientation 1 0 0 1.570796" << std::endl <<
469 " description \"bottom\"" << std::endl <<
470 "}" << std::endl <<
471 "Viewpoint {" << std::endl <<
472 " position 15000 0 0" << std::endl <<
473 " orientation 0 1 0 1.570796" << std::endl <<
474 " description \"right\"" << std::endl <<
475 "}" << std::endl <<
476 "Viewpoint {" << std::endl <<
477 " position -15000 0 0" << std::endl <<
478 " orientation 0 1 0 -1.570796" << std::endl <<
479 " description \"left\"" << std::endl <<
480 "}" << std::endl;
481}

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: