PDGHelpers.PDGParser Class Reference

Inheritance diagram for PDGHelpers.PDGParser:

Collaboration diagram for PDGHelpers.PDGParser:

Public Member Functions
def	__init__ (self, table, ranges)
def	accept (self, pdg)
def	parsePDGTABLE (self)
def	formatName (self, name, charge)
def	formatCharge (self, charge)
def	createList (self)

Public Attributes
	log
	table
	ranges
	extraParticles

Detailed Description

Definition at line 109 of file PDGHelpers.py.

Constructor & Destructor Documentation

__init__()

def PDGHelpers.PDGParser.__init__	(		self,
			table,
			ranges
	)

Definition at line 111 of file PDGHelpers.py.

    def __init__(self, table, ranges):
        self.log = logging.getLogger(__name__)
        self.table = table
        self.ranges = ranges
        self.extraParticles = {}
        self.parsePDGTABLE()
 

Member Function Documentation

accept()

def PDGHelpers.PDGParser.accept	(		self,
			pdg
	)

Function to determine which extra particles are added

Function checks the ranges member variable
and evaluates whether the particle should be accepted.

TODO Consider adding a Sim.ExtraParticlesRanges ConfigFlag

For example, '111-556,1112-9090226' matches everything from
111 to 555 and 1112 to 9090225.

Definition at line 118 of file PDGHelpers.py.

    def accept(self, pdg):
        """Function to determine which extra particles are added
 
        Function checks the ranges member variable
        and evaluates whether the particle should be accepted.
 
        TODO Consider adding a Sim.ExtraParticlesRanges ConfigFlag
 
        For example, '111-556,1112-9090226' matches everything from
        111 to 555 and 1112 to 9090225.
        """
        ranges = [r.split("-") for r in self.ranges.split(",")]
        for r in ranges:
            if int(r[0]) <= pdg < int(r[1]):
                return True
 

createList()

def PDGHelpers.PDGParser.createList

(

self

)

Definition at line 222 of file PDGHelpers.py.

    def createList(self):
        pdgcodes = [ self.extraParticles[name].pdg for name in self.extraParticles ]
        updateExtraParticleAcceptList('G4particle_acceptlist_ExtraParticles.txt', pdgcodes)
 
        # generate output in correct format
        outDict = dict()
        for name in self.extraParticles:
            outDict.update({name: [
                self.extraParticles[name].mass,
                self.extraParticles[name].width,
                self.extraParticles[name].charge,
                self.extraParticles[name].pdg,
                self.extraParticles[name].lifetime
            ]})
 
        return outDict

formatCharge()

def PDGHelpers.PDGParser.formatCharge	(		self,
			charge
	)

Definition at line 206 of file PDGHelpers.py.

    def formatCharge(self, charge):
        # check that all characters are the same
        # e.g.: '0', '+', '--', ...
        if not (charge == len(charge) * charge[0]):
            raise ValueError('Unexpected charge %s' % charge)
 
        # parse string
        if '+' in charge:
            return len(charge)
        elif '-' in charge:
            return -len(charge)
        elif '0' in charge:
            return 0
        else:
            raise ValueError('Unexpected charge %s' % charge)
 

formatName()

def PDGHelpers.PDGParser.formatName	(		self,
			name,
			charge
	)

Definition at line 200 of file PDGHelpers.py.

    def formatName(self, name, charge):
        nameOut = name
        nameOut = nameOut.replace("*", "_star").replace("'", "_prime")
        nameOut += charge
        return nameOut
 

parsePDGTABLE()

def PDGHelpers.PDGParser.parsePDGTABLE

(

self

)

Definition at line 134 of file PDGHelpers.py.

    def parsePDGTABLE(self):
 
        # parse the PDGTABLE
        with open(self.table, 'r') as f:
            for line in f:
                if line.startswith('*'):
                    # Comments start with '*'
                    continue
                splitLine = line.split()
 
                # Name of the particle
                baseName = splitLine[-2]
 
                # Number of particle entries
                charges = splitLine[-1].split(',')
 
                # Mass or Width
                prop = ''
                symbol = splitLine[0]
                if symbol == 'M':
                    prop = 'mass'
                elif symbol == 'W':
                    prop = 'width'
                else:
                    raise ValueError(
                        'Unidentified symbol %s for particle %s' % (
                            symbol, baseName))
 
                pdgs = splitLine[1:1+len(charges)]
                value = float(splitLine[1+len(charges)])
 
                for pdg, charge in zip(pdgs, charges):
                    if not self.accept(int(pdg)):
                        continue
                    name = self.formatName(baseName, charge)
                    kwargs = dict()
                    kwargs.setdefault('name', name)
                    kwargs.setdefault(prop, value * MeV)
                    kwargs.setdefault('pdg', int(pdg))
                    kwargs.setdefault('charge', self.formatCharge(charge))
                    if name not in self.extraParticles.keys():
                        self.extraParticles[name] = ExtraParticle(**kwargs)
                    else:
                        if getattr(self.extraParticles[name], prop) != -1:
                            self.log.warning(
                                "Property %s is already"
                                "set for particle %s."
                                "Current value is %s and"
                                "incoming value is %s.",
                                prop, name,
                                getattr(self.extraParticles[name], prop),
                                value)
                            continue
                        setattr(self.extraParticles[name], prop, value)
 
        for name in self.extraParticles:
            # calculate lifetime
            width = self.extraParticles[name].width
            if width > 0:
                self.extraParticles[name].lifetime = hbar_Planck/width
 
        # create anti-particles
        for name in [x for x in self.extraParticles.keys()]:
            antiParticle = -self.extraParticles[name]
            self.extraParticles.update({antiParticle.name: antiParticle})
 

Member Data Documentation

extraParticles

PDGHelpers.PDGParser.extraParticles

Definition at line 115 of file PDGHelpers.py.

log

PDGHelpers.PDGParser.log

Definition at line 112 of file PDGHelpers.py.

ranges

PDGHelpers.PDGParser.ranges

Definition at line 114 of file PDGHelpers.py.

table

PDGHelpers.PDGParser.table

Definition at line 113 of file PDGHelpers.py.

---

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

• PDGHelpers.py