Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
pyhyperiso.core.BusinessLogic.LambdaDecay.LambdaObservableConfig Class Reference

Public Member Functions

 __init__ (self, str canonical, Callable compute, Sequence[str]|None aliases=None, LhaID|None flha=None, Sequence[ParamId]|Set[ParamId]|None dependencies=None, bool binned=False)
 
"LambdaObservableConfig" scalar (cls, str canonical, Callable compute, Sequence[str]|None aliases=None, LhaID|None flha=None, Sequence[ParamId]|Set[ParamId]|None dependencies=None)
 
"LambdaObservableConfig" binned_scalar (cls, str canonical, Callable compute, Sequence[str]|None aliases=None, LhaID|None flha=None, Sequence[ParamId]|Set[ParamId]|None dependencies=None)
 
 to_cpp (self)
 

Protected Attributes

 _cpp_obj
 

Detailed Description

Runtime observable computed by a Python callable.

Args:
    canonical: Canonical observable name registered in the mapper layer.
    compute: Callback receiving ``(ctx, observable_id)`` for scalar
        observables, or ``(ctx, bin, observable_id)`` for binned observables.
    aliases: Optional aliases accepted by ``ObservableMapper.id_of``.
    flha: Optional FLHA id for experimental input/output conventions.
        Required when the observable is passed to ``StatisticInterface``.
    dependencies: Parameter dependencies visible to Statistic.
    binned: Whether ``compute`` should be called with the current bin.

Definition at line 108 of file LambdaDecay.py.

Constructor & Destructor Documentation

◆ __init__()

pyhyperiso.core.BusinessLogic.LambdaDecay.LambdaObservableConfig.__init__ (   self,
str  canonical,
Callable  compute,
Sequence[str] | None   aliases = None,
LhaID | None   flha = None,
Sequence[ParamId] | Set[ParamId] | None   dependencies = None,
bool   binned = False 
)

Definition at line 122 of file LambdaDecay.py.

Member Function Documentation

◆ binned_scalar()

"LambdaObservableConfig" pyhyperiso.core.BusinessLogic.LambdaDecay.LambdaObservableConfig.binned_scalar (   cls,
str  canonical,
Callable  compute,
Sequence[str] | None   aliases = None,
LhaID | None   flha = None,
Sequence[ParamId] | Set[ParamId] | None   dependencies = None 
)
Create a binned scalar observable.

``compute`` receives ``(ctx, (q2_min, q2_max), observable_id)`` and can
return ``float`` or any object implementing ``__float__``.

Definition at line 170 of file LambdaDecay.py.

◆ scalar()

"LambdaObservableConfig" pyhyperiso.core.BusinessLogic.LambdaDecay.LambdaObservableConfig.scalar (   cls,
str  canonical,
Callable  compute,
Sequence[str] | None   aliases = None,
LhaID | None   flha = None,
Sequence[ParamId] | Set[ParamId] | None   dependencies = None 
)
Create an unbinned scalar observable.

``compute`` receives ``(ctx, observable_id)`` and can return ``float`` or
any object implementing ``__float__`` such as ``Scalar``.

Definition at line 152 of file LambdaDecay.py.

◆ to_cpp()

pyhyperiso.core.BusinessLogic.LambdaDecay.LambdaObservableConfig.to_cpp (   self)
Return the bound C++ ``LambdaObservableConfig``.

Definition at line 187 of file LambdaDecay.py.

Member Data Documentation

◆ _cpp_obj

pyhyperiso.core.BusinessLogic.LambdaDecay.LambdaObservableConfig._cpp_obj
protected

Definition at line 144 of file LambdaDecay.py.


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