Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TGDMLWrite.h
Go to the documentation of this file.
1// @(#)root/gdml:$Id$
2// Author: Anton Pytel 15/9/2011
3
4/*************************************************************************
5 * Copyright (C) 1995-2011, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TGDMLWRITE
13#define ROOT_TGDMLWRITE
14
15#include "TGeoMatrix.h"
16#include "TGeoElement.h"
17#include "TXMLEngine.h"
18#include "TGeoVolume.h"
19#include "TGeoParaboloid.h"
20#include "TGeoSphere.h"
21#include "TGeoArb8.h"
22#include "TGeoCone.h"
23#include "TGeoPara.h"
24#include "TGeoTrd1.h"
25#include "TGeoTrd2.h"
26#include "TGeoTube.h"
27#include "TGeoPcon.h"
28#include "TGeoTorus.h"
29#include "TGeoPgon.h"
30#include "TGeoXtru.h"
31#include "TGeoEltu.h"
32#include "TGeoHype.h"
33#include "TGeoBoolNode.h"
34#include "TGeoCompositeShape.h"
35#include "TGeoScaledShape.h"
36#include "TGeoTessellated.h"
37#include "TGeoManager.h"
38#include "TGDMLMatrix.h"
39
40#include <map>
41#include <set>
42#include <iostream>
43
44////////////////////////////////////////////////////////////////////////////
45// //
46// TGDMLWrite - Class for exporting geometries From ROOT's gGeoManager //
47// (instance of TGeoManager class) To GDML file. More about GDML //
48// see http://gdml.web.cern.ch. //
49// //
50////////////////////////////////////////////////////////////////////////////
51
53class TGeoSkinSurface;
55
56class TGDMLWrite : public TObject {
57public:
58 TGDMLWrite();
59 virtual ~TGDMLWrite();
60
61 static void StartGDMLWriting(TGeoManager * geomanager, const char* filename, TString option) {
62 //static function -
63 //options:
64 // g - set by default - geant4 compatibility
65 // f,n - if none of this two is set then naming convention is
66 // with incremental suffix, if "f" then suffix is pointer
67 // if "n" then there is no suffix, but uniqness of names
68 // is not secured.
70 writer->SetFltPrecision(TGeoManager::GetExportPrecision());
71 writer->WriteGDMLfile(geomanager, filename, option);
72 delete writer;
73 }
74 //wrapper of all main methods for extraction
75 void WriteGDMLfile(TGeoManager * geomanager, const char* filename = "test.gdml", TString option = "");
76 // Wrapper to only selectively write one branch of the volume hierarchy to file
77 void WriteGDMLfile(TGeoManager * geomanager, TGeoNode* top_node, const char* filename = "test.gdml", TString option = "");
78
83 };
84 void SetNamingSpeed(ENamingType naming);
85 void SetG4Compatibility(Bool_t G4Compatible) {
86 fgG4Compatibility = G4Compatible;
87 };
88
89private:
90 struct Xyz {
94 };
95
96 typedef std::set<const TGeoOpticalSurface*> SurfaceList;
97 typedef std::set<const TGeoVolume*> VolList;
98 typedef std::set<const TGeoNode*> NodeList;
99 typedef std::map<TString, Bool_t> NameList;
100 typedef std::map<TString, TString> NameListS;
101 typedef std::map<TString, Int_t> NameListI;
102 typedef std::map<TString, Float_t> NameListF;
103 struct StructLst {
105 }; //to store pointers
106 struct NameLst {
107 NameListS fLst; //to map pointers with names
108 NameListI fLstIter; //to store all the iterators for repeating names
109 };
110
111 //General lists
112 StructLst *fIsotopeList; //list of isotopes
113 StructLst *fElementList; //list of elements
114 StructLst *fAccPatt; //list of accepted patterns for division
115 StructLst *fRejShape; //list of rejected shapes
116 SurfaceList fSurfaceList; //list of optical surfaces
117 VolList fVolumeList; //list of volumes
118 NodeList fNodeList; //list of placed volumes
119
120 NameLst *fNameList; //list of names (pointer mapped)
121
122 //Data members
123 static TGDMLWrite *fgGDMLWrite; //pointer to gdml writer
124 Int_t fgNamingSpeed; //input option for volume and solid naming
125 Bool_t fgG4Compatibility; //input option for Geant4 compatibility
126 XMLDocPointer_t fGdmlFile; //pointer storing xml file
127 TString fDefault_lunit; //Default unit of length (depends on ROOT unit system)
128 TString fTopVolumeName; //name of top volume
129 TXMLEngine *fGdmlE; //xml engine pointer
130
131 XMLNodePointer_t fDefineNode; //main <define> node...
132 XMLNodePointer_t fMaterialsNode; //main <materials> node...
133 XMLNodePointer_t fSolidsNode; //main <solids> node...
134 XMLNodePointer_t fStructureNode; //main <structure> node...
135 Int_t fVolCnt; //count of volumes
136 Int_t fPhysVolCnt; //count of physical volumes
137 UInt_t fActNameErr; //count of name errors
138 UInt_t fSolCnt; //count of name solids
139 UInt_t fFltPrecision; //! floating point precision when writing
140
141 static const UInt_t fgkProcBit = BIT(14); //14th bit is set when solid is processed
142 static const UInt_t fgkProcBitVol = BIT(19); //19th bit is set when volume is processed
143 static const UInt_t fgkMaxNameErr = 5; //maximum number of errors for naming
144
145 //I. Methods processing the gGeoManager geometry object structure
146 //1. Main methods to extract everything from ROOT gGeoManager
147 XMLNodePointer_t ExtractMaterials(TList* materialsLst); //result <materials>...
148 TString ExtractSolid(TGeoShape* volShape); //adds <shape> to <solids>
149 void ExtractVolumes(TGeoNode* topNode); //result <volume> node... + corresp. shape
150 void ExtractMatrices(TObjArray *matrices); //adds <matrix> to <define>
151 void ExtractConstants(TGeoManager *geom); //adds <constant> to <define>
152 void ExtractOpticalSurfaces(TObjArray *surfaces); //adds <opticalsurface> to <solids>
153 void ExtractSkinSurfaces(TObjArray *surfaces); //adds <skinsurface> to <structure>
154 void ExtractBorderSurfaces(TObjArray *surfaces); //adds <bordersurface> to <structure>
155
156 // Combined implementation to extract GDML information from the geometry tree
157 void WriteGDMLfile(TGeoManager * geomanager, TGeoNode* top_node, TList* materialsLst, const char* filename, TString option);
158
159 //1.1 Materials sub methods - creating Nodes
160 XMLNodePointer_t CreateAtomN(Double_t atom, const char * unit = "g/mole");
161 XMLNodePointer_t CreateDN(Double_t density, const char * unit = "g/cm3");
162 XMLNodePointer_t CreateFractionN(Double_t percentage, const char * refName);
163 XMLNodePointer_t CreatePropertyN(TNamed const &property);
164
165 XMLNodePointer_t CreateIsotopN(TGeoIsotope * isotope, const char * name);
166 XMLNodePointer_t CreateElementN(TGeoElement * element, XMLNodePointer_t materials, const char * name);
169
170
171 //1.2 Solids sub methods
174
201
203
204 //1.3 Volume sub methods
205 XMLNodePointer_t CreatePhysVolN(const char * name, Int_t copyno, const char * volref, const char * posref, const char * rotref, XMLNodePointer_t scaleN);
206 XMLNodePointer_t CreateDivisionN(Double_t offset, Double_t width, Int_t number, const char * axis, const char * unit, const char * volref);
207
208 XMLNodePointer_t CreateSetupN(const char * topVolName , const char * name = "default", const char * version = "1.0");
209 XMLNodePointer_t StartVolumeN(const char * name, const char * solid, const char * material);
211
212
213 //II. Utility methods
214 Xyz GetXYZangles(const Double_t * rotationMatrix);
215 //nodes to create position, rotation and similar types first-position/rotation...
216 XMLNodePointer_t CreatePositionN(const char * name, Xyz position, const char * type = "position", const char * unit = "cm");
217 XMLNodePointer_t CreateRotationN(const char * name, Xyz rotation, const char * type = "rotation", const char * unit = "deg");
219 XMLNodePointer_t CreateConstantN(const char *name, Double_t value);
220 TGeoCompositeShape* CreateFakeCtub(TGeoCtub * geoShape); //create fake cut tube as intersection
221
222 //check name (2nd parameter) whether it is in the list (1st parameter)
223 Bool_t IsInList(NameList list, TString name2check);
224 TString GenName(TString oldname);
225 TString GenName(TString oldname, TString objPointer);
226 Bool_t CanProcess(TObject *pointer);
227 TString GetPattAxis(Int_t divAxis, const char * pattName, TString& unit);
228 Bool_t IsNullParam(Double_t parValue, TString parName, TString objName);
229 void UnsetTemporaryBits(TGeoManager * geoMng);
231 void SetFltPrecision(UInt_t prec) { fFltPrecision = prec; }
232
233 ////////////////////////////////////////////////////////////////////////////////
234 //
235 // Backwards compatibility for old DD4hep version (to be removed in the future)
236 //
237 ////////////////////////////////////////////////////////////////////////////////
238public:
239 // Backwards compatibility (to be removed in the future): Wrapper to only selectively write one branch
240 void WriteGDMLfile(TGeoManager * geomanager, TGeoVolume* top_vol, const char* filename = "test.gdml", TString option = "");
241private:
242 // Backwards compatibility (to be removed in the future): Combined implementation to extract GDML information from the geometry tree
243 void WriteGDMLfile(TGeoManager * geomanager, TGeoVolume* top_vol, TList* materialsLst, const char* filename, TString option);
244 void ExtractVolumes(TGeoVolume* topVolume); //result <volume> node... + corresp. shape
245
246 ClassDef(TGDMLWrite, 0) //imports GDML using DOM and binds it to ROOT
247};
248
249#endif /* ROOT_TGDMLWRITE */
double Double_t
Definition RtypesCore.h:59
#define ClassDef(name, id)
Definition Rtypes.h:325
#define BIT(n)
Definition Rtypes.h:85
include TDocParser_001 C image html pict1_TDocParser_001 png width
char name[80]
Definition TGX11.cxx:110
int type
Definition TGX11.cxx:121
void * XMLNodePointer_t
Definition TXMLEngine.h:17
void * XMLDocPointer_t
Definition TXMLEngine.h:20
This class is used in the process of reading and writing the GDML "matrix" tag.
Definition TGDMLMatrix.h:34
This class contains implementation of converting ROOT's gGeoManager geometry to GDML file.
Definition TGDMLWrite.h:56
XMLNodePointer_t fSolidsNode
Definition TGDMLWrite.h:133
StructLst * fElementList
Definition TGDMLWrite.h:113
void UnsetTemporaryBits(TGeoManager *geoMng)
Unsetting bits that were changed in gGeoManager during export so that export can be run more times wi...
std::map< TString, Bool_t > NameList
Definition TGDMLWrite.h:99
TString fTopVolumeName
Definition TGDMLWrite.h:128
XMLNodePointer_t CreateDivisionN(Double_t offset, Double_t width, Int_t number, const char *axis, const char *unit, const char *volref)
Creates "divisionvol" node for GDML.
static const UInt_t fgkProcBitVol
Definition TGDMLWrite.h:142
XMLNodePointer_t CreatePolyconeN(TGeoPcon *geoShape)
Creates "polycone" node for GDML.
XMLNodePointer_t CreateFractionN(Double_t percentage, const char *refName)
Creates "fraction" node for GDML.
void ExtractMatrices(TObjArray *matrices)
Method exporting GDML matrices.
XMLDocPointer_t fGdmlFile
Definition TGDMLWrite.h:126
SurfaceList fSurfaceList
Definition TGDMLWrite.h:116
UInt_t GetFltPrecision() const
Definition TGDMLWrite.h:230
void SetG4Compatibility(Bool_t G4Compatible)
Definition TGDMLWrite.h:85
XMLNodePointer_t CreateParaboloidN(TGeoParaboloid *geoShape)
Creates "paraboloid" node for GDML.
TGeoCompositeShape * CreateFakeCtub(TGeoCtub *geoShape)
Method creating cutTube as an intersection of tube and two boxes.
TGDMLWrite()
Default constructor.
XMLNodePointer_t CreateBoxN(TGeoBBox *geoShape)
Creates "box" node for GDML.
std::map< TString, Float_t > NameListF
Definition TGDMLWrite.h:102
XMLNodePointer_t CreateMaterialN(TGeoMaterial *material, TString mname)
Creates "material" node for GDML.
VolList fVolumeList
Definition TGDMLWrite.h:117
XMLNodePointer_t CreateSphereN(TGeoSphere *geoShape)
Creates "sphere" node for GDML.
XMLNodePointer_t CreateTwistedTrapN(TGeoGtra *geoShape)
Creates "twistedtrap" node for GDML.
TXMLEngine * fGdmlE
Definition TGDMLWrite.h:129
XMLNodePointer_t CreateZplaneN(Double_t z, Double_t rmin, Double_t rmax)
Creates "zplane" node for GDML.
static const UInt_t fgkMaxNameErr
Definition TGDMLWrite.h:143
Bool_t IsNullParam(Double_t parValue, TString parName, TString objName)
Check for null parameter to skip the NULL objects.
static TGDMLWrite * fgGDMLWrite
Definition TGDMLWrite.h:123
TString ExtractSolid(TGeoShape *volShape)
Method creating solid to xml file and returning its name.
XMLNodePointer_t CreateHypeN(TGeoHype *geoShape)
Creates "hype" node for GDML.
XMLNodePointer_t CreateElConeN(TGeoScaledShape *geoShape)
Creates "elcone" (elliptical cone) node for GDML this is a special case, because elliptical cone is n...
XMLNodePointer_t CreateConstantN(const char *name, Double_t value)
Creates "constant" kind of node for GDML.
XMLNodePointer_t CreateMatrixN(TGDMLMatrix const *matrix)
Creates "matrix" kind of node for GDML.
XMLNodePointer_t CreateOpticalSurfaceN(TGeoOpticalSurface *geoSurf)
Creates "opticalsurface" node for GDML.
StructLst * fRejShape
Definition TGDMLWrite.h:115
UInt_t fSolCnt
Definition TGDMLWrite.h:138
Bool_t fgG4Compatibility
Definition TGDMLWrite.h:125
XMLNodePointer_t CreateMixtureN(TGeoMixture *mixture, XMLNodePointer_t materials, TString mname)
Creates "material" node for GDML with references to other sub elements.
std::map< TString, Int_t > NameListI
Definition TGDMLWrite.h:101
void ExtractBorderSurfaces(TObjArray *surfaces)
Method exporting border surfaces.
static const UInt_t fgkProcBit
floating point precision when writing
Definition TGDMLWrite.h:141
Bool_t CanProcess(TObject *pointer)
Method which tests whether solids can be processed.
UInt_t fActNameErr
Definition TGDMLWrite.h:137
std::set< const TGeoVolume * > VolList
Definition TGDMLWrite.h:97
XMLNodePointer_t CreatePolyhedraN(TGeoPgon *geoShape)
Creates "polyhedra" node for GDML.
void WriteGDMLfile(TGeoManager *geomanager, const char *filename="test.gdml", TString option="")
XMLNodePointer_t CreateRotationN(const char *name, Xyz rotation, const char *type="rotation", const char *unit="deg")
Creates "rotation" kind of node for GDML.
XMLNodePointer_t CreatePositionN(const char *name, Xyz position, const char *type="position", const char *unit="cm")
Creates "position" kind of node for GDML.
NodeList fNodeList
Definition TGDMLWrite.h:118
@ kwithoutSufixNotUniq
Definition TGDMLWrite.h:81
@ kelegantButSlow
Definition TGDMLWrite.h:80
@ kfastButUglySufix
Definition TGDMLWrite.h:82
XMLNodePointer_t CreatePropertyN(TNamed const &property)
Creates "property" node for GDML.
XMLNodePointer_t CreateElementN(TGeoElement *element, XMLNodePointer_t materials, const char *name)
Creates "element" node for GDML element node and attribute.
XMLNodePointer_t CreateConeN(TGeoConeSeg *geoShape)
Creates "cone" node for GDML from TGeoConeSeg object.
XMLNodePointer_t CreateSkinSurfaceN(TGeoSkinSurface *geoSurf)
Creates "skinsurface" node for GDML.
XMLNodePointer_t CreateTessellatedN(TGeoTessellated *geoShape)
Creates "tessellated" (tessellated shape) node for GDML.
XMLNodePointer_t CreateCutTubeN(TGeoCtub *geoShape)
Creates "cutTube" node for GDML.
XMLNodePointer_t fStructureNode
Definition TGDMLWrite.h:134
std::set< const TGeoOpticalSurface * > SurfaceList
Definition TGDMLWrite.h:96
void ExtractSkinSurfaces(TObjArray *surfaces)
Method exporting skin surfaces.
XMLNodePointer_t fDefineNode
Definition TGDMLWrite.h:131
virtual ~TGDMLWrite()
Destructor.
XMLNodePointer_t CreateTorusN(TGeoTorus *geoShape)
Creates "torus" node for GDML.
Int_t fgNamingSpeed
Definition TGDMLWrite.h:124
Int_t fVolCnt
Definition TGDMLWrite.h:135
XMLNodePointer_t ExtractMaterials(TList *materialsLst)
Method exporting materials.
XMLNodePointer_t fMaterialsNode
Definition TGDMLWrite.h:132
void ExtractOpticalSurfaces(TObjArray *surfaces)
Method exporting optical surfaces.
XMLNodePointer_t CreateDN(Double_t density, const char *unit="g/cm3")
Creates "D" density node for GDML.
void ExtractConstants(TGeoManager *geom)
Method exporting GDML matrices.
XMLNodePointer_t CreateArb8N(TGeoArb8 *geoShape)
Creates "arb8" node for GDML.
void SetFltPrecision(UInt_t prec)
Definition TGDMLWrite.h:231
XMLNodePointer_t StartVolumeN(const char *name, const char *solid, const char *material)
Creates "volume" node for GDML.
void SetNamingSpeed(ENamingType naming)
Set convention of naming solids and volumes.
TString GetPattAxis(Int_t divAxis, const char *pattName, TString &unit)
Method that retrieves axis and unit along which object is divided.
TString GenName(TString oldname)
NCNAME basic restrictions Replace "$" character with empty character etc.
XMLNodePointer_t CreateXtrusionN(TGeoXtru *geoShape)
Creates "xtru" node for GDML.
XMLNodePointer_t CreatePhysVolN(const char *name, Int_t copyno, const char *volref, const char *posref, const char *rotref, XMLNodePointer_t scaleN)
Creates "physvol" node for GDML.
Bool_t IsInList(NameList list, TString name2check)
Checks whether name2check is in (NameList) list.
XMLNodePointer_t StartAssemblyN(const char *name)
Creates "assembly" node for GDML.
TString fDefault_lunit
Definition TGDMLWrite.h:127
Int_t fPhysVolCnt
Definition TGDMLWrite.h:136
std::set< const TGeoNode * > NodeList
Definition TGDMLWrite.h:98
XMLNodePointer_t CreateParaN(TGeoPara *geoShape)
Creates "para" node for GDML.
XMLNodePointer_t CreateSetupN(const char *topVolName, const char *name="default", const char *version="1.0")
Creates "setup" node for GDML.
XMLNodePointer_t CreateTrapN(TGeoTrap *geoShape)
Creates "trap" node for GDML.
Xyz GetXYZangles(const Double_t *rotationMatrix)
Retrieves X Y Z angles from rotation matrix.
UInt_t fFltPrecision
Definition TGDMLWrite.h:139
XMLNodePointer_t CreateTubeN(TGeoTubeSeg *geoShape)
Creates "tube" node for GDML from object TGeoTubeSeg.
XMLNodePointer_t CreateBorderSurfaceN(TGeoBorderSurface *geoSurf)
Creates "bordersurface" node for GDML.
XMLNodePointer_t CreateAtomN(Double_t atom, const char *unit="g/mole")
Creates "atom" node for GDML.
StructLst * fIsotopeList
Definition TGDMLWrite.h:112
static void StartGDMLWriting(TGeoManager *geomanager, const char *filename, TString option)
Definition TGDMLWrite.h:61
StructLst * fAccPatt
Definition TGDMLWrite.h:114
XMLNodePointer_t CreateEltubeN(TGeoEltu *geoShape)
Creates "eltube" node for GDML.
void ExtractVolumes(TGeoNode *topNode)
Method extracting geometry structure recursively.
XMLNodePointer_t CreateEllipsoidN(TGeoCompositeShape *geoShape, TString elName)
Creates "ellipsoid" node for GDML this is a special case, because ellipsoid is not defined in ROOT so...
XMLNodePointer_t CreateIsotopN(TGeoIsotope *isotope, const char *name)
Creates "isotope" node for GDML.
XMLNodePointer_t CreateCommonBoolN(TGeoCompositeShape *geoShape)
Creates common part of union intersection and subtraction nodes.
XMLNodePointer_t CreateTrdN(TGeoTrd1 *geoShape)
Creates "trd" node for GDML from object TGeoTrd1.
std::map< TString, TString > NameListS
Definition TGDMLWrite.h:100
NameLst * fNameList
Definition TGDMLWrite.h:120
XMLNodePointer_t ChooseObject(TGeoShape *geoShape)
Chooses the object and method that should be used for processing object.
An arbitrary trapezoid with less than 8 vertices standing on two parallel planes perpendicular to Z a...
Definition TGeoArb8.h:18
Box class.
Definition TGeoBBox.h:18
Class handling Boolean composition of shapes.
A phi segment of a conical tube.
Definition TGeoCone.h:99
Conical tube class.
Definition TGeoCone.h:18
A tube segment cut with 2 planes.
Definition TGeoTube.h:169
Base class for chemical elements.
Definition TGeoElement.h:37
Elliptical tube class.
Definition TGeoEltu.h:18
Gtra is a twisted trapezoid.
Definition TGeoArb8.h:146
Hyperboloid class defined by 5 parameters.
Definition TGeoHype.h:18
The manager class for any TGeo geometry.
Definition TGeoManager.h:45
static UInt_t GetExportPrecision()
Base class describing materials.
Mixtures of elements.
A node represent a volume positioned inside another.They store links to both volumes and to the TGeoM...
Definition TGeoNode.h:41
Parallelepiped class.
Definition TGeoPara.h:18
Paraboloid class.
A polycone.
Definition TGeoPcon.h:18
A polygone.
Definition TGeoPgon.h:21
A shape scaled by a TGeoScale transformation.
Base abstract class for all shapes.
Definition TGeoShape.h:26
Spherical shell class.
Definition TGeoSphere.h:18
Tessellated solid class.
Torus segment class.
Definition TGeoTorus.h:18
TRAP is a general trapezoid, i.e.
Definition TGeoArb8.h:92
A trapezoid with only x length varying with z.
Definition TGeoTrd1.h:18
A trapezoid with both x and y lengths varying with z.
Definition TGeoTrd2.h:18
A phi segment of a tube.
Definition TGeoTube.h:89
Cylindrical tube class.
Definition TGeoTube.h:18
TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.
Definition TGeoVolume.h:49
An extrusion with fixed outline shape in x-y and a sequence of z extents (segments).
Definition TGeoXtru.h:23
A doubly linked list.
Definition TList.h:44
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
An array of TObjects.
Definition TObjArray.h:37
Mother of all ROOT objects.
Definition TObject.h:37
Basic string class.
Definition TString.h:136