Proxy “user-facing” to retrieve correlations between parameters or experiment-scoped observables. More...

#include "IObsCorrelationProxy.h"
#include "ParameterProvider.h"
#include "CorrelationProvider.h"
#include "HyperisoMaster.h"
#include "Include.h"
#include "ExperimentObs.h"
#include "BinnedObservableId.h"

Include dependency graph for CorrelationProxy.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CorrelationProxy

Detailed Description

Proxy “user-facing” to retrieve correlations between parameters or experiment-scoped observables.

This class is a thin wrapper around CorrelationProvider, exposed through a simple call-operator API so it can be used like a function.

It supports multiple identifier types:

ParamId : generic typed parameter identifier,
ExperimentObs : fully explicit experiment-scoped observable identifier,
Observables : observable enum, together with an experiment name,
ObservableId : internal observable identifier, together with an experiment name,
BinnedObservableId : binned observable identifier, together with an experiment name.

Observable correlations are experiment-scoped. Therefore, when querying correlations between observables, one must either:

pass the experiment explicitly, or
use fully explicit ExperimentObs objects.

The CorrelationProvider::CorrelationType selects which quantity is requested:

statistical correlation,
systematic correlation,
combined correlation.

Typical usage:

CorrelationProxy corr;
 
double rho_param =
    corr(pid1, pid2, CorrelationProvider::CorrelationType::STAT);
 
double rho_obs =
    corr("LHCb", obs1, obs2, CorrelationProvider::CorrelationType::COMBINED);
 
double rho_explicit =
    corr(ExperimentObs{"LHCb", b1}, ExperimentObs{"Belle", b2},
         CorrelationProvider::CorrelationType::STAT);

See also: CorrelationProvider; IObsCorrelationProxy

Definition in file CorrelationProxy.h.

Classes

Detailed Description