pyhyperiso.core.Common.Mapper.ObservableMapper Class Reference

Public Member Functions
	__init__ (self)

Static Public Member Functions
str	str (Observables obs)
Observables	enum_elt_legacy (AnyStr name)
ObservableId	id_of (AnyStr name)
ObservableId	to_id (Observables obs)
str	canonical (ObservableId obs_id)
	get_str ()
	get_str_all ()
	get_enum ()
ObservableId	from_flha (LhaID flha_id)
LhaID	flha (obs)
bool	register_custom (str canonical, Union[str, Decays, DecayId] parent_decay, Optional[Sequence[str]] aliases=None, Optional[LhaID] ext=None)

Detailed Description

Mapper for builtin and custom observables.

Dynamic/user-facing code should use :class:`ObservableId`; the static
:class:`Observables` enum is kept for builtin legacy paths only.

Definition at line 552 of file Mapper.py.

Constructor & Destructor Documentation

__init__()

pyhyperiso.core.Common.Mapper.ObservableMapper.__init__

(

self

)

Definition at line 559 of file Mapper.py.

Member Function Documentation

canonical()

str pyhyperiso.core.Common.Mapper.ObservableMapper.canonical ( ObservableId  obs_id )

static

Return the canonical name of an internal observable id.

Definition at line 587 of file Mapper.py.

enum_elt_legacy()

Observables pyhyperiso.core.Common.Mapper.ObservableMapper.enum_elt_legacy ( AnyStr  name )

static

Resolve a builtin observable name to the static enum.

Custom observables cannot be represented by :class:`Observables`; use
:meth:`id_of` for dynamic lookup.

Definition at line 568 of file Mapper.py.

flha()

LhaID pyhyperiso.core.Common.Mapper.ObservableMapper.flha (   obs )

static

Return the FLHA code associated with an observable.

Args:
    obs: Either a builtin :class:`Observables` or an
        :class:`ObservableId`.

Definition at line 618 of file Mapper.py.

from_flha()

ObservableId pyhyperiso.core.Common.Mapper.ObservableMapper.from_flha ( LhaID  flha_id )

static

Convert an FLHA code to an observable id.

Raises:
    KeyError: If no observable is associated with the FLHA code.

Definition at line 607 of file Mapper.py.

get_enum()

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

static

Return builtin observable enum values known to the mapper.

Definition at line 602 of file Mapper.py.

get_str()

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

static

Return builtin observable names.

Definition at line 592 of file Mapper.py.

get_str_all()

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

static

Return builtin and custom observable names.

Definition at line 597 of file Mapper.py.

id_of()

ObservableId pyhyperiso.core.Common.Mapper.ObservableMapper.id_of ( AnyStr  name )

static

Resolve a canonical name or alias to an :class:`ObservableId`.

Definition at line 577 of file Mapper.py.

register_custom()

bool pyhyperiso.core.Common.Mapper.ObservableMapper.register_custom ( str  canonical, Union[str, Decays, DecayId]  parent_decay, Optional[Sequence[str]]   aliases = None, Optional[LhaID]   ext = None  )

static

Register a custom observable and attach it to a parent decay.

Args:
    canonical: Canonical observable name.
    parent_decay: Parent decay as name/alias, :class:`Decays`, or
        :class:`DecayId`.
    aliases: Optional observable aliases.
    ext: Optional FLHA id.

Returns:
    bool: ``True`` if the C++ registry accepted the symbol.

Definition at line 632 of file Mapper.py.

str()

str pyhyperiso.core.Common.Mapper.ObservableMapper.str ( Observables  obs )

static

Return the canonical C++ name for a builtin observable enum.

Definition at line 563 of file Mapper.py.

to_id()

ObservableId pyhyperiso.core.Common.Mapper.ObservableMapper.to_id ( Observables  obs )

static

Convert a builtin observable enum to an :class:`ObservableId`.

Definition at line 582 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