LHETools.Event Class Reference

Inheritance diagram for LHETools.Event:

Collaboration diagram for LHETools.Event:

Public Member Functions
def	__init__ (self, info, particles, extra_lines=None, spurious_event_markup=False)
def	from_lines (cls, lines)
def	is_buggy (self)
def	to_string (self)
def	__len__ (self)
def	__getitem__ (self, index)
def	__delitem__ (self, index)

Public Attributes
	info
	particles
	extra_lines
	spurious_event_markup

Detailed Description

Definition at line 98 of file LHETools.py.

Constructor & Destructor Documentation

__init__()

def LHETools.Event.__init__	(		self,
			info,
			particles,
			extra_lines = None,
			spurious_event_markup = False
	)

Definition at line 99 of file LHETools.py.

    def __init__(self, info, particles, extra_lines=None, spurious_event_markup=False):
        self.info = info
        self.particles = particles
        self.extra_lines = extra_lines or []
        self.spurious_event_markup = spurious_event_markup
 
        for p in self.particles:
            p.event = self
 

Member Function Documentation

__delitem__()

def LHETools.Event.__delitem__	(		self,
			index
	)

Definition at line 168 of file LHETools.py.

    def __delitem__(self, index):
        if not isinstance(index, (int)):
            LHEToolsLog.error("Index must be integer")
            raise TypeError
 
        # When removing a particle at a location ``index`` -- which corresponds
        # to LHE id ``i_lhe`` -- we need to correct two things:
        #
        #   1.) Any particle that had ``i_lhe`` as mother, needs to get the
        #       mother of the particle to be removed as mother.
        #
        #          - If both have exactly one mother, perform the replacement
        #            verbatim.
        #          - If the particle that is deleted has two mothers but the
        #            child particle has only one (the particle to be deleted),
        #            set the two mother reference of the child particle to the
        #            ones of the particle to be deleted.
        #          - If the particle that is deleted has one mother but the
        #            child particle has two, abort.
        #
        #   2.) Since we've changed the LHE indexing, any particle that had a
        #       mother reference ``mother > i_lhe`` must get a new mother
        #       reference ``mother - 1``
        p_rm = self[index]
        i_lhe = index + 1
 
        mo0, mo1 = p_rm.mother0, p_rm.mother1
        for p in self.particles:
            if p is p_rm:
                continue
 
            if p.mother0 == i_lhe or p.mother1 == i_lhe:
                if p.mother0 != p.mother1:
                    LHEToolsLog.error("Can not delete particle whose child has also other parents")
                    raise RuntimeError
 
                p.mother0 = mo0
                p.mother1 = mo1
 
        # Remove the particle.
        del self.particles[index]
 
        for p in self.particles:
            if p.mother0 > i_lhe:
                p.mother0 -= 1
            if p.mother1 > i_lhe:
                p.mother1 -= 1
 
        # Decrement the particle counter.
        self.info.nparticles -= 1
 
 

__getitem__()

def LHETools.Event.__getitem__	(		self,
			index
	)

Definition at line 161 of file LHETools.py.

    def __getitem__(self, index):
        if not isinstance(index, (int)):
            LHEToolsLog.error("Index must be integer")
            raise TypeError
 
        return self.particles[index]
 

__len__()

def LHETools.Event.__len__

(

self

)

Definition at line 158 of file LHETools.py.

    def __len__(self):
        return len(self.particles)
 

from_lines()

def LHETools.Event.from_lines	(		cls,
			lines
	)

Definition at line 109 of file LHETools.py.

    def from_lines(cls, lines):
        info = None
        particles = []
        extra_lines = []
        spurious_event_markup = False
        event_markup = re.compile('<event>')
 
        for i, datum in enumerate(lines):
            # there shouldn't be a <event> markup in the middle of the event record; if yes, we shouldn't keep the event
            if event_markup.match(datum):
                LHEToolsLog.warning("Spurious <event> markup was found in the middle of an event record. Probably the result of one event being incompletely written.")
                spurious_event_markup = True
            
            # The first line is the info block.
            if not info:
                info = EventInfo.from_string(datum)
                if info.invalid:
                    LHEToolsLog.warning("Could not retrieve EventInfo from input lhe file")
                continue
 
            # The lines [1, N_PARTICLE] define particles.
            if 1 <= i <= info.nparticles:
                p = Particle.from_string(datum)
                if p.invalid:
                    LHEToolsLog.warning("Could not retrieve Particle from input lhe file")
                particles.append(p)
                continue
 
            # All subsequent lines are additional configuration which is
            # retrieved but isn't parsed.
            extra_lines.append(datum)
 
        return cls(info=info,
                   particles=particles,
                   extra_lines=extra_lines,
                   spurious_event_markup=spurious_event_markup)
 

is_buggy()

def LHETools.Event.is_buggy

(

self

)

Definition at line 146 of file LHETools.py.

    def is_buggy(self):
        return self.info.invalid or self.spurious_event_markup or any(part.invalid for part in self.particles)
 
        

to_string()

def LHETools.Event.to_string

(

self

)

Definition at line 150 of file LHETools.py.

    def to_string(self):
        lines = [self.info.to_string() + '\n']
        for p in self.particles:
            lines.append(p.to_string() + '\n')
        lines.extend(self.extra_lines)
 
        return ''.join(lines)
 

Member Data Documentation

extra_lines

LHETools.Event.extra_lines

Definition at line 102 of file LHETools.py.

info

LHETools.Event.info

Definition at line 100 of file LHETools.py.

particles

LHETools.Event.particles

Definition at line 101 of file LHETools.py.

spurious_event_markup

LHETools.Event.spurious_event_markup

Definition at line 103 of file LHETools.py.

---

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

• LHETools.py