pdg.decay module

Classes supporting decays and branching fractions/ratios.

class pdg.decay.PdgBranchingFraction(api: PdgApi, pdgid: str, edition: str | None = None)[source]

Bases: PdgProperty

Class for all information about a decay.

This information includes the decay’s branching fraction, decay products, and subdecays.

Note

In most cases, user code should not need to call the constructor directly. Instead, the use of e.g. PdgApi.get is recommended.

Parameters:

  • api – A PdgApi object to be used for retrieving data.

  • pdgid – The PDG Identifier for the desired data.

  • edition – If set, and if the pdgid does not specify the edition, then the data will be looked up in this edition.

branching_ratios() → Iterator[PdgBranchingRatio][source]

Get iterator over all branching ratios associated with this branching fraction.

property decay_products: list[PdgDecayProduct][source]

A list of all PdgDecayProduct objects for the decay.

property is_subdecay: bool[source]

True if this is a subdecay (“indented”) decay mode.

property mode_number: int[source]

Mode number of this decay.

Note

The decay mode number may change from one edition of the Review of Particle Physics to the next one.

property subdecay_level: int[source]

Indentation level of a decay mode.

subdecays() → Iterator[PdgBranchingFraction][source]

Get iterator over all subdecays of this decay.

Note

Subdecay data is returned as-is from the Particle Listings. Its interpretation will depend on the conventions used by the specific section of the Listings.

class pdg.decay.PdgBranchingRatio(api: PdgApi, pdgid: str, edition: str | None = None)[source]

Bases: PdgProperty

Class for all information about a branching ratio.

Note

In most cases, user code should not need to call the constructor directly. Instead, the use of e.g. PdgApi.get is recommended.

Parameters:

  • api – A PdgApi object to be used for retrieving data.

  • pdgid – The PDG Identifier for the desired data.

  • edition – If set, and if the pdgid does not specify the edition, then the data will be looked up in this edition.

branching_fractions() → Iterator[PdgBranchingFraction][source]

Get iterator over all branching fractions associated with this branching ratio.

class pdg.decay.PdgDecayProduct(item: PdgItem, multiplier: int, subdecay: PdgBranchingFraction | None = None)[source]

Bases: object

Class for all information about one product of a decay.

This information includes the decay product’s PdgItem (which may resolve to one or more pdg.particle.PdgParticle objects), its multiplier, and its subdecay (if any).

Note

The constructor is intended for internal API use.

Parameters:

  • item – Corresponding PdgItem.

  • multiplier – Multiplicity of this product in the decay.

  • subdecay – Optional description of this product’s further decay.