pylhe.LHEEvent

Bases: DictCompatibility

Store a single event in the LHE format.

__init__(eventinfo: LHEEventInfo, particles: list[LHEParticle], weights: dict[str | int, float] | None = None, attributes: dict[str, str] | None = None, optional: list[str] | None = None, _graph: Digraph | None = None) → None

Methods

`__init__`(eventinfo, particles[, weights, ...])
`clear`()
`get`(k[,d])
`items`()
`keys`()
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`setdefault`(k[,d])
`tolhe`([rwgt, weights])	Return the event as a string in LHE format.
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()

Attributes

`attributes`	Event attributes
`fieldnames`	Return the fieldnames.
`graph`	Get the graphviz.Digraph object.
`optional`	Optional '#' comments stored in the event
`weights`	Event weights
`eventinfo`	Event information
`particles`	List of particles in the event

attributes: dict[str, str] | None = None: Event attributes

clear() → None. Remove all items from D.

eventinfo: LHEEventInfo: Event information

property fieldnames: list[str]

Return the fieldnames.

For backward compatibility with versions < 1.0.0.

Deprecated since version 1.0.0: Listing fieldnames via object.fieldnames is deprecated and will be removed in a future version.

get(k[, d]) → D[k] if k in D, else d. d defaults to None.

property graph: Digraph

Get the graphviz.Digraph object. The user now has full control …

E.g., see the source with my_LHEEvent_instance.graph.source.

When not in notebooks the graph can easily be visualized with the graphviz.Digraph.render or graphviz.Digraph.view functions, e.g.: my_LHEEvent_instance.graph.render(filename=”test”, format=”pdf”, view=True, cleanup=True)

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

optional: list[str] | None = None: Optional ‘#’ comments stored in the event

particles: list[LHEParticle]: List of particles in the event

pop(k[, d]) → v, remove specified key and return the corresponding value.: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

tolhe(rwgt: bool = True, weights: bool = False) → str[source]

Return the event as a string in LHE format.

Args:: rwgt (bool): Include the weights in the ‘rwgt’ format. weights (bool): Include the weights in the ‘weights’ format.
Returns:: str: The event as a string in LHE format.

update([E, ]**F) → None. Update D from mapping/iterable E and F.: If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values

weights: dict[str | int, float] | None = None: Event weights