pyhyperiso.core.Common.Mapper.DecayMapper Class Reference

Public Member Functions
	__init__ (self)

Static Public Member Functions
str	str (Union[Decays, DecayId] decay)
Decays	enum_elt_legacy (AnyStr name)
DecayId	id_of (Union[AnyStr, Decays] decay)
DecayId	to_id (Decays decay)
str	canonical (DecayId decay_id)
	get_str ()
	get_str_all ()
	get_enum ()
	get_observables (Union[Decays, DecayId, str] decay)
	get_observable_ids (Decays decay)
Decays	get_decay (Observables obs)
Optional[DecayId]	get_decay_id (Union[Observables, ObservableId] obs)
DecayId	get_decay_id_or_throw (ObservableId obs)
bool	has_observables (Union[Decays, DecayId, str] decay)
bool	register_custom_with_observables (str canonical, Sequence[Union[CustomObservableSpec, dict, tuple]] observables, Optional[Sequence[str]] aliases=None)

Detailed Description

Mapper for builtin and custom decays.

Definition at line 677 of file Mapper.py.

Constructor & Destructor Documentation

__init__()

pyhyperiso.core.Common.Mapper.DecayMapper.__init__

(

self

)

Definition at line 680 of file Mapper.py.

Member Function Documentation

canonical()

str pyhyperiso.core.Common.Mapper.DecayMapper.canonical ( DecayId  decay_id )

static

Return the canonical name of a dynamic decay id.

Definition at line 710 of file Mapper.py.

enum_elt_legacy()

Decays pyhyperiso.core.Common.Mapper.DecayMapper.enum_elt_legacy ( AnyStr  name )

static

Resolve a builtin decay name to the static enum.

Definition at line 693 of file Mapper.py.

get_decay()

Decays pyhyperiso.core.Common.Mapper.DecayMapper.get_decay ( Observables  obs )

static

Return the builtin decay enum associated with a builtin observable.

Definition at line 753 of file Mapper.py.

get_decay_id()

Optional[DecayId] pyhyperiso.core.Common.Mapper.DecayMapper.get_decay_id ( Union[Observables, ObservableId]  obs )

static

Return the dynamic parent decay id of an observable, if known.

Definition at line 758 of file Mapper.py.

get_decay_id_or_throw()

DecayId pyhyperiso.core.Common.Mapper.DecayMapper.get_decay_id_or_throw ( ObservableId  obs )

static

Return the dynamic parent decay id or raise from C++ if absent.

Definition at line 773 of file Mapper.py.

get_enum()

pyhyperiso.core.Common.Mapper.DecayMapper.get_enum ( )

static

Return builtin decay enum values.

Definition at line 725 of file Mapper.py.

get_observable_ids()

pyhyperiso.core.Common.Mapper.DecayMapper.get_observable_ids ( Decays  decay )

static

Return builtin decay observables converted to :class:`ObservableId`.

Definition at line 748 of file Mapper.py.

get_observables()

pyhyperiso.core.Common.Mapper.DecayMapper.get_observables ( Union[Decays, DecayId, str]  decay )

static

Return observables attached to a decay.

Returns:
    list[Observables] for builtin :class:`Decays` input, and
    list[ObservableId] for :class:`DecayId` or string input.

Definition at line 730 of file Mapper.py.

get_str()

pyhyperiso.core.Common.Mapper.DecayMapper.get_str ( )

static

Return builtin decay names.

Definition at line 715 of file Mapper.py.

get_str_all()

pyhyperiso.core.Common.Mapper.DecayMapper.get_str_all ( )

static

Return builtin and custom decay names.

Definition at line 720 of file Mapper.py.

has_observables()

bool pyhyperiso.core.Common.Mapper.DecayMapper.has_observables ( Union[Decays, DecayId, str]  decay )

static

Return whether a decay has at least one observable.

Definition at line 778 of file Mapper.py.

id_of()

DecayId pyhyperiso.core.Common.Mapper.DecayMapper.id_of ( Union[AnyStr, Decays]  decay )

static

Resolve a decay name/alias or enum to :class:`DecayId`.

Definition at line 698 of file Mapper.py.

register_custom_with_observables()

bool pyhyperiso.core.Common.Mapper.DecayMapper.register_custom_with_observables ( str  canonical, Sequence[Union[CustomObservableSpec, dict, tuple]]  observables, Optional[Sequence[str]]   aliases = None  )

static

Register a custom decay together with at least one observable.

Definition at line 789 of file Mapper.py.

str()

str pyhyperiso.core.Common.Mapper.DecayMapper.str ( Union[Decays, DecayId]  decay )

static

Return the canonical string for a builtin enum or dynamic id.

Definition at line 684 of file Mapper.py.

to_id()

DecayId pyhyperiso.core.Common.Mapper.DecayMapper.to_id ( Decays  decay )

static

Convert a builtin decay enum to a dynamic :class:`DecayId`.

Definition at line 705 of file Mapper.py.

---

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

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Common/Mapper.py