In This Package:

Helpers.py

Go to the documentation of this file.

#!/usr/bin/env python
''' Several helper classes to assist in configuring GenTools.  They
assume geometry has already been setup.  The helper classes that
produce tools need to define a "tools()" method that returns an
ordered list of what tools it created.  Users of these helper classes
should use them like:


 
'''

import GaudiKernel.SystemOfUnits as units
from GenTools.GenToolsConf import GtHepEvtGenTool, GtPositionerTool
from GenTools.GenToolsConf import GtGunGenTool, GtDiffuserBallTool
from GenTools.GenToolsConf import GtTimeratorTool, GtTransformTool
import LED

class Gun:
    '''
    Configure a particle gun based kinematics
    '''

    def __init__(self,
                 name = "gun",
                 volume = '/dd/Structure/AD/far-oil1',
                 gun = None,
                 positioner = None,
                 timerator = None,
                 transformer = None
                 ):

        '''Construct the configuration.  Coustom configured tools can
        be passed in or customization can be done after construction
        using the data members:

        .gun
        .positioner
        .timerator
        .transformer
        
        They can be accessed for additional, direct configuration.

        If the Volume property for the positioner and transformer is
        not yet set, it will be set to the value of "volume"
        '''

        if gun == None:
            gun = GtGunGenTool(name,
                               ParticlesPerEvent = 1,
                               ParticleName = 'e+',
                               Momentum = 3*units.MeV,
                               MomentumMode = 'Fixed',
                               DirectionMode = 'Fixed',
                               Direction = [1,0,0])
        if positioner == None:
            positioner = GtPositionerTool(name+"Positioner",
                                          Mode = 'Fixed',
                                          Position = [0,0,0])
        if timerator == None:
            timerator = GtTimeratorTool(name+"Timerator",
                                        LifeTime = 1*units.second)
        if transformer == None:
            transformer = GtTransformTool(name+"Transformer")

        try: 
            v = positioner.Volume
        except AttributeError:
            positioner.Volume = volume
            
        try:
            v = transformer.Volume
        except AttributeError:
            transformer.Volume = volume

        self.gun = gun
        self.positioner = positioner
        self.timerator = timerator
        self.transformer = transformer
        return

    def setVolume(self,volumename):
        self.positioner.Volume = volumename
        self.transformer.Volume = volumename
        return

    def tools(self):
        return [self.gun,self.positioner,self.timerator,self.transformer]

    pass # end Gun


class DiffuserBall:
    '''
    Configure a calibration diffuser ball
    '''

    def __init__(self,
                 name = "deployedLed_ad1",
                 volume = '/dd/Structure/AD/db-oil1',
                 ball = None,
                 positioner = None,
                 timerator = None,
                 transformer = None,
                 useGeometry = True
                 ):

        '''Construct the configuration.  Custom configured tools can
        be passed in or customization can be done after construction
        using the data members:

        .ball
        .positioner
        .timerator
        .transformer
        
        They can be accessed for additional, direct configuration.

        If the Volume property for the positioner and transformer is
        not yet set, it will be set to the value of "volume"
        '''

        if ball == None:
            ball = GtDiffuserBallTool(name+"ball",
                                      PhotonsPerEvent = 3500,
                                      WavelengthMode = 'Defined',
                                      Wavelength = 430.0*units.nanometer,
                                      WavelengthSpread = 5.0*units.nanometer,
                                      PdfWave = LED.PdfWave(),
                                      PdfEdgesWave = LED.PdfEdgesWave(),
                                      TimingMode = 'Defined',
                                      PdfTime = LED.PdfTime(),
                                      PdfEdgesTime = LED.PdfEdgesTime(),
                                      Radius = 0.9525*units.cm)
        if positioner == None:
            positioner = GtPositionerTool(name+"Positioner",
                                          Mode = 'Relative',
                                          Position = [0,0,0])
        if timerator == None:
            timerator = GtTimeratorTool(name+"Timerator",
                                        Mode = 'Relative',
                                        Distribution = 'Uniform',
                                        LifeTime = 1.0/(500.0*units.hertz))
        if transformer == None:
            transformer = GtTransformTool(name+"Transformer")
        self.geometryTool = None
        if useGeometry:
            from DetHelpers.DetHelpersConf import AutoPositionerTool
            self.geometryTool =  AutoPositionerTool("diffuserBallGeomPos",
                              PhysicalVolume = "pvDiffuserBall",
                              LogicalVolume = "/dd/Geometry/CalibrationSources/lvLedSourceAssy",
                              CoordinateDetElem = "/dd/Structure/AD/db-oil1",
                              Position = [0., 0., 0.],
                              Element = "db-ad1-deployedLed",
                              ElementPath = "/dd/Structure/CalibrationSources")

        self.ball = ball
        self.positioner = positioner
        self.timerator = timerator
        self.transformer = transformer
        if useGeometry:
            self.ball.GeomPosTool = self.geometryTool
        else:
            self.ball.GeomPosTool = ""
        self.setVolume( volume )
        return

    def setVolume(self,volumename):
        self.positioner.Volume = volumename
        self.transformer.Volume = volumename
        if self.geometryTool != None:
            self.geometryTool.CoordinateDetElem = volumename
        return

    def setPosition(self, position):
        self.positioner.Position = position
        if self.geometryTool != None:
            self.geometryTool.Position = position

    def tools(self):
        return [self.ball,self.positioner,self.timerator,self.transformer]

    pass # end DiffuserBall


class HepEVT:
    '''
    Configure kinematics to use a HepEVT source.
    '''

    def __init__(self,
                 hepEvtDataSource,
                 name = None,
                 positioner = None,
                 timerator = None,
                 transformer = None
                 ):
        ''' Configure for a HepEVT data source.  First argument is the
        data source and must be specified.  If it is an executable
        source the last character in the string must be a pipe ('|')
        and if the executable is not specified with an absolute path
        it will be looked up using your PATH environment variable.
        You may specify the "positioner", "timerator", and "transformer" tools or later
        configure them through the members of these same names.
        '''

        exe = hepEvtDataSource.split(' ')[0]
        if name == None:
            # Automatically set name based on executable
            exeName = exe[exe.rfind('/')+1:]
            dot = exeName.rfind('.')
            basename = exeName
            if dot > 0: basename = exeName[:dot]
            sanitized = basename.replace('.','_')
            name = sanitized

        # If we got an executable and it is relative, look for it in the path
        if hepEvtDataSource[-1] == '|' and hepEvtDataSource[0] != '/':
            import os, os.path
            path = os.getenv('PATH')
            for p in path:
                if (os.path.isfile(path+'/'+exe)):
                    hepEvtDataSource = path+'/'+exe + ' ' + ' '.join(hepEvtDataSource.split(' ')[1:])
                    break
                continue
            pass
        
        self.hepevt = GtHepEvtGenTool(name+'HepEvt',
                                      HepEvtDataSource = hepEvtDataSource)
        if positioner == None:
            positioner = GtPositionerTool(name+"Positioner")
        if timerator == None:
            timerator = GtTimeratorTool(name+"Timerator",
                                        LifeTime = 1*units.second)
        if transformer == None:
            transformer = GtTransformTool(name+"Transformer")


        self.positioner = positioner
        
        self.timerator = timerator
        
        self.transformer = transformer

        return

    def tools(self):
        return [self.hepevt,self.positioner,self.timerator,self.transformer]

    pass # End HepEVT

---