In This Package:

geometry.py

Go to the documentation of this file.

#!/usr/bin/env python
"""
Module to assist in writing geometry.xml content.
"""

import reference

class Logvol(reference.Referable):
    "A <logvol>"
    def __init__(self,name,material,shape,physvols=[]):
        reference.Referable.__init__(self,name)
        self.material = material
        self.shape = shape
        self.physvols = physvols
        return

    def xml(self,fo,pre):
        "Output self as XML to file object fo, prefacing each line with pre"
        fo.write('%s<logvol name="%s" material="%s">\n'%(pre,self.name,self.material))
        self.shape.xml(fo,pre+'  ')
        for pv in self.physvols:
            pv.xml(fo,pre+'  ')
        fo.write('%s</logvol>\n'%pre)
        return

class Physvol:
    "A <physvol>"
    def __init__(self,name,logvol,pos=None,rot=None):
        self.name = name
        self.logvol = logvol
        self.pos = pos
        self.rot = rot
        return

    def xml(self,fo,pre):

        if self.logvol.__class__ == Logvol:
            lvname = self.logvol.full_path
        else:
            lvname = self.logvol

        fo.write('%s<physvol name="%s" logvol="%s">\n'%(pre,self.name,lvname))
        if self.pos: self.pos.xml(fo,pre+'  ')
        if self.rot: self.rot.xml(fo,pre+'  ')
        fo.write('%s</physvol>\n'%pre)
        return


### this isn't actually supported.
# class Physvolref:
#     "A <physvolref/>"
#     def __init__(self,url):
#         self.url = url
#         return
#
#     def xml(self,fo,pre):
#         fo.write('%s<physvolref href="%s"/>\n'%(pre,self.url))

class Boolean:
    "A boolean shape, <subtraction>, etc"
    def __init__(self,type,name,primary,secondaries=[]):
        self.type = type
        self.name = name
        self.primary = primary
        self.secondaries = secondaries
        return

    def xml(self,fo,pre):
        "Output self as XML to file object fo, prefacing each line with pre"
        fo.write('%s<%s name="%s">\n'%(pre,self.type,self.name))
        self.primary.xml(fo,pre+'  ')
        for sec in self.secondaries:
            sec.xml(fo,pre+'  ')
        fo.write('%s</%s>\n'%(pre,self.type))
        return

class BooleanSecondary:
    "A shape + position + rotation"
    def __init__(self,shape,pos,rot):
        self.shape = shape
        self.pos = pos
        self.rot = rot
        return
    def xml(self,fo,pre):
        "Output self as XML to file object fo, prefacing each line with pre"
        for thing in [self.shape, self.pos, self.rot]:
            thing.xml(fo,pre)
        return

class Box:
    "A box shape"
    def __init__(self,name,sizeX=None,sizeY=None,sizeZ=None):
        self.name = name
        self.sizeX = sizeX
        self.sizeY = sizeY
        self.sizeZ = sizeZ
        return
    def xml(self,fo,pre):
        fo.write('%s<box name="%s"'%(pre,self.name))
        if self.sizeX: fo.write(' sizeX="%s"'%self.sizeX)
        if self.sizeY: fo.write(' sizeY="%s"'%self.sizeY)
        if self.sizeZ: fo.write(' sizeZ="%s"'%self.sizeZ)
        fo.write(' />\n')
        return

class Tubs:
    "A cylindrical shape"
    def __init__(self,name,sizeZ,outerRad,innerRad=None,initPhi=None,dPhi=None):
        self.name=name
        self.sizeZ=sizeZ
        self.outerRad=outerRad
        self.innerRad=innerRad
        self.initPhi=initPhi
        self.dPhi=dPhi
        return

    def xml(self,fo,pre):
        fo.write('%s<tubs name="%s"'%(pre,self.name))
        fo.write(' sizeZ="%s"'%self.sizeZ)
        if self.outerRad: fo.write(' outerRadius="%s"'%self.outerRad)
        if self.innerRad: fo.write(' innerRadius="%s"'%self.innerRad)
        if self.initPhi:  fo.write(' startPhiAngle="%s"'%self.initPhi)
        if self.dPhi:     fo.write(' deltaPhiAngle="%s"'%self.dPhi)
        fo.write(' />\n')
        return;

class zPlane:
    "A zplane element for PolyCone"
    def __init__(self, z, outerRadius, innerRadius=None):
        self.z=z
        self.outerRadius=outerRadius
        self.innerRadius=innerRadius
        return

    def xml(self, fo, pre):
        fo.write('%s<zplane'%pre+' ')
        fo.write('z="%s"\n'%self.z)
        fo.write('%souterRadius="%s"\n'%(pre+"        ", self.outerRadius))
        if self.innerRadius:
            fo.write('%sinnerRadius="%s"\n'%(pre+"        ", self.innerRadius))
        fo.write('%s        />\n'%pre)
        return

class polyCone:
    "A PolyCone with N sections"
    def __init__(self, name, zPos, outerRad, 
                 innerRad=None, initPhi=None, dPhi=None):
        self.zP=[]
        self.name=name
        self.initPhi=initPhi
        self.dPhi=dPhi
        self.nSection=len(zPos)
        print "polyCone # of zPlanes: ", self.nSection
        for i in range(self.nSection):
            if innerRad:
                self.zP.append(zPlane(zPos[i], outerRad[i], innerRad[i]))
            else: 
                self.zP.append(zPlane(zPos[i], outerRad[i]))
        return
    """
    def xml(self, fo, pre):
        fo.write('%s<polycone name="%s"'%(pre,self.name))
        if self.initPhi:  
            fo.write('\n%sstartPhiAngle="%s"'%(pre+'    ', self.initPhi))
        if self.dPhi:  
            fo.write('\n%sdeltaPhiAngle="%s"'%(pre+'    ', self.dPhi))
        fo.write('>\n')
        for i in range(self.nSection):
            self.zP[i].xml(fo, pre+'  ')
        fo.write('%s</polycone>\n'%pre)
        return;
    """
    def xml(self, fo, pre):
        if self.name in ["oav","lso","iav","gds"]:
            # Hack to use union of cylinder plus polycone
            fo.write('%s<union name="%s">\n'%(pre,self.name))
            fo.write('%s<tubs name="%s_cyl"\n'%(pre+'  ',self.name))
            fo.write('%s      sizeZ="%s"\n'%(pre+'  ',self.zP[1].z))
            fo.write('%s      outerRadius="%s"\n'%(pre+'  ',self.zP[1].outerRadius))
            fo.write('%s      />\n'%(pre+'  '))
            fo.write('%s<polycone name="%s_polycone"'%(pre+'  ',self.name))
            if self.initPhi:  
                fo.write('\n%sstartPhiAngle="%s"'%(pre+'      ', self.initPhi))
            if self.dPhi:  
                fo.write('\n%sdeltaPhiAngle="%s"'%(pre+'      ', self.dPhi))
            fo.write('>\n')
            for i in range(2,self.nSection):
                self.zP[i].xml(fo, pre+'    ')
            fo.write('%s</polycone>\n'%(pre+'  '))
            fo.write('%s<posXYZ z="-(%s)/2"/>\n'%(pre+'  ',self.zP[1].z))
            fo.write('%s</union>\n'%pre)
            return
        else:
            fo.write('%s<polycone name="%s"'%(pre,self.name))
            if self.initPhi:  
                fo.write('\n%sstartPhiAngle="%s"'%(pre+'    ', self.initPhi))
            if self.dPhi:  
                fo.write('\n%sdeltaPhiAngle="%s"'%(pre+'    ', self.dPhi))
            fo.write('>\n')
            for i in range(self.nSection):
                self.zP[i].xml(fo, pre+'  ')
            fo.write('%s</polycone>\n'%pre)
            return


class PosXYZ:
    'A cartesian placement'
    def __init__(self,X=None,Y=None,Z=None):
        self.X = X
        self.Y = Y
        self.Z = Z
        return
    def xml(self,fo,pre):
        fo.write('%s<posXYZ'%pre)
        if self.X: fo.write(' x="%s"'%self.X)
        if self.Y: fo.write(' y="%s"'%self.Y)
        if self.Z: fo.write(' z="%s"'%self.Z)
        fo.write(' />\n')
        return

class RotXYZ:
    'A rotation about the axes'
    def __init__(self,rotX=None,rotY=None,rotZ=None):
        self.rotX = rotX
        self.rotY = rotY
        self.rotZ = rotZ
        return
    def xml(self,fo,pre):
        fo.write('%s<rotXYZ'%pre)
        if self.rotX: fo.write(' rotX="%s"'%self.rotX)
        if self.rotY: fo.write(' rotY="%s"'%self.rotY)
        if self.rotZ: fo.write(' rotZ="%s"'%self.rotZ)
        fo.write(' />\n')
        return
    
if '__main__' == __name__:
    import sys

    # Logical volumes
    world = Logvol('lvWorld','Air',Box('world_box','10*m','10*m','10*m'))
    sd = Logvol('lvSubDetector','Water',Box('subdet_box','1*m','1*m','1*m'))
    ssd = Logvol('lvSubSubDetector','Iron',Box('subsubdet_box','10*cm','10*cm','10*cm'))

    # Catalogs
    from catalog import *
    from reference import *
    top = Catalog("Geometry", [world])
    sc = Catalog("Sub",[sd])
    ssc = Catalog("SubSub",[ssd])
    top.refs=[Reference("#Sub",sc),Reference("#SubSub",ssc)]

    # Physical volumes
    world.physvols = [Physvol('pvSubDet1',sd,PosXYZ(Z="5*m")),
                      Physvol('pvSubDet2',sd,PosXYZ(Z="-5*m"))]
    sd.physvols = [Physvol('pvSubSubDet',ssd,RotXYZ(rotZ="45*degree"))]

    # Dump
    for c in [top, sc, ssc]:
        c.xml(sys.stdout,'')

    pass

---