Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
StatisticInterface Namespace Reference

Classes

class  Contour
 
class  ContourAlgorithm
 
class  ContourOptions
 
class  FitResultWithMaps
 
class  LikelihoodScanGrid
 
class  LikelihoodScanPoint
 
class  MLFitOptions
 
class  ProfilerMode
 
class  ProfilingMethod
 
class  StatisticInterface
 

Functions

 _require (value, typ, str name)
 
 _cpp_param_id (ParamId pid)
 
ParamId _param_from_cpp (cpp_obj)
 
Dict[ParamId, float] _param_float_map_from_cpp (cpp_map)
 
 _param_float_map_to_cpp (Mapping[ParamId, float] values)
 
Dict[ParamId, Dict[ParamId, float]] _param_nested_float_map_from_cpp (cpp_map)
 
 _cpp_experiment_obs (ExperimentObs obs)
 
Dict[ExperimentObs, float] _experiment_float_map_from_cpp (cpp_map)
 
Dict[ExperimentObs, Dict[ExperimentObs, float]] _experiment_nested_float_map_from_cpp (cpp_map)
 
 _cpp_profiling_method (ProfilingMethod value)
 
 _cpp_profile_backend (ProfilerMode value)
 
 _cpp_contour_algorithm (ContourAlgorithm value)
 

Detailed Description

Public Python interface to the statistical analysis backend.

``StatisticInterface`` is a high-level wrapper around the C++ statistic manager.
It connects a configured ``ObservableInterface`` to uncertainty propagation,
maximum-likelihood fitting, confidence-contour computation and likelihood scans.

Function Documentation

◆ _cpp_contour_algorithm()

StatisticInterface._cpp_contour_algorithm ( ContourAlgorithm  value)
protected
Convert a Python contour algorithm to C++.

Definition at line 134 of file StatisticInterface.py.

◆ _cpp_experiment_obs()

StatisticInterface._cpp_experiment_obs ( ExperimentObs  obs)
protected
Convert a Python ``ExperimentObs`` to its bound C++ value.

Definition at line 104 of file StatisticInterface.py.

◆ _cpp_param_id()

StatisticInterface._cpp_param_id ( ParamId  pid)
protected
Convert a Python ``ParamId`` to C++.

Definition at line 79 of file StatisticInterface.py.

◆ _cpp_profile_backend()

StatisticInterface._cpp_profile_backend ( ProfilerMode  value)
protected
Convert a Python profile backend to C++.

Definition at line 129 of file StatisticInterface.py.

◆ _cpp_profiling_method()

StatisticInterface._cpp_profiling_method ( ProfilingMethod  value)
protected
Convert a Python profiling method to C++.

Definition at line 124 of file StatisticInterface.py.

◆ _experiment_float_map_from_cpp()

Dict[ExperimentObs, float] StatisticInterface._experiment_float_map_from_cpp (   cpp_map)
protected
Convert a C++ ``map<ExperimentObs, double>`` to Python.

Definition at line 109 of file StatisticInterface.py.

◆ _experiment_nested_float_map_from_cpp()

Dict[ExperimentObs, Dict[ExperimentObs, float]] StatisticInterface._experiment_nested_float_map_from_cpp (   cpp_map)
protected
Convert a nested experimental-observable correlation map to Python.

Definition at line 114 of file StatisticInterface.py.

◆ _param_float_map_from_cpp()

Dict[ParamId, float] StatisticInterface._param_float_map_from_cpp (   cpp_map)
protected
Convert a C++ ``map<ParamId, double>`` to a Python dictionary.

Definition at line 89 of file StatisticInterface.py.

◆ _param_float_map_to_cpp()

StatisticInterface._param_float_map_to_cpp ( Mapping[ParamId, float]  values)
protected
Convert a Python parameter-value mapping to C++.

Definition at line 94 of file StatisticInterface.py.

◆ _param_from_cpp()

ParamId StatisticInterface._param_from_cpp (   cpp_obj)
protected
Convert a C++ ``ParamId`` to the Python wrapper.

Definition at line 84 of file StatisticInterface.py.

◆ _param_nested_float_map_from_cpp()

Dict[ParamId, Dict[ParamId, float]] StatisticInterface._param_nested_float_map_from_cpp (   cpp_map)
protected
Convert a nested C++ parameter matrix map to Python dictionaries.

Definition at line 99 of file StatisticInterface.py.

◆ _require()

StatisticInterface._require (   value,
  typ,
str  name 
)
protected
Validate a typed argument and return it unchanged.

Definition at line 72 of file StatisticInterface.py.