Logo ROOT   6.18/05
Reference Guide
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
TGeoVolume Class Reference

TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.

Volumes are the basic objects used in building the geometrical hierarchy. They represent unpositioned objects but store all information about the placement of the other volumes they may contain. Therefore a volume can be replicated several times in the geometry. In order to create a volume, one has to put together a shape and a medium which are already defined. Volumes have to be named by users at creation time. Every different name may represent a an unique volume object, but may also represent more general a family (class) of volume objects having the same shape type and medium, but possibly different shape parameters. It is the user's task to provide different names for different volume families in order to avoid ambiguities at tracking time. A generic family rather than a single volume is created only in two cases : when a generic shape is provided to the volume constructor or when a division operation is applied. Each volume in the geometry stores an unique ID corresponding to its family. In order to ease-up their creation, the manager class is providing an API that allows making a shape and a volume in a single step.

Volumes are objects that can be visualized, therefore having visibility, colour, line and fill attributes that can be defined or modified any time after the volume creation. It is advisable however to define these properties just after the first creation of a volume namespace, since in case of volume families any new member created by the modeler inherits these properties.

In order to provide navigation features, volumes have to be able to find the proper container of any point defined in the local reference frame. This can be the volume itself, one of its positioned daughter volumes or none if the point is actually outside. On the other hand, volumes have to provide also other navigation methods such as finding the distances to its shape boundaries or which daughter will be crossed first. The implementation of these features is done at shape level, but the local mother-daughters management is handled by volumes that builds additional optimisation structures upon geometry closure. In order to have navigation features properly working one has to follow the general rules for building a valid geometry (see TGeoManager class).

Now let's make a simple volume representing a copper wire. We suppose that a medium is already created (see TGeoMedium class on how to create media). We will create a TUBE shape for our wire, having Rmin=0cm, Rmax=0.01cm and a half-length dZ=1cm :

TGeoTube *tube = new TGeoTube("wire_tube", 0, 0.01, 1);
Cylindrical tube class.
Definition: TGeoTube.h:18

One may omit the name for the shape if no retrieving by name is further needed during geometry building. The same shape can be shared by different volumes having different names and materials. Now let's make the volume for our wire. The prototype for volumes constructor looks like :

TGeoVolume::TGeoVolume(const char *name, TGeoShape *shape, TGeoMedium *med)

Since TGeoTube derives from the base shape class, we can provide it to the volume constructor :

TGeoVolume *wire_co = new TGeoVolume("WIRE_CO", tube, ptrCOPPER);
TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.
Definition: TGeoVolume.h:53
TGeoVolume()
dummy constructor
Definition: TGeoVolume.cxx:447

Do not bother to delete neither the media, shapes or volumes that you have created since all will be automatically cleaned on exit by the manager class. If we would have taken a look inside TGeoManager::MakeTube() method, we would have been able to create our wire with a single line :

TGeoVolume *wire_co = gGeoManager->MakeTube("WIRE_CO", ptrCOPPER, 0, 0.01, 1);
R__EXTERN TGeoManager * gGeoManager
Definition: TGeoManager.h:601
TGeoVolume * MakeTube(const char *name, TGeoMedium *medium, Double_t rmin, Double_t rmax, Double_t dz)
Make in one step a volume pointing to a tube shape with given medium.

The same applies for all primitive shapes, for which there can be found corresponding MakeSHAPE() methods. Their usage is much more convenient unless a shape has to be shared between more volumes. Let's make now an aluminium wire having the same shape, supposing that we have created the copper wire with the line above :

TGeoVolume *wire_al = new TGeoVolume("WIRE_AL", wire_co->GetShape(), ptrAL);
TGeoShape * GetShape() const
Definition: TGeoVolume.h:191

Now that we have learned how to create elementary volumes, let's see how we can create a geometrical hierarchy.

Positioning volumes

When creating a volume one does not specify if this will contain or not other volumes. Adding daughters to a volume implies creating those and adding them one by one to the list of daughters. Since the volume has to know the position of all its daughters, we will have to supply at the same time a geometrical transformation with respect to its local reference frame for each of them. The objects referencing a volume and a transformation are called NODES and their creation is fully handled by the modeler. They represent the link elements in the hierarchy of volumes. Nodes are unique and distinct geometrical objects ONLY from their container point of view. Since volumes can be replicated in the geometry, the same node may be found on different branches.

An important observation is that volume objects are owned by the TGeoManager class. This stores a list of all volumes in the geometry, that is cleaned upon destruction.

Let's consider positioning now our wire in the middle of a gas chamber. We need first to define the gas chamber :

TGeoVolume *chamber = gGeoManager->MakeTube("CHAMBER", ptrGAS, 0, 1, 1);

Now we can put the wire inside :

chamber->AddNode(wire_co, 1);
virtual void AddNode(TGeoVolume *vol, Int_t copy_no, TGeoMatrix *mat=0, Option_t *option="")
Add a TGeoNode to the list of nodes.
Definition: TGeoVolume.cxx:984

If we inspect now the chamber volume in a browser, we will notice that it has one daughter. Of course the gas has some container also, but let's keep it like that for the sake of simplicity. The full prototype of AddNode() is :

TGeoVolume::AddNode(TGeoVolume *daughter, Int_t usernumber,
int Int_t
Definition: RtypesCore.h:41
R__EXTERN TGeoIdentity * gGeoIdentity
Definition: TGeoMatrix.h:478
Geometrical transformation package.
Definition: TGeoMatrix.h:41

Since we did not supplied the third argument, the wire will be positioned with an identity transformation inside the chamber. One will notice that the inner radii of the wire and chamber are both zero - therefore, aren't the two volumes overlapping ? The answer is no, the modeler is even relaying on the fact that any daughter is fully contained by its mother. On the other hand, neither of the nodes positioned inside a volume should overlap with each other. We will see that there are allowed some exceptions to those rules.

Overlapping volumes

Positioning volumes that does not overlap their neighbours nor extrude their container is sometimes quite strong constraint. Some parts of the geometry might overlap naturally, e.g. two crossing tubes. The modeller supports such cases only if the overlapping nodes are declared by the user. In order to do that, one should use TGeoVolume::AddNodeOverlap() instead of TGeoVolume::AddNode(). When 2 or more positioned volumes are overlapping, not all of them have to be declared so, but at least one. A point inside an overlapping region equally belongs to all overlapping nodes, but the way these are defined can enforce the modeler to give priorities. The general rule is that the deepest node in the hierarchy containing a point have the highest priority. For the same geometry level, non-overlapping is prioritised over overlapping. In order to illustrate this, we will consider few examples. We will designate non-overlapping nodes as ONLY and the others MANY as in GEANT3, where this concept was introduced:

  1. The part of a MANY node B extruding its container A will never be "seen" during navigation, as if B was in fact the result of the intersection of A and B.
  2. If we have two nodes A (ONLY) and B (MANY) inside the same container, all points in the overlapping region of A and B will be designated as belonging to A.
  3. If A an B in the above case were both MANY, points in the overlapping part will be designated to the one defined first. Both nodes must have the same medium.
  4. The slices of a divided MANY will be as well MANY.

One needs to know that navigation inside geometry parts MANY nodes is much slower. Any overlapping part can be defined based on composite shapes - this is always recommended.

Replicating volumes

What can we do if our chamber contains two identical wires instead of one ? What if then we would need 1000 chambers in our detector ? Should we create 2000 wires and 1000 chamber volumes ? No, we will just need to replicate the ones that we have already created.

chamber->AddNode(wire_co, 1, new TGeoTranslation(-0.2,0,0));
chamber->AddNode(wire_co, 2, new TGeoTranslation(0.2,0,0));
Class describing translations.
Definition: TGeoMatrix.h:122

The 2 nodes that we have created inside chamber will both point to a wire_co object, but will be completely distinct : WIRE_CO_1 and WIRE_CO_2. We will want now to place symmetrically 1000 chambers on a pad, following a pattern of 20 rows and 50 columns. One way to do this will be to replicate our chamber by positioning it 1000 times in different positions of the pad. Unfortunately, this is far from being the optimal way of doing what we want. Imagine that we would like to find out which of the 1000 chambers is containing a (x,y,z) point defined in the pad reference. You will never have to do that, since the modeller will take care of it for you, but let's guess what it has to do. The most simple algorithm will just loop over all daughters, convert the point from mother to local reference and check if the current chamber contains the point or not. This might be efficient for pads with few chambers, but definitely not for 1000. Fortunately the modeler is smarter than that and create for each volume some optimization structures called voxels (see Voxelization) to minimize the penalty having too many daughters, but if you have 100 pads like this in your geometry you will anyway loose a lot in your tracking performance.

The way out when volumes can be arranged according to simple patterns is the usage of divisions. We will describe them in detail later on. Let's think now at a different situation : instead of 1000 chambers of the same type, we may have several types of chambers. Let's say all chambers are cylindrical and have a wire inside, but their dimensions are different. However, we would like all to be represented by a single volume family, since they have the same properties.

Definition at line 48 of file TGeoVolume.h.

Public Types

enum  EGeoVolumeTypes {
  kVolumeReplicated = BIT(14) , kVolumeSelected = BIT(15) , kVolumeDiv = BIT(16) , kVolumeOverlap = BIT(17) ,
  kVolumeImportNodes = BIT(18) , kVolumeMulti = BIT(19) , kVoxelsXYZ = BIT(20) , kVoxelsCyl = BIT(21) ,
  kVolumeClone = BIT(22) , kVolumeAdded = BIT(23) , kVolumeOC = BIT(21)
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Public Types inherited from TGeoAtt
enum  { kBitMask = 0x00ffffff }
 
enum  EGeoActivityAtt { kActOverride = BIT(8) , kActNone = BIT(9) , kActThis = BIT(10) , kActDaughters = BIT(11) }
 
enum  EGeoOptimizationAtt { kUseBoundingBox = BIT(16) , kUseVoxels = BIT(17) , kUseGsord = BIT(18) }
 
enum  EGeoSavePrimitiveAtt { kSavePrimitiveAtt = BIT(19) , kSaveNodesAtt = BIT(20) }
 
enum  EGeoVisibilityAtt {
  kVisOverride = BIT(0) , kVisNone = BIT(1) , kVisThis = BIT(2) , kVisDaughters = BIT(3) ,
  kVisOneLevel = BIT(4) , kVisStreamed = BIT(5) , kVisTouched = BIT(6) , kVisOnScreen = BIT(7) ,
  kVisContainers = BIT(12) , kVisOnly = BIT(13) , kVisBranch = BIT(14) , kVisRaytrace = BIT(15)
}
 

Public Member Functions

 TGeoVolume ()
 dummy constructor More...
 
 TGeoVolume (const char *name, const TGeoShape *shape, const TGeoMedium *med=0)
 default constructor More...
 
virtual ~TGeoVolume ()
 Destructor. More...
 
virtual void AddNode (TGeoVolume *vol, Int_t copy_no, TGeoMatrix *mat=0, Option_t *option="")
 Add a TGeoNode to the list of nodes. More...
 
void AddNodeOffset (TGeoVolume *vol, Int_t copy_no, Double_t offset=0, Option_t *option="")
 Add a division node to the list of nodes. More...
 
virtual void AddNodeOverlap (TGeoVolume *vol, Int_t copy_no, TGeoMatrix *mat=0, Option_t *option="")
 Add a TGeoNode to the list of nodes. More...
 
void Browse (TBrowser *b)
 How to browse a volume. More...
 
Double_t Capacity () const
 Computes the capacity of this [cm^3] as the capacity of its shape. More...
 
virtual void cd (Int_t inode) const
 Actualize matrix of node indexed <inode> More...
 
void CheckGeometry (Int_t nrays=1, Double_t startx=0, Double_t starty=0, Double_t startz=0) const
 Shoot nrays with random directions from starting point (startx, starty, startz) in the reference frame of this volume. More...
 
void CheckOverlaps (Double_t ovlp=0.1, Option_t *option="") const
 Overlap checking tool. More...
 
void CheckShape (Int_t testNo, Int_t nsamples=10000, Option_t *option="")
 Tests for checking the shape navigation algorithms. See TGeoShape::CheckShape() More...
 
void CheckShapes ()
 check for negative parameters in shapes. More...
 
void CleanAll ()
 Clean data of the volume. More...
 
void ClearNodes ()
 
void ClearShape ()
 Clear the shape of this volume from the list held by the current manager. More...
 
virtual void ClearThreadData () const
 
void CloneNodesAndConnect (TGeoVolume *newmother) const
 Clone the array of nodes. More...
 
virtual TGeoVolumeCloneVolume () const
 Clone this volume. More...
 
Bool_t Contains (const Double_t *point) const
 
Int_t CountNodes (Int_t nlevels=1000, Int_t option=0)
 Count total number of subnodes starting from this volume, nlevels down. More...
 
virtual void CreateThreadData (Int_t nthreads)
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 compute the closest distance of approach from point px,py to this volume More...
 
virtual TGeoVolumeDivide (const char *divname, Int_t iaxis, Int_t ndiv, Double_t start, Double_t step, Int_t numed=0, Option_t *option="")
 Division a la G3. More...
 
virtual void Draw (Option_t *option="")
 draw top volume according to option More...
 
virtual void DrawOnly (Option_t *option="")
 draw only this volume More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute mouse actions on this volume. More...
 
Int_t Export (const char *filename, const char *name="", Option_t *option="")
 Export this volume to a file. More...
 
Bool_t FindMatrixOfDaughterVolume (TGeoVolume *vol) const
 Find a daughter node having VOL as volume and fill TGeoManager::fHMatrix with its global matrix. More...
 
TGeoNodeFindNode (const char *name) const
 search a daughter inside the list of nodes More...
 
void FindOverlaps () const
 loop all nodes marked as overlaps and find overlapping brothers More...
 
virtual Int_t GetByteCount () const
 get the total size in bytes for this volume More...
 
virtual Int_t GetCurrentNodeIndex () const
 
TObjectGetField () const
 
TGeoPatternFinderGetFinder () const
 
TGeoExtensionGetFWExtension () const
 
TGeoManagerGetGeoManager () const
 
const char * GetIconName () const
 Returns mime type name of object. More...
 
Int_t GetIndex (const TGeoNode *node) const
 get index number for a given daughter More...
 
TGeoMaterialGetMaterial () const
 
TGeoMediumGetMedium () const
 
Int_t GetNdaughters () const
 
virtual Int_t GetNextNodeIndex () const
 
TGeoNodeGetNode (const char *name) const
 get the pointer to a daughter node More...
 
TGeoNodeGetNode (Int_t i) const
 
Int_t GetNodeIndex (const TGeoNode *node, Int_t *check_list, Int_t ncheck) const
 Get the index of a daughter within check_list by providing the node pointer. More...
 
TObjArrayGetNodes ()
 
Int_t GetNtotal () const
 
Int_t GetNumber () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Get volume info for the browser. More...
 
Bool_t GetOptimalVoxels () const
 Returns true if cylindrical voxelization is optimal. More...
 
Option_tGetOption () const
 
char * GetPointerName () const
 Provide a pointer name containing uid. More...
 
Int_t GetRefCount () const
 
TGeoShapeGetShape () const
 
Char_t GetTransparency () const
 
TGeoExtensionGetUserExtension () const
 
TGeoVoxelFinderGetVoxels () const
 Getter for optimization structure. More...
 
void Grab ()
 
void GrabFocus ()
 Move perspective view focus to this volume. More...
 
TGeoExtensionGrabFWExtension () const
 Get a copy of the framework extension pointer. More...
 
TGeoExtensionGrabUserExtension () const
 Get a copy of the user extension pointer. More...
 
void Gsord (Int_t)
 
void InspectMaterial () const
 Inspect the material for this volume. More...
 
void InspectShape () const
 
void InvisibleAll (Bool_t flag=kTRUE)
 Make volume and each of it daughters (in)visible. More...
 
Bool_t IsActive () const
 
Bool_t IsActiveDaughters () const
 
Bool_t IsAdded () const
 
Bool_t IsAllInvisible () const
 Return TRUE if volume and all daughters are invisible. More...
 
virtual Bool_t IsAssembly () const
 Returns true if the volume is an assembly or a scaled assembly. More...
 
Bool_t IsCylVoxels () const
 
virtual Bool_t IsFolder () const
 Return TRUE if volume contains nodes. More...
 
Bool_t IsOverlappingCandidate () const
 
Bool_t IsRaytracing () const
 Check if the painter is currently ray-tracing the content of this volume. More...
 
Bool_t IsReplicated () const
 
Bool_t IsRunTime () const
 
Bool_t IsSelected () const
 
Bool_t IsStyleDefault () const
 check if the visibility and attributes are the default ones More...
 
Bool_t IsTopVolume () const
 True if this is the top volume of the geometry. More...
 
Bool_t IsValid () const
 
Bool_t IsVisContainers () const
 
virtual Bool_t IsVisible () const
 
Bool_t IsVisibleDaughters () const
 
Bool_t IsVisLeaves () const
 
Bool_t IsVisOnly () const
 
virtual Bool_t IsVolumeMulti () const
 
Bool_t IsXYZVoxels () const
 
TH2FLegoPlot (Int_t ntheta=20, Double_t themin=0., Double_t themax=180., Int_t nphi=60, Double_t phimin=0., Double_t phimax=360., Double_t rmin=0., Double_t rmax=9999999, Option_t *option="")
 Generate a lego plot fot the top volume, according to option. More...
 
void MakeCopyNodes (const TGeoVolume *other)
 make a new list of nodes and copy all nodes of other volume inside More...
 
virtual TGeoVolumeMakeCopyVolume (TGeoShape *newshape)
 make a copy of this volume build a volume with same name, shape and medium More...
 
TGeoVolumeMakeReflectedVolume (const char *newname="") const
 Make a copy of this volume which is reflected with respect to XY plane. More...
 
Bool_t OptimizeVoxels ()
 Perform an extensive sampling to find which type of voxelization is most efficient. More...
 
virtual void Paint (Option_t *option="")
 paint volume More...
 
virtual void Print (Option_t *option="") const
 Print volume info. More...
 
void PrintNodes () const
 print nodes More...
 
void PrintVoxels () const
 Print the voxels for this volume. More...
 
void RandomPoints (Int_t npoints=1000000, Option_t *option="")
 Draw random points in the bounding box of this volume. More...
 
void RandomRays (Int_t nrays=10000, Double_t startx=0, Double_t starty=0, Double_t startz=0, const char *target_vol=0, Bool_t check_norm=kFALSE)
 Random raytracing method. More...
 
void Raytrace (Bool_t flag=kTRUE)
 Draw this volume with current settings and perform raytracing in the pad. More...
 
void RegisterYourself (Option_t *option="")
 Register the volume and all materials/media/matrices/shapes to the manager. More...
 
void Release ()
 
void RemoveNode (TGeoNode *node)
 Remove an existing daughter. More...
 
TGeoNodeReplaceNode (TGeoNode *nodeorig, TGeoShape *newshape=0, TGeoMatrix *newpos=0, TGeoMedium *newmed=0)
 Replace an existing daughter with a new volume having the same name but possibly a new shape, position or medium. More...
 
void ReplayCreation (const TGeoVolume *other)
 Recreate the content of the other volume without pointer copying. More...
 
void SaveAs (const char *filename, Option_t *option="") const
 Save geometry having this as top volume as a C++ macro. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SelectVolume (Bool_t clear=kFALSE)
 Select this volume as matching an arbitrary criteria. More...
 
void SetActiveDaughters (Bool_t flag=kTRUE)
 
void SetActivity (Bool_t flag=kTRUE)
 
void SetAdded ()
 
void SetAsTopVolume ()
 Set this volume as the TOP one (the whole geometry starts from here) More...
 
void SetAttVisibility (Bool_t vis)
 
void SetCurrentPoint (Double_t x, Double_t y, Double_t z)
 Set the current tracking point. More...
 
void SetCylVoxels (Bool_t flag=kTRUE)
 
void SetField (TObject *field)
 
void SetFinder (TGeoPatternFinder *finder)
 
void SetFWExtension (TGeoExtension *ext)
 Connect framework defined extension to the volume. More...
 
void SetInvisible ()
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style. More...
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width. More...
 
virtual void SetMedium (TGeoMedium *medium)
 
void SetNodes (TObjArray *nodes)
 
void SetNtotal (Int_t ntotal)
 
void SetNumber (Int_t number)
 
void SetOption (const char *option)
 Set the current options (none implemented) More...
 
void SetOverlappingCandidate (Bool_t flag)
 
void SetReplicated ()
 
void SetShape (const TGeoShape *shape)
 set the shape associated with this volume More...
 
void SetTransparency (Char_t transparency=0)
 
void SetUserExtension (TGeoExtension *ext)
 Connect user-defined extension to the volume. More...
 
virtual void SetVisContainers (Bool_t flag=kTRUE)
 Set visibility for containers. More...
 
virtual void SetVisibility (Bool_t vis=kTRUE)
 set visibility of this volume More...
 
virtual void SetVisLeaves (Bool_t flag=kTRUE)
 Set visibility for leaves. More...
 
virtual void SetVisOnly (Bool_t flag=kTRUE)
 Set visibility for leaves. More...
 
void SetVoxelFinder (TGeoVoxelFinder *finder)
 
void SortNodes ()
 sort nodes by decreasing volume of the bounding box. More...
 
void UnmarkSaved ()
 Reset SavePrimitive bits. More...
 
Bool_t Valid () const
 Check if the shape of this volume is valid. More...
 
void VisibleDaughters (Bool_t vis=kTRUE)
 set visibility for daughters More...
 
void Voxelize (Option_t *option)
 build the voxels for this volume More...
 
Double_t Weight (Double_t precision=0.01, Option_t *option="va")
 Estimate the weight of a volume (in kg) with SIGMA(M)/M better than PRECISION. More...
 
Double_t WeightA () const
 Analytical computation of the weight. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TGeoAtt
 TGeoAtt ()
 Default constructor. More...
 
 TGeoAtt (Option_t *vis_opt, Option_t *activity_opt="", Option_t *optimization_opt="")
 Constructor. More...
 
virtual ~TGeoAtt ()
 Destructor. More...
 
Bool_t IsActive () const
 
Bool_t IsActiveDaughters () const
 
Bool_t IsVisBranch () const
 
Bool_t IsVisContainers () const
 
Bool_t IsVisDaughters () const
 
Bool_t IsVisible () const
 
Bool_t IsVisLeaves () const
 
Bool_t IsVisOnly () const
 
Bool_t IsVisRaytrace () const
 
Bool_t IsVisStreamed () const
 
Bool_t IsVisTouched () const
 
void ResetAttBit (UInt_t f)
 
void SetActiveDaughters (Bool_t flag=kTRUE)
 
void SetActivity (Bool_t flag=kTRUE)
 
void SetAttBit (UInt_t f)
 
void SetAttBit (UInt_t f, Bool_t set)
 
void SetOptimization (Option_t *option)
 Set optimization flags. More...
 
void SetVisBranch ()
 Set branch type visibility. More...
 
virtual void SetVisContainers (Bool_t flag=kTRUE)
 Set branch type visibility. More...
 
void SetVisDaughters (Bool_t vis=kTRUE)
 Set visibility for the daughters. More...
 
virtual void SetVisibility (Bool_t vis=kTRUE)
 Set visibility for this object. More...
 
virtual void SetVisLeaves (Bool_t flag=kTRUE)
 Set branch type visibility. More...
 
virtual void SetVisOnly (Bool_t flag=kTRUE)
 Set branch type visibility. More...
 
void SetVisRaytrace (Bool_t flag=kTRUE)
 
void SetVisStreamed (Bool_t vis=kTRUE)
 Mark attributes as "streamed to file". More...
 
void SetVisTouched (Bool_t vis=kTRUE)
 Mark visualization attributes as "modified". More...
 
Bool_t TestAttBit (UInt_t f) const
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor. More...
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor. More...
 
virtual ~TAttLine ()
 AttLine destructor. More...
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine. More...
 
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
 Compute distance from point px,py to a line. More...
 
virtual Color_t GetLineColor () const
 Return the line color. More...
 
virtual Style_t GetLineStyle () const
 Return the line style. More...
 
virtual Width_t GetLineWidth () const
 Return the line width. More...
 
virtual void Modify ()
 Change current line attributes if necessary. More...
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values. More...
 
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
 Save line attributes as C++ statement(s) on output stream out. More...
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes. More...
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color. More...
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style. More...
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width. More...
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 AttFill default constructor. More...
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor. More...
 
virtual ~TAttFill ()
 AttFill destructor. More...
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill. More...
 
virtual Color_t GetFillColor () const
 Return the fill area color. More...
 
virtual Style_t GetFillStyle () const
 Return the fill area style. More...
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary. More...
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values. More...
 
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
 Save fill attributes as C++ statement(s) on output stream out. More...
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes. More...
 
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color. More...
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style. More...
 
- Public Member Functions inherited from TAtt3D
 TAtt3D ()
 
virtual ~TAtt3D ()
 
virtual void Sizeof3D () const
 Set total size of this 3D object (used by X3D interface). More...
 

Static Public Member Functions

static void CreateDummyMedium ()
 Create a dummy medium. More...
 
static TGeoMediumDummyMedium ()
 
static TGeoVolumeImport (const char *filename, const char *name="", Option_t *option="")
 Import a volume from a file. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

 TGeoVolume (const TGeoVolume &)
 Transient framework-defined extension to volumes. More...
 
TGeoVolumeoperator= (const TGeoVolume &)
 assignment operator More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

TObjectfField
 pointer to TGeoManager owning this volume More...
 
TGeoPatternFinderfFinder
 dummy medium More...
 
TGeoExtensionfFWExtension
 Transient user-defined extension to volumes. More...
 
TGeoManagerfGeoManager
 
TGeoMediumfMedium
 
TObjArrayfNodes
 
Int_t fNtotal
 
Int_t fNumber
 option - if any More...
 
TString fOption
 just a hook for now More...
 
Int_t fRefCount
 
TGeoShapefShape
 
TGeoExtensionfUserExtension
 
TGeoVoxelFinderfVoxels
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TGeoAtt
UInt_t fGeoAtt
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color. More...
 
Style_t fLineStyle
 Line style. More...
 
Width_t fLineWidth
 Line width. More...
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 Fill area color. More...
 
Style_t fFillStyle
 Fill area style. More...
 

Static Protected Attributes

static TGeoMediumfgDummyMedium = 0
 

#include <TGeoVolume.h>

Inheritance diagram for TGeoVolume:
[legend]

Member Enumeration Documentation

◆ EGeoVolumeTypes

Enumerator
kVolumeReplicated 
kVolumeSelected 
kVolumeDiv 
kVolumeOverlap 
kVolumeImportNodes 
kVolumeMulti 
kVoxelsXYZ 
kVoxelsCyl 
kVolumeClone 
kVolumeAdded 
kVolumeOC 

Definition at line 79 of file TGeoVolume.h.

Constructor & Destructor Documentation

◆ TGeoVolume() [1/3]

TGeoVolume::TGeoVolume ( const TGeoVolume gv)
protected

Transient framework-defined extension to volumes.

copy constructor

Definition at line 501 of file TGeoVolume.cxx.

◆ TGeoVolume() [2/3]

TGeoVolume::TGeoVolume ( )

dummy constructor

Definition at line 447 of file TGeoVolume.cxx.

◆ TGeoVolume() [3/3]

TGeoVolume::TGeoVolume ( const char *  name,
const TGeoShape shape,
const TGeoMedium med = 0 
)

default constructor

Definition at line 468 of file TGeoVolume.cxx.

◆ ~TGeoVolume()

TGeoVolume::~TGeoVolume ( )
virtual

Destructor.

Definition at line 554 of file TGeoVolume.cxx.

Member Function Documentation

◆ AddNode()

void TGeoVolume::AddNode ( TGeoVolume vol,
Int_t  copy_no,
TGeoMatrix mat = 0,
Option_t option = "" 
)
virtual

Add a TGeoNode to the list of nodes.

This is the usual method for adding daughters inside the container volume.

Reimplemented in TGeoVolumeMulti, and TGeoVolumeAssembly.

Definition at line 984 of file TGeoVolume.cxx.

◆ AddNodeOffset()

void TGeoVolume::AddNodeOffset ( TGeoVolume vol,
Int_t  copy_no,
Double_t  offset = 0,
Option_t option = "" 
)

Add a division node to the list of nodes.

The method is called by TGeoVolume::Divide() for creating the division nodes.

Definition at line 1023 of file TGeoVolume.cxx.

◆ AddNodeOverlap()

void TGeoVolume::AddNodeOverlap ( TGeoVolume vol,
Int_t  copy_no,
TGeoMatrix mat = 0,
Option_t option = "" 
)
virtual

Add a TGeoNode to the list of nodes.

This is the usual method for adding daughters inside the container volume.

Reimplemented in TGeoVolumeAssembly, and TGeoVolumeMulti.

Definition at line 1048 of file TGeoVolume.cxx.

◆ Browse()

void TGeoVolume::Browse ( TBrowser b)
virtual

How to browse a volume.

Reimplemented from TObject.

Definition at line 571 of file TGeoVolume.cxx.

◆ Capacity()

Double_t TGeoVolume::Capacity ( ) const

Computes the capacity of this [cm^3] as the capacity of its shape.

In case of assemblies, the capacity is computed as the sum of daughter's capacities.

Definition at line 605 of file TGeoVolume.cxx.

◆ cd()

void TGeoVolume::cd ( Int_t  inode) const
virtual

Actualize matrix of node indexed <inode>

Definition at line 975 of file TGeoVolume.cxx.

◆ CheckGeometry()

void TGeoVolume::CheckGeometry ( Int_t  nrays = 1,
Double_t  startx = 0,
Double_t  starty = 0,
Double_t  startz = 0 
) const

Shoot nrays with random directions from starting point (startx, starty, startz) in the reference frame of this volume.

Track each ray until exiting geometry, then shoot backwards from exiting point and compare boundary crossing points.

Definition at line 620 of file TGeoVolume.cxx.

◆ CheckOverlaps()

void TGeoVolume::CheckOverlaps ( Double_t  ovlp = 0.1,
Option_t option = "" 
) const

Overlap checking tool.

Check for illegal overlaps within a limit OVLP. Use option="s[number]" to force overlap checking by sampling volume with [number] points.

Ex:

myVol->CheckOverlaps(0.01, "s10000000"); // shoot 10000000 points
myVol->CheckOverlaps(0.01, "s"); // shoot the default value of 1e6 points

Definition at line 641 of file TGeoVolume.cxx.

◆ CheckShape()

void TGeoVolume::CheckShape ( Int_t  testNo,
Int_t  nsamples = 10000,
Option_t option = "" 
)

Tests for checking the shape navigation algorithms. See TGeoShape::CheckShape()

Definition at line 675 of file TGeoVolume.cxx.

◆ CheckShapes()

void TGeoVolume::CheckShapes ( )

check for negative parameters in shapes.

Definition at line 700 of file TGeoVolume.cxx.

◆ CleanAll()

void TGeoVolume::CleanAll ( )

Clean data of the volume.

Definition at line 683 of file TGeoVolume.cxx.

◆ ClearNodes()

void TGeoVolume::ClearNodes ( )
inline

Definition at line 103 of file TGeoVolume.h.

◆ ClearShape()

void TGeoVolume::ClearShape ( )

Clear the shape of this volume from the list held by the current manager.

Definition at line 692 of file TGeoVolume.cxx.

◆ ClearThreadData()

void TGeoVolume::ClearThreadData ( ) const
virtual

Reimplemented in TGeoVolumeAssembly.

Definition at line 423 of file TGeoVolume.cxx.

◆ CloneNodesAndConnect()

void TGeoVolume::CloneNodesAndConnect ( TGeoVolume newmother) const

Clone the array of nodes.

Definition at line 1814 of file TGeoVolume.cxx.

◆ CloneVolume()

TGeoVolume * TGeoVolume::CloneVolume ( ) const
virtual

Clone this volume.

build a volume with same name, shape and medium

Reimplemented in TGeoVolumeAssembly.

Definition at line 1766 of file TGeoVolume.cxx.

◆ Contains()

Bool_t TGeoVolume::Contains ( const Double_t point) const
inline

Definition at line 112 of file TGeoVolume.h.

◆ CountNodes()

Int_t TGeoVolume::CountNodes ( Int_t  nlevels = 1000,
Int_t  option = 0 
)

Count total number of subnodes starting from this volume, nlevels down.

  • option = 0 (default) - count only once per volume
  • option = 1 - count every time
  • option = 2 - count volumes on visible branches
  • option = 3 - return maximum level counted already with option = 0

Definition at line 754 of file TGeoVolume.cxx.

◆ CreateDummyMedium()

void TGeoVolume::CreateDummyMedium ( )
static

Create a dummy medium.

Definition at line 411 of file TGeoVolume.cxx.

◆ CreateThreadData()

void TGeoVolume::CreateThreadData ( Int_t  nthreads)
virtual

Reimplemented in TGeoVolumeAssembly.

Definition at line 431 of file TGeoVolume.cxx.

◆ DistancetoPrimitive()

Int_t TGeoVolume::DistancetoPrimitive ( Int_t  px,
Int_t  py 
)
virtual

compute the closest distance of approach from point px,py to this volume

Reimplemented from TObject.

Definition at line 1185 of file TGeoVolume.cxx.

◆ Divide()

TGeoVolume * TGeoVolume::Divide ( const char *  divname,
Int_t  iaxis,
Int_t  ndiv,
Double_t  start,
Double_t  step,
Int_t  numed = 0,
Option_t option = "" 
)
virtual

Division a la G3.

The volume will be divided along IAXIS (see shape classes), in NDIV slices, from START with given STEP. The division volumes will have medium number NUMED. If NUMED=0 they will get the medium number of the divided volume (this). If NDIV<=0, all range of IAXIS will be divided and the resulting number of divisions will be centered on IAXIS. If STEP<=0, the real STEP will be computed as the full range of IAXIS divided by NDIV. Options (case insensitive):

  • N - divide all range in NDIV cells (same effect as STEP<=0) (GSDVN in G3)
  • NX - divide range starting with START in NDIV cells (GSDVN2 in G3)
  • S - divide all range with given STEP. NDIV is computed and divisions will be centered in full range (same effect as NDIV<=0) (GSDVS, GSDVT in G3)
  • SX - same as DVS, but from START position. (GSDVS2, GSDVT2 in G3)

Reimplemented in TGeoVolumeMulti, and TGeoVolumeAssembly.

Definition at line 1102 of file TGeoVolume.cxx.

◆ Draw()

void TGeoVolume::Draw ( Option_t option = "")
virtual

draw top volume according to option

Reimplemented from TObject.

Definition at line 1198 of file TGeoVolume.cxx.

◆ DrawOnly()

void TGeoVolume::DrawOnly ( Option_t option = "")
virtual

draw only this volume

Reimplemented in TGeoVolumeAssembly.

Definition at line 1215 of file TGeoVolume.cxx.

◆ DummyMedium()

TGeoMedium * TGeoVolume::DummyMedium ( )
static

Definition at line 439 of file TGeoVolume.cxx.

◆ ExecuteEvent()

void TGeoVolume::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
virtual

Execute mouse actions on this volume.

Reimplemented from TObject.

Definition at line 1654 of file TGeoVolume.cxx.

◆ Export()

Int_t TGeoVolume::Export ( const char *  filename,
const char *  name = "",
Option_t option = "" 
)

Export this volume to a file.

  • Case 1: root file or root/xml file if filename end with ".root". The key will be named name if filename end with ".xml" a root/xml file is produced.
  • Case 2: C++ script if filename end with ".C"
  • Case 3: gdml file if filename end with ".gdml"

NOTE that to use this option, the PYTHONPATH must be defined like export PYTHONPATH=$ROOTSYS/lib:$ROOTSYS/gdml

Definition at line 939 of file TGeoVolume.cxx.

◆ FindMatrixOfDaughterVolume()

Bool_t TGeoVolume::FindMatrixOfDaughterVolume ( TGeoVolume vol) const

Find a daughter node having VOL as volume and fill TGeoManager::fHMatrix with its global matrix.

Definition at line 2312 of file TGeoVolume.cxx.

◆ FindNode()

TGeoNode * TGeoVolume::FindNode ( const char *  name) const

search a daughter inside the list of nodes

Definition at line 1664 of file TGeoVolume.cxx.

◆ FindOverlaps()

void TGeoVolume::FindOverlaps ( ) const

loop all nodes marked as overlaps and find overlapping brothers

Definition at line 2141 of file TGeoVolume.cxx.

◆ GetByteCount()

Int_t TGeoVolume::GetByteCount ( ) const
virtual

get the total size in bytes for this volume

Definition at line 2121 of file TGeoVolume.cxx.

◆ GetCurrentNodeIndex()

virtual Int_t TGeoVolume::GetCurrentNodeIndex ( ) const
inlinevirtual

Reimplemented in TGeoVolumeAssembly.

Definition at line 168 of file TGeoVolume.h.

◆ GetField()

TObject * TGeoVolume::GetField ( ) const
inline

Definition at line 177 of file TGeoVolume.h.

◆ GetFinder()

TGeoPatternFinder * TGeoVolume::GetFinder ( ) const
inline

Definition at line 178 of file TGeoVolume.h.

◆ GetFWExtension()

TGeoExtension * TGeoVolume::GetFWExtension ( ) const
inline

Definition at line 139 of file TGeoVolume.h.

◆ GetGeoManager()

TGeoManager * TGeoVolume::GetGeoManager ( ) const
inline

Definition at line 174 of file TGeoVolume.h.

◆ GetIconName()

const char * TGeoVolume::GetIconName ( ) const
inlinevirtual

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented from TObject.

Definition at line 180 of file TGeoVolume.h.

◆ GetIndex()

Int_t TGeoVolume::GetIndex ( const TGeoNode node) const

get index number for a given daughter

Definition at line 1685 of file TGeoVolume.cxx.

◆ GetMaterial()

TGeoMaterial * TGeoVolume::GetMaterial ( ) const
inline

Definition at line 175 of file TGeoVolume.h.

◆ GetMedium()

TGeoMedium * TGeoVolume::GetMedium ( ) const
inline

Definition at line 176 of file TGeoVolume.h.

◆ GetNdaughters()

Int_t TGeoVolume::GetNdaughters ( ) const
inline

Definition at line 350 of file TGeoVolume.h.

◆ GetNextNodeIndex()

virtual Int_t TGeoVolume::GetNextNodeIndex ( ) const
inlinevirtual

Reimplemented in TGeoVolumeAssembly.

Definition at line 169 of file TGeoVolume.h.

◆ GetNode() [1/2]

TGeoNode * TGeoVolume::GetNode ( const char *  name) const

get the pointer to a daughter node

Definition at line 2111 of file TGeoVolume.cxx.

◆ GetNode() [2/2]

TGeoNode * TGeoVolume::GetNode ( Int_t  i) const
inline

Definition at line 183 of file TGeoVolume.h.

◆ GetNodeIndex()

Int_t TGeoVolume::GetNodeIndex ( const TGeoNode node,
Int_t check_list,
Int_t  ncheck 
) const

Get the index of a daughter within check_list by providing the node pointer.

Definition at line 1672 of file TGeoVolume.cxx.

◆ GetNodes()

TObjArray * TGeoVolume::GetNodes ( )
inline

Definition at line 170 of file TGeoVolume.h.

◆ GetNtotal()

Int_t TGeoVolume::GetNtotal ( ) const
inline

Definition at line 172 of file TGeoVolume.h.

◆ GetNumber()

Int_t TGeoVolume::GetNumber ( ) const
inline

Definition at line 185 of file TGeoVolume.h.

◆ GetObjectInfo()

char * TGeoVolume::GetObjectInfo ( Int_t  px,
Int_t  py 
) const
virtual

Get volume info for the browser.

Reimplemented from TObject.

Definition at line 1700 of file TGeoVolume.cxx.

◆ GetOptimalVoxels()

Bool_t TGeoVolume::GetOptimalVoxels ( ) const

Returns true if cylindrical voxelization is optimal.

Definition at line 1711 of file TGeoVolume.cxx.

◆ GetOption()

Option_t * TGeoVolume::GetOption ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 188 of file TGeoVolume.h.

◆ GetPointerName()

char * TGeoVolume::GetPointerName ( ) const

Provide a pointer name containing uid.

Definition at line 1729 of file TGeoVolume.cxx.

◆ GetRefCount()

Int_t TGeoVolume::GetRefCount ( ) const
inline

Definition at line 137 of file TGeoVolume.h.

◆ GetShape()

TGeoShape * TGeoVolume::GetShape ( ) const
inline

Definition at line 191 of file TGeoVolume.h.

◆ GetTransparency()

Char_t TGeoVolume::GetTransparency ( ) const
inline

Definition at line 190 of file TGeoVolume.h.

◆ GetUserExtension()

TGeoExtension * TGeoVolume::GetUserExtension ( ) const
inline

Definition at line 138 of file TGeoVolume.h.

◆ GetVoxels()

TGeoVoxelFinder * TGeoVolume::GetVoxels ( ) const

Getter for optimization structure.

Definition at line 1739 of file TGeoVolume.cxx.

◆ Grab()

void TGeoVolume::Grab ( )
inline

Definition at line 142 of file TGeoVolume.h.

◆ GrabFocus()

void TGeoVolume::GrabFocus ( )

Move perspective view focus to this volume.

Definition at line 1748 of file TGeoVolume.cxx.

◆ GrabFWExtension()

TGeoExtension * TGeoVolume::GrabFWExtension ( ) const

Get a copy of the framework extension pointer.

The user must call Release() on the copy pointer once this pointer is not needed anymore (equivalent to delete() after calling new())

Definition at line 1486 of file TGeoVolume.cxx.

◆ GrabUserExtension()

TGeoExtension * TGeoVolume::GrabUserExtension ( ) const

Get a copy of the user extension pointer.

The user must call Release() on the copy pointer once this pointer is not needed anymore (equivalent to delete() after calling new())

Definition at line 1475 of file TGeoVolume.cxx.

◆ Gsord()

void TGeoVolume::Gsord ( Int_t  )
inline

Definition at line 193 of file TGeoVolume.h.

◆ Import()

TGeoVolume * TGeoVolume::Import ( const char *  filename,
const char *  name = "",
Option_t option = "" 
)
static

Import a volume from a file.

Definition at line 889 of file TGeoVolume.cxx.

◆ InspectMaterial()

void TGeoVolume::InspectMaterial ( ) const

Inspect the material for this volume.

Definition at line 881 of file TGeoVolume.cxx.

◆ InspectShape()

void TGeoVolume::InspectShape ( ) const
inline

Definition at line 196 of file TGeoVolume.h.

◆ InvisibleAll()

void TGeoVolume::InvisibleAll ( Bool_t  flag = kTRUE)

Make volume and each of it daughters (in)visible.

Definition at line 816 of file TGeoVolume.cxx.

◆ IsActive()

Bool_t TGeoVolume::IsActive ( ) const
inline

Definition at line 146 of file TGeoVolume.h.

◆ IsActiveDaughters()

Bool_t TGeoVolume::IsActiveDaughters ( ) const
inline

Definition at line 147 of file TGeoVolume.h.

◆ IsAdded()

Bool_t TGeoVolume::IsAdded ( ) const
inline

Definition at line 148 of file TGeoVolume.h.

◆ IsAllInvisible()

Bool_t TGeoVolume::IsAllInvisible ( ) const

Return TRUE if volume and all daughters are invisible.

Definition at line 805 of file TGeoVolume.cxx.

◆ IsAssembly()

Bool_t TGeoVolume::IsAssembly ( ) const
virtual

Returns true if the volume is an assembly or a scaled assembly.

Reimplemented in TGeoVolumeAssembly.

Definition at line 1757 of file TGeoVolume.cxx.

◆ IsCylVoxels()

Bool_t TGeoVolume::IsCylVoxels ( ) const
inline

Definition at line 152 of file TGeoVolume.h.

◆ IsFolder()

Bool_t TGeoVolume::IsFolder ( ) const
virtual

Return TRUE if volume contains nodes.

Reimplemented from TObject.

Definition at line 844 of file TGeoVolume.cxx.

◆ IsOverlappingCandidate()

Bool_t TGeoVolume::IsOverlappingCandidate ( ) const
inline

Definition at line 149 of file TGeoVolume.h.

◆ IsRaytracing()

Bool_t TGeoVolume::IsRaytracing ( ) const

Check if the painter is currently ray-tracing the content of this volume.

Definition at line 873 of file TGeoVolume.cxx.

◆ IsReplicated()

Bool_t TGeoVolume::IsReplicated ( ) const
inline

Definition at line 150 of file TGeoVolume.h.

◆ IsRunTime()

Bool_t TGeoVolume::IsRunTime ( ) const
inline

Definition at line 117 of file TGeoVolume.h.

◆ IsSelected()

Bool_t TGeoVolume::IsSelected ( ) const
inline

Definition at line 151 of file TGeoVolume.h.

◆ IsStyleDefault()

Bool_t TGeoVolume::IsStyleDefault ( ) const

check if the visibility and attributes are the default ones

Definition at line 852 of file TGeoVolume.cxx.

◆ IsTopVolume()

Bool_t TGeoVolume::IsTopVolume ( ) const

True if this is the top volume of the geometry.

Definition at line 864 of file TGeoVolume.cxx.

◆ IsValid()

Bool_t TGeoVolume::IsValid ( ) const
inline

Definition at line 155 of file TGeoVolume.h.

◆ IsVisContainers()

Bool_t TGeoVolume::IsVisContainers ( ) const
inline

Definition at line 158 of file TGeoVolume.h.

◆ IsVisible()

virtual Bool_t TGeoVolume::IsVisible ( ) const
inlinevirtual

Reimplemented in TGeoVolumeAssembly.

Definition at line 156 of file TGeoVolume.h.

◆ IsVisibleDaughters()

Bool_t TGeoVolume::IsVisibleDaughters ( ) const
inline

Definition at line 157 of file TGeoVolume.h.

◆ IsVisLeaves()

Bool_t TGeoVolume::IsVisLeaves ( ) const
inline

Definition at line 159 of file TGeoVolume.h.

◆ IsVisOnly()

Bool_t TGeoVolume::IsVisOnly ( ) const
inline

Definition at line 160 of file TGeoVolume.h.

◆ IsVolumeMulti()

virtual Bool_t TGeoVolume::IsVolumeMulti ( ) const
inlinevirtual

Reimplemented in TGeoVolumeMulti.

Definition at line 118 of file TGeoVolume.h.

◆ IsXYZVoxels()

Bool_t TGeoVolume::IsXYZVoxels ( ) const
inline

Definition at line 153 of file TGeoVolume.h.

◆ LegoPlot()

TH2F * TGeoVolume::LegoPlot ( Int_t  ntheta = 20,
Double_t  themin = 0.,
Double_t  themax = 180.,
Int_t  nphi = 60,
Double_t  phimin = 0.,
Double_t  phimax = 360.,
Double_t  rmin = 0.,
Double_t  rmax = 9999999,
Option_t option = "" 
)

Generate a lego plot fot the top volume, according to option.

Definition at line 1317 of file TGeoVolume.cxx.

◆ MakeCopyNodes()

void TGeoVolume::MakeCopyNodes ( const TGeoVolume other)

make a new list of nodes and copy all nodes of other volume inside

Definition at line 1840 of file TGeoVolume.cxx.

◆ MakeCopyVolume()

TGeoVolume * TGeoVolume::MakeCopyVolume ( TGeoShape newshape)
virtual

make a copy of this volume build a volume with same name, shape and medium

Reimplemented in TGeoVolumeMulti.

Definition at line 1857 of file TGeoVolume.cxx.

◆ MakeReflectedVolume()

TGeoVolume * TGeoVolume::MakeReflectedVolume ( const char *  newname = "") const

Make a copy of this volume which is reflected with respect to XY plane.

Definition at line 1887 of file TGeoVolume.cxx.

◆ operator=()

TGeoVolume & TGeoVolume::operator= ( const TGeoVolume gv)
protected

assignment operator

Definition at line 526 of file TGeoVolume.cxx.

◆ OptimizeVoxels()

Bool_t TGeoVolume::OptimizeVoxels ( )

Perform an extensive sampling to find which type of voxelization is most efficient.

Definition at line 1236 of file TGeoVolume.cxx.

◆ Paint()

void TGeoVolume::Paint ( Option_t option = "")
virtual

paint volume

Reimplemented from TObject.

Definition at line 1256 of file TGeoVolume.cxx.

◆ Print()

void TGeoVolume::Print ( Option_t option = "") const
virtual

Print volume info.

Reimplemented from TNamed.

Definition at line 1246 of file TGeoVolume.cxx.

◆ PrintNodes()

void TGeoVolume::PrintNodes ( ) const

print nodes

Definition at line 1305 of file TGeoVolume.cxx.

◆ PrintVoxels()

void TGeoVolume::PrintVoxels ( ) const

Print the voxels for this volume.

Definition at line 1271 of file TGeoVolume.cxx.

◆ RandomPoints()

void TGeoVolume::RandomPoints ( Int_t  npoints = 1000000,
Option_t option = "" 
)

Draw random points in the bounding box of this volume.

Definition at line 1373 of file TGeoVolume.cxx.

◆ RandomRays()

void TGeoVolume::RandomRays ( Int_t  nrays = 10000,
Double_t  startx = 0,
Double_t  starty = 0,
Double_t  startz = 0,
const char *  target_vol = 0,
Bool_t  check_norm = kFALSE 
)

Random raytracing method.

Definition at line 1386 of file TGeoVolume.cxx.

◆ Raytrace()

void TGeoVolume::Raytrace ( Bool_t  flag = kTRUE)

Draw this volume with current settings and perform raytracing in the pad.

Definition at line 1399 of file TGeoVolume.cxx.

◆ RegisterYourself()

void TGeoVolume::RegisterYourself ( Option_t option = "")

Register the volume and all materials/media/matrices/shapes to the manager.

Definition at line 1333 of file TGeoVolume.cxx.

◆ Release()

void TGeoVolume::Release ( )
inline

Definition at line 143 of file TGeoVolume.h.

◆ RemoveNode()

void TGeoVolume::RemoveNode ( TGeoNode node)

Remove an existing daughter.

Definition at line 2162 of file TGeoVolume.cxx.

◆ ReplaceNode()

TGeoNode * TGeoVolume::ReplaceNode ( TGeoNode nodeorig,
TGeoShape newshape = 0,
TGeoMatrix newpos = 0,
TGeoMedium newmed = 0 
)

Replace an existing daughter with a new volume having the same name but possibly a new shape, position or medium.

Not allowed for positioned assemblies. For division cells, the new shape/matrix are ignored.

Definition at line 2176 of file TGeoVolume.cxx.

◆ ReplayCreation()

void TGeoVolume::ReplayCreation ( const TGeoVolume other)

Recreate the content of the other volume without pointer copying.

Voxels are ignored and supposed to be created in a later step via Voxelize.

Definition at line 1280 of file TGeoVolume.cxx.

◆ SaveAs()

void TGeoVolume::SaveAs ( const char *  filename,
Option_t option = "" 
) const
virtual

Save geometry having this as top volume as a C++ macro.

Reimplemented from TObject.

Definition at line 1418 of file TGeoVolume.cxx.

◆ SavePrimitive()

void TGeoVolume::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented from TObject.

Definition at line 1495 of file TGeoVolume.cxx.

◆ SelectVolume()

void TGeoVolume::SelectVolume ( Bool_t  clear = kFALSE)

Select this volume as matching an arbitrary criteria.

The volume is added to a static list and the flag TGeoVolume::kVolumeSelected is set. All flags need to be reset at the end by calling the method with CLEAR=true. This will also clear the list.

Definition at line 2227 of file TGeoVolume.cxx.

◆ SetActiveDaughters()

void TGeoVolume::SetActiveDaughters ( Bool_t  flag = kTRUE)
inline

Definition at line 211 of file TGeoVolume.h.

◆ SetActivity()

void TGeoVolume::SetActivity ( Bool_t  flag = kTRUE)
inline

Definition at line 210 of file TGeoVolume.h.

◆ SetAdded()

void TGeoVolume::SetAdded ( )
inline

Definition at line 213 of file TGeoVolume.h.

◆ SetAsTopVolume()

void TGeoVolume::SetAsTopVolume ( )

Set this volume as the TOP one (the whole geometry starts from here)

Definition at line 1976 of file TGeoVolume.cxx.

◆ SetAttVisibility()

void TGeoVolume::SetAttVisibility ( Bool_t  vis)
inline

Definition at line 223 of file TGeoVolume.h.

◆ SetCurrentPoint()

void TGeoVolume::SetCurrentPoint ( Double_t  x,
Double_t  y,
Double_t  z 
)

Set the current tracking point.

Definition at line 1984 of file TGeoVolume.cxx.

◆ SetCylVoxels()

void TGeoVolume::SetCylVoxels ( Bool_t  flag = kTRUE)
inline

Definition at line 216 of file TGeoVolume.h.

◆ SetField()

void TGeoVolume::SetField ( TObject field)
inline

Definition at line 221 of file TGeoVolume.h.

◆ SetFinder()

void TGeoVolume::SetFinder ( TGeoPatternFinder finder)
inline

Definition at line 234 of file TGeoVolume.h.

◆ SetFWExtension()

void TGeoVolume::SetFWExtension ( TGeoExtension ext)

Connect framework defined extension to the volume.

The volume "grabs" a copy, so the original object can be released by the producer. Release the previously connected extension if any.

NOTE: This interface is intended for the use by TGeo and the users should NOT connect extensions using this method

Definition at line 1463 of file TGeoVolume.cxx.

◆ SetInvisible()

void TGeoVolume::SetInvisible ( )
inline

Definition at line 231 of file TGeoVolume.h.

◆ SetLineColor()

void TGeoVolume::SetLineColor ( Color_t  lcolor)
virtual

Set the line color.

Reimplemented from TAttLine.

Reimplemented in TGeoVolumeMulti.

Definition at line 2087 of file TGeoVolume.cxx.

◆ SetLineStyle()

void TGeoVolume::SetLineStyle ( Style_t  lstyle)
virtual

Set the line style.

Reimplemented from TAttLine.

Reimplemented in TGeoVolumeMulti.

Definition at line 2095 of file TGeoVolume.cxx.

◆ SetLineWidth()

void TGeoVolume::SetLineWidth ( Width_t  lwidth)
virtual

Set the line width.

Reimplemented from TAttLine.

Reimplemented in TGeoVolumeMulti.

Definition at line 2103 of file TGeoVolume.cxx.

◆ SetMedium()

virtual void TGeoVolume::SetMedium ( TGeoMedium medium)
inlinevirtual

Reimplemented in TGeoVolumeMulti.

Definition at line 232 of file TGeoVolume.h.

◆ SetNodes()

void TGeoVolume::SetNodes ( TObjArray nodes)
inline

Definition at line 217 of file TGeoVolume.h.

◆ SetNtotal()

void TGeoVolume::SetNtotal ( Int_t  ntotal)
inline

Definition at line 236 of file TGeoVolume.h.

◆ SetNumber()

void TGeoVolume::SetNumber ( Int_t  number)
inline

Definition at line 235 of file TGeoVolume.h.

◆ SetOption()

void TGeoVolume::SetOption ( const char *  option)

Set the current options (none implemented)

Definition at line 2079 of file TGeoVolume.cxx.

◆ SetOverlappingCandidate()

void TGeoVolume::SetOverlappingCandidate ( Bool_t  flag)
inline

Definition at line 218 of file TGeoVolume.h.

◆ SetReplicated()

void TGeoVolume::SetReplicated ( )
inline

Definition at line 214 of file TGeoVolume.h.

◆ SetShape()

void TGeoVolume::SetShape ( const TGeoShape shape)

set the shape associated with this volume

Definition at line 1992 of file TGeoVolume.cxx.

◆ SetTransparency()

void TGeoVolume::SetTransparency ( Char_t  transparency = 0)
inline

Definition at line 220 of file TGeoVolume.h.

◆ SetUserExtension()

void TGeoVolume::SetUserExtension ( TGeoExtension ext)

Connect user-defined extension to the volume.

The volume "grabs" a copy, so the original object can be released by the producer. Release the previously connected extension if any.

NOTE: This interface is intended for user extensions and is guaranteed not to be used by TGeo

Definition at line 1448 of file TGeoVolume.cxx.

◆ SetVisContainers()

void TGeoVolume::SetVisContainers ( Bool_t  flag = kTRUE)
virtual

Set visibility for containers.

Reimplemented from TGeoAtt.

Definition at line 2266 of file TGeoVolume.cxx.

◆ SetVisibility()

void TGeoVolume::SetVisibility ( Bool_t  vis = kTRUE)
virtual

set visibility of this volume

Reimplemented from TGeoAtt.

Reimplemented in TGeoVolumeMulti.

Definition at line 2249 of file TGeoVolume.cxx.

◆ SetVisLeaves()

void TGeoVolume::SetVisLeaves ( Bool_t  flag = kTRUE)
virtual

Set visibility for leaves.

Reimplemented from TGeoAtt.

Definition at line 2278 of file TGeoVolume.cxx.

◆ SetVisOnly()

void TGeoVolume::SetVisOnly ( Bool_t  flag = kTRUE)
virtual

Set visibility for leaves.

Reimplemented from TGeoAtt.

Definition at line 2290 of file TGeoVolume.cxx.

◆ SetVoxelFinder()

void TGeoVolume::SetVoxelFinder ( TGeoVoxelFinder finder)
inline

Definition at line 233 of file TGeoVolume.h.

◆ SortNodes()

void TGeoVolume::SortNodes ( )

sort nodes by decreasing volume of the bounding box.

ONLY nodes comes first, then overlapping nodes and finally division nodes.

Definition at line 2005 of file TGeoVolume.cxx.

◆ UnmarkSaved()

void TGeoVolume::UnmarkSaved ( )

Reset SavePrimitive bits.

Definition at line 1644 of file TGeoVolume.cxx.

◆ Valid()

Bool_t TGeoVolume::Valid ( ) const

Check if the shape of this volume is valid.

Definition at line 2303 of file TGeoVolume.cxx.

◆ VisibleDaughters()

void TGeoVolume::VisibleDaughters ( Bool_t  vis = kTRUE)

set visibility for daughters

Definition at line 2343 of file TGeoVolume.cxx.

◆ Voxelize()

void TGeoVolume::Voxelize ( Option_t option)

build the voxels for this volume

Definition at line 2353 of file TGeoVolume.cxx.

◆ Weight()

Double_t TGeoVolume::Weight ( Double_t  precision = 0.01,
Option_t option = "va" 
)

Estimate the weight of a volume (in kg) with SIGMA(M)/M better than PRECISION.

Option can contain : v - verbose, a - analytical (default)

Definition at line 2386 of file TGeoVolume.cxx.

◆ WeightA()

Double_t TGeoVolume::WeightA ( ) const

Analytical computation of the weight.

Definition at line 2399 of file TGeoVolume.cxx.

Member Data Documentation

◆ fField

TObject* TGeoVolume::fField
protected

pointer to TGeoManager owning this volume

Definition at line 63 of file TGeoVolume.h.

◆ fFinder

TGeoPatternFinder* TGeoVolume::fFinder
protected

dummy medium

Definition at line 59 of file TGeoVolume.h.

◆ fFWExtension

TGeoExtension* TGeoVolume::fFWExtension
protected

Transient user-defined extension to volumes.

Definition at line 69 of file TGeoVolume.h.

◆ fgDummyMedium

TGeoMedium * TGeoVolume::fgDummyMedium = 0
staticprotected

Definition at line 58 of file TGeoVolume.h.

◆ fGeoManager

TGeoManager* TGeoVolume::fGeoManager
protected

Definition at line 61 of file TGeoVolume.h.

◆ fMedium

TGeoMedium* TGeoVolume::fMedium
protected

Definition at line 57 of file TGeoVolume.h.

◆ fNodes

TObjArray* TGeoVolume::fNodes
protected

Definition at line 55 of file TGeoVolume.h.

◆ fNtotal

Int_t TGeoVolume::fNtotal
protected

Definition at line 66 of file TGeoVolume.h.

◆ fNumber

Int_t TGeoVolume::fNumber
protected

option - if any

Definition at line 65 of file TGeoVolume.h.

◆ fOption

TString TGeoVolume::fOption
protected

just a hook for now

Definition at line 64 of file TGeoVolume.h.

◆ fRefCount

Int_t TGeoVolume::fRefCount
protected

Definition at line 67 of file TGeoVolume.h.

◆ fShape

TGeoShape* TGeoVolume::fShape
protected

Definition at line 56 of file TGeoVolume.h.

◆ fUserExtension

TGeoExtension* TGeoVolume::fUserExtension
protected

Definition at line 68 of file TGeoVolume.h.

◆ fVoxels

TGeoVoxelFinder* TGeoVolume::fVoxels
protected

Definition at line 60 of file TGeoVolume.h.

Libraries for TGeoVolume:
[legend]

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