Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
StatisticInterface.ContourOptions Class Reference
Collaboration diagram for StatisticInterface.ContourOptions:

Public Member Functions

"ContourOptions" from_cpp (cls, cpp_obj)
 
 to_cpp (self)
 

Public Attributes

 fallback_contour_method
 

Static Public Attributes

ProfilingMethod profiling_method = ProfilingMethod.SLICE
 
ProfilerMode profile_backend = ProfilerMode.LAPLACE_NUISANCE
 
ContourAlgorithm primary_contour_method = ContourAlgorithm.MINUIT
 
Optional fallback_contour_method = None
 
int resolution = 40
 

Detailed Description

Options controlling confidence-contour computation.

Attributes:
    profiling_method: How the two-dimensional contour fixes or profiles
        parameters.
    profile_backend: Backend used to evaluate profiled NLL points.
    primary_contour_method: Contour extraction algorithm.
    fallback_contour_method: Optional fallback algorithm used by the C++
        engine if the primary extraction fails.
    resolution: Resolution parameter passed to the contour extractor.

Examples:
    >>> opts = ContourOptions(profile_backend=ProfilerMode.LAPLACE_NUISANCE, resolution=60)

Definition at line 256 of file StatisticInterface.py.

Member Function Documentation

◆ from_cpp()

"ContourOptions" StatisticInterface.ContourOptions.from_cpp (   cls,
  cpp_obj 
)
Create Python contour options from C++ options.

Definition at line 279 of file StatisticInterface.py.

◆ to_cpp()

StatisticInterface.ContourOptions.to_cpp (   self)
Convert this contour options object to C++.

Definition at line 291 of file StatisticInterface.py.

Member Data Documentation

◆ fallback_contour_method [1/2]

Optional StatisticInterface.ContourOptions.fallback_contour_method = None
static

Definition at line 275 of file StatisticInterface.py.

◆ fallback_contour_method [2/2]

StatisticInterface.ContourOptions.fallback_contour_method

Definition at line 300 of file StatisticInterface.py.

◆ primary_contour_method

ContourAlgorithm StatisticInterface.ContourOptions.primary_contour_method = ContourAlgorithm.MINUIT
static

Definition at line 274 of file StatisticInterface.py.

◆ profile_backend

ProfilerMode StatisticInterface.ContourOptions.profile_backend = ProfilerMode.LAPLACE_NUISANCE
static

Definition at line 273 of file StatisticInterface.py.

◆ profiling_method

ProfilingMethod StatisticInterface.ContourOptions.profiling_method = ProfilingMethod.SLICE
static

Definition at line 272 of file StatisticInterface.py.

◆ resolution

int StatisticInterface.ContourOptions.resolution = 40
static

Definition at line 276 of file StatisticInterface.py.


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