SampleHandlerNuDockBase Class Reference

A SampleHandlerInterface class that acts as a client to an external NuDock server. More...

#include <NuDock/SampleHandlerNuDockBase.h>

Inheritance diagram for SampleHandlerNuDockBase:

Collaboration diagram for SampleHandlerNuDockBase:

Public Member Functions
	SampleHandlerNuDockBase (std::string configFile, ParameterHandlerGeneric *xsec_cov)
	Construct the NuDock client sample handler. More...
virtual	~SampleHandlerNuDockBase ()
	Destructor. More...
void	Reweight () override
	Send current parameter values to the NuDock server. More...
double	GetLikelihood () const override
	Retrieve the log-likelihood from the NuDock server. More...
std::string	GetSampleTitle (const int Sample) const override
	Get the title string for a given sample index. More...
std::string	GetName () const override
	Get the name of this sample handler. More...
double	GetSampleLikelihood (const int isample) const override
	Get the likelihood for a specific sub-sample. More...
void	PrintRates (const bool DataOnly=false) override
	Print event rates (no-op for the NuDock client). More...
int	GetNOscChannels (const int iSample) const override
	Get the number of oscillation channels for a sample. More...
std::string	GetKinVarName (const int iSample, const int Dimension) const override
	Return Kinematic Variable name for specified sample and dimension for example "Reconstructed_Neutrino_Energy". More...
const TH1 *	GetDataHist (const int Sample) override
	Get Data histogram. More...
const TH1 *	GetMCHist (const int Sample) override
	Get MC histogram. More...
const TH1 *	GetW2Hist (const int Sample) override
	Get W2 histogram. More...
int	GetNDim (const int Sample) const override
	DB Function to differentiate 1D or 2D binning. More...
std::string	GetFlavourName (const int iSample, const int iChannel) const override
	Get the flavour name for a given sample and oscillation channel. More...
std::vector< double >	ReturnKinematicParameterBinning (const int Sample, const std::string &KinematicParameter) const override
	Return the binning used to draw a kinematic parameter. More...
std::unique_ptr< TH1 >	Get1DVarHistByModeAndChannel (const int iSample, const std::string &ProjectionVar_Str, int kModeToFill=-1, int kChannelToFill=-1, int WeightStyle=0) override
	Build a 1D histogram for a given variable, optionally filtered by mode and channel. More...
std::unique_ptr< TH2 >	Get2DVarHistByModeAndChannel (const int iSample, const std::string &ProjectionVar_StrX, const std::string &ProjectionVar_StrY, int kModeToFill=-1, int kChannelToFill=-1, int WeightStyle=0) override
	Build a 2D histogram for given variables, optionally filtered by mode and channel. More...
std::unique_ptr< TH1 >	Get1DVarHist (const int iSample, const std::string &ProjectionVar, const std::vector< KinematicCut > &EventSelectionVec={}, int WeightStyle=0, const std::vector< KinematicCut > &SubEventSelectionVec={}) override
	Return 1D projection of MC into given 1D variable (doesn't have to be variable used in the fit) More...
std::unique_ptr< TH2 >	Get2DVarHist (const int iSample, const std::string &ProjectionVarX, const std::string &ProjectionVarY, const std::vector< KinematicCut > &EventSelectionVec={}, int WeightStyle=0, const std::vector< KinematicCut > &SubEventSelectionVec={}) override
	Build a 2D projection of MC events into specified variables. More...
Public Member Functions inherited from SampleHandlerInterface
	SampleHandlerInterface ()
	The main constructor. More...
virtual	~SampleHandlerInterface ()
	destructor More...
virtual M3::int_t	GetNSamples ()
	returns total number of samples More...
virtual void	SaveAdditionalInfo (TDirectory *Dir)
	Store additional info in a chain. More...
MaCh3Modes *	GetMaCh3Modes () const
	Return pointer to MaCh3 modes. More...
unsigned int	GetNEvents () const
	Return total number of events. More...
double	GetPoissonLLH (const double data, const double mc) const
	Calculate test statistic for a single bin using Poisson. More...
double	GetTestStatLLH (const double data, const double mc, const double w2) const
	Calculate test statistic for a single bin. Calculation depends on setting of fTestStatistic. Data and mc -> 0 cut-offs are defined in M3::LOW_MC_BOUND. More...
void	SetTestStatistic (TestStatistic testStat)
	Set the test statistic to be used when calculating the binned likelihoods. More...
TestStatistic	GetTestStatistic () const
	Get the test statistic used when calculating the binned likelihoods. More...

Protected Member Functions
void	CleanMemoryBeforeFit () override
	No-op – memory cleanup is handled by the NuDock server. More...
void	Init ()
	Initialise the NuDock client connection and cache parameter indices. More...
Protected Member Functions inherited from SampleHandlerInterface
void	QuietPlease ()
	CW: Redirect std::cout to silence some experiment specific libraries. More...
void	NowTalk ()
	CW: Redirect std::cout to silence some experiment specific libraries. More...
template<typename T >
bool	MatchCondition (const std::vector< T > &allowedValues, const T &value)
	check if event is affected by following conditions, for example pdg, or modes etc More...

Protected Attributes
std::unique_ptr< NuDock >	nudock_ptr
	Pointer to the NuDock client communication object. More...
std::unique_ptr< Manager >	SampleManager
	Manager owning the NuDockClient configuration. More...
bool	verbose
	Verbose logging flag, read from the NuDockClient config block. More...
std::vector< int >	nudockParamInds
	Cached indices into the ParameterHandler for parameters sent to the server. More...
ParameterHandlerGeneric *	ParHandler
	Non-owning pointer to the cross-section ParameterHandler. More...
Protected Attributes inherited from SampleHandlerInterface
TestStatistic	fTestStatistic
	Test statistic tells what kind of likelihood sample is using. More...
std::streambuf *	buf
	Keep the cout buffer. More...
std::streambuf *	errbuf
	Keep the cerr buffer. More...
M3::int_t	nSamples
	Contains how many samples we've got. More...
unsigned int	nEvents
	Number of MC events are there. More...
std::unique_ptr< MaCh3Modes >	Modes
	Holds information about used Generator and MaCh3 modes. More...

Detailed Description

A SampleHandlerInterface class that acts as a client to an external NuDock server.

Instead of performing local event reweighting and likelihood calculation, this sample forwards the current parameter values to an external NuDock server via JSON requests and retrieves the computed likelihood.

Author

Hank Hua

Definition at line 20 of file SampleHandlerNuDockBase.h.

Constructor & Destructor Documentation

SampleHandlerNuDockBase()

SampleHandlerNuDockBase::SampleHandlerNuDockBase	(	std::string	configFile,
		ParameterHandlerGeneric *	xsec_cov
	)

Construct the NuDock client sample handler.

Construct the NuDock client sample handler.

Reads the NuDockClient configuration from configFile, initialises the NuDock communication object, and caches the parameter indices that must be forwarded to the server on each reweight call.

Parameters

configFile	Path to a YAML configuration file containing the NuDockClient block.
xsec_cov	Pointer to the cross-section parameter handler from which current parameter values are read.

Reads the NuDockClient configuration from configFile, initialises the NuDock communication object, and caches the parameter indices that must be forwarded to the server on each reweight call.

Parameters

configFile	Path to a YAML configuration file containing the NuDockClient block.
xsec_cov	Pointer to the cross-section parameter handler from which current parameter values are read.

Definition at line 8 of file SampleHandlerNuDockBase.cpp.

: SampleHandlerInterface() {
  MACH3LOG_INFO("Creating SampleHandlerNuDock object..");
  MACH3LOG_INFO("- Using NuDock sample config in this file {}", configFile);
  ParHandler = xsec_cov;
  SampleManager = std::make_unique<Manager>(configFile.c_str());
  verbose = GetFromManager(SampleManager->raw()["NuDockClient"]["Verbose"], false);
 
  // ReadConfig();
  // SetupReweightArrays();
  Init();
}

~SampleHandlerNuDockBase()

SampleHandlerNuDockBase::~SampleHandlerNuDockBase ( )

virtual

Destructor.

Destructor.

Definition at line 24 of file SampleHandlerNuDockBase.cpp.

                                                  {
}

Member Function Documentation

CleanMemoryBeforeFit()

void SampleHandlerNuDockBase::CleanMemoryBeforeFit ( )

inlineoverrideprotectedvirtual

No-op – memory cleanup is handled by the NuDock server.

Implements SampleHandlerInterface.

Definition at line 124 of file SampleHandlerNuDockBase.h.

{};

Get1DVarHist()

std::unique_ptr<TH1> SampleHandlerNuDockBase::Get1DVarHist ( const int  iSample, const std::string &  ProjectionVar, const std::vector< KinematicCut > &  EventSelectionVec = {}, int  WeightStyle = 0, const std::vector< KinematicCut > &  SubEventSelectionVec = {}  )

inlineoverridevirtual

Return 1D projection of MC into given 1D variable (doesn't have to be variable used in the fit)

Parameters

iSample	Index of the sample.
ProjectionVar	name of variable
EventSelectionVec	Vector of additional cuts like cut on interaction mode
WeightStyle	Alow to modify weight for example if equal to 1 all weights are set to 1
SubEventSelectionVec	Vector of additional cuts for sub event (particle, ring etc.)

Implements SampleHandlerInterface.

Definition at line 108 of file SampleHandlerNuDockBase.h.

                                                                              {}, int WeightStyle = 0,
                           const std::vector<KinematicCut> &SubEventSelectionVec = {}) override {
    (void)iSample; (void)ProjectionVar; (void)EventSelectionVec; (void)WeightStyle; (void)SubEventSelectionVec;
    return nullptr;
  };

Get1DVarHistByModeAndChannel()

std::unique_ptr<TH1> SampleHandlerNuDockBase::Get1DVarHistByModeAndChannel ( const int  iSample, const std::string &  ProjectionVar_Str, int  kModeToFill = -1, int  kChannelToFill = -1, int  WeightStyle = 0  )

inlineoverridevirtual

Build a 1D histogram for a given variable, optionally filtered by mode and channel.

Parameters

iSample	Index of the sample.
ProjectionVar_Str	Name of the variable to project onto.
kModeToFill	Interaction mode to select (-1 means all modes).
kChannelToFill	Oscillation channel to select (-1 means all channels).
WeightStyle	Weighting scheme (e.g. 0 = nominal weights, 1 = unit weights).

Implements SampleHandlerInterface.

Definition at line 95 of file SampleHandlerNuDockBase.h.

                                                                                                                         {
    (void)iSample; (void)ProjectionVar_Str; (void)kModeToFill; (void)kChannelToFill; (void)WeightStyle;
    return nullptr;
  };

Get2DVarHist()

std::unique_ptr<TH2> SampleHandlerNuDockBase::Get2DVarHist ( const int  iSample, const std::string &  ProjectionVarX, const std::string &  ProjectionVarY, const std::vector< KinematicCut > &  EventSelectionVec = {}, int  WeightStyle = 0, const std::vector< KinematicCut > &  SubEventSelectionVec = {}  )

inlineoverridevirtual

Build a 2D projection of MC events into specified variables.

Parameters

iSample	Index of the sample.
ProjectionVarX	Name of the variable for the X axis.
ProjectionVarY	Name of the variable for the Y axis.
EventSelectionVec	Vector of event-level selection cuts.
WeightStyle	Weighting scheme (e.g. 0 = nominal weights, 1 = unit weights).
SubEventSelectionVec	Vector of sub-event selection cuts.

Implements SampleHandlerInterface.

Definition at line 115 of file SampleHandlerNuDockBase.h.

                                                                                 {},
                            int WeightStyle = 0, const std::vector< KinematicCut >& SubEventSelectionVec = {}) override {
    (void)iSample; (void)ProjectionVarX; (void)ProjectionVarY; (void)EventSelectionVec; (void)WeightStyle; (void)SubEventSelectionVec;
    return nullptr;
  };

Get2DVarHistByModeAndChannel()

std::unique_ptr<TH2> SampleHandlerNuDockBase::Get2DVarHistByModeAndChannel ( const int  iSample, const std::string &  ProjectionVar_StrX, const std::string &  ProjectionVar_StrY, int  kModeToFill = -1, int  kChannelToFill = -1, int  WeightStyle = 0  )

inlineoverridevirtual

Build a 2D histogram for given variables, optionally filtered by mode and channel.

Parameters

iSample	Index of the sample.
ProjectionVar_StrX	Name of the variable for the X axis.
ProjectionVar_StrY	Name of the variable for the Y axis.
kModeToFill	Interaction mode to select (-1 means all modes).
kChannelToFill	Oscillation channel to select (-1 means all channels).
WeightStyle	Weighting scheme (e.g. 0 = nominal weights, 1 = unit weights).

Implements SampleHandlerInterface.

Definition at line 101 of file SampleHandlerNuDockBase.h.

                                                                                                   {
    (void)iSample; (void)ProjectionVar_StrX; (void)ProjectionVar_StrY; (void)kModeToFill; (void)kChannelToFill; (void)WeightStyle;
    return nullptr;
  };

GetDataHist()

const TH1* SampleHandlerNuDockBase::GetDataHist ( const int  Sample )

inlineoverridevirtual

Get Data histogram.

Implements SampleHandlerInterface.

Definition at line 82 of file SampleHandlerNuDockBase.h.

{ (void)Sample; return nullptr; };

GetFlavourName()

std::string SampleHandlerNuDockBase::GetFlavourName ( const int  iSample, const int  iChannel  ) const

inlineoverridevirtual

Get the flavour name for a given sample and oscillation channel.

Parameters

iSample	Index of the sample.
iChannel	Index of the oscillation channel within the sample.

Implements SampleHandlerInterface.

Definition at line 90 of file SampleHandlerNuDockBase.h.

{ (void)iSample; (void)iChannel; return ""; };

GetKinVarName()

std::string SampleHandlerNuDockBase::GetKinVarName ( const int  iSample, const int  Dimension  ) const

inlineoverridevirtual

Return Kinematic Variable name for specified sample and dimension for example "Reconstructed_Neutrino_Energy".

Parameters

iSample	Sample index
Dimension	Dimension index

Implements SampleHandlerInterface.

Definition at line 79 of file SampleHandlerNuDockBase.h.

{ (void)iSample; (void)Dimension; return ""; };

GetLikelihood()

double SampleHandlerNuDockBase::GetLikelihood ( ) const

overridevirtual

Retrieve the log-likelihood from the NuDock server.

Retrieve the log-likelihood from the NuDock server.

Sends a "/log_likelihood" request and converts the returned 2NLL value to MaCh3's NLL convention by dividing by 2.

Returns

The log-likelihood value from the remote server.

Sends a "/log_likelihood" request and converts the returned 2NLL value to MaCh3's NLL convention by dividing by 2.

Returns

The log-likelihood value from the remote server.

Implements SampleHandlerInterface.

Definition at line 90 of file SampleHandlerNuDockBase.cpp.

                                                    {
  nlohmann::json request = "";
  double llh_value = 0.0;
  auto response = nudock_ptr->send_request("/log_likelihood", request);
  try {
    llh_value = response["log_likelihood"].get<double>();
    llh_value /= 2; // NuDock returns 2NLL, so we divide by 2 to be consistent with M3's definition of LLH.
    return llh_value;
  } catch (const std::exception &e) {
    MACH3LOG_ERROR("Error retrieving log-likelihood from NuDock response: {}", e.what());
    throw MaCh3Exception(__FILE__, __LINE__);
  }
}

GetMCHist()

const TH1* SampleHandlerNuDockBase::GetMCHist ( const int  Sample )

inlineoverridevirtual

Get MC histogram.

Implements SampleHandlerInterface.

Definition at line 84 of file SampleHandlerNuDockBase.h.

{ (void)Sample; return nullptr; };

GetName()

std::string SampleHandlerNuDockBase::GetName ( ) const

inlineoverridevirtual

Get the name of this sample handler.

Returns

The fixed string "NuDockSample".

Implements SampleHandlerInterface.

Definition at line 59 of file SampleHandlerNuDockBase.h.

{ return "NuDockSample"; };

GetNDim()

int SampleHandlerNuDockBase::GetNDim ( const int  Sample ) const

inlineoverridevirtual

DB Function to differentiate 1D or 2D binning.

Implements SampleHandlerInterface.

Definition at line 89 of file SampleHandlerNuDockBase.h.

{ (void)Sample; return 0; };

GetNOscChannels()

int SampleHandlerNuDockBase::GetNOscChannels ( const int  iSample ) const

inlineoverridevirtual

Get the number of oscillation channels for a sample.

Parameters

iSample

Sample index (unused).

Returns

Always returns 0 - oscillation channels are managed server-side.

Implements SampleHandlerInterface.

Definition at line 73 of file SampleHandlerNuDockBase.h.

{ (void)iSample; return 0; };

GetSampleLikelihood()

double SampleHandlerNuDockBase::GetSampleLikelihood ( const int  isample ) const

inlineoverridevirtual

Get the likelihood for a specific sub-sample.

Parameters

isample

Sub-sample index (unused – delegates to GetLikelihood()).

Returns

The total log-likelihood from the remote server.

Implements SampleHandlerInterface.

Definition at line 64 of file SampleHandlerNuDockBase.h.

{ (void)isample; return GetLikelihood(); };

GetSampleTitle()

std::string SampleHandlerNuDockBase::GetSampleTitle ( const int  Sample ) const

inlineoverridevirtual

Get the title string for a given sample index.

Parameters

Sample

Sample index (unused - always returns "NuDockSample").

Returns

The fixed string "NuDockSample".

Implements SampleHandlerInterface.

Definition at line 55 of file SampleHandlerNuDockBase.h.

{ (void)Sample; return "NuDockSample"; };

GetW2Hist()

const TH1* SampleHandlerNuDockBase::GetW2Hist ( const int  Sample )

inlineoverridevirtual

Get W2 histogram.

Implements SampleHandlerInterface.

Definition at line 86 of file SampleHandlerNuDockBase.h.

{ (void)Sample; return nullptr; };

Init()

void SampleHandlerNuDockBase::Init ( )

protected

Initialise the NuDock client connection and cache parameter indices.

Initialise the NuDock client connection and cache parameter indices.

Calls InitialiseNuDockObj() and then gathers system parameter indices (kFunc, kNorm, kSpline) tagged with sample "NuDock" from the ParameterHandler.

Calls InitialiseNuDockObj() and then gathers system parameter indices (kFunc, kNorm, kSpline) tagged with sample "NuDock" from the ParameterHandler.

Definition at line 30 of file SampleHandlerNuDockBase.cpp.

                                   {
  InitialiseNuDockObj(SampleManager.get(), nudock_ptr);
 
  // Gather the indices of NuDock parameters from the ParameterHandler, so that we can easily retrieve their values in Reweight()
  auto nudockParamInds_func = ParHandler->GetParsIndexFromSampleName("NuDock", SystType::kFunc);
  // HH: We should only be using kFunc for NuDock, but for convenience of testing (e.g. when validating
  // M3 client with M3 server we'd want to test the LLH of all the params) we include all param types here.
  auto nudockParamInds_norm = ParHandler->GetParsIndexFromSampleName("NuDock", SystType::kNorm);
  auto nudockParamInds_spline = ParHandler->GetParsIndexFromSampleName("NuDock", SystType::kSpline);
  nudockParamInds = nudockParamInds_func;
  nudockParamInds.insert(nudockParamInds.end(), nudockParamInds_norm.begin(), nudockParamInds_norm.end());
  nudockParamInds.insert(nudockParamInds.end(), nudockParamInds_spline.begin(), nudockParamInds_spline.end());
 
  nudock_ptr->start_client();
}

PrintRates()

void SampleHandlerNuDockBase::PrintRates ( const bool  DataOnly = false )

inlineoverridevirtual

Print event rates (no-op for the NuDock client).

Parameters

DataOnly

Whether to print data-only rates (unused).

Implements SampleHandlerInterface.

Definition at line 68 of file SampleHandlerNuDockBase.h.

{ (void)DataOnly; MACH3LOG_INFO("No rates to print for NuDock sample handler"); };

ReturnKinematicParameterBinning()

std::vector<double> SampleHandlerNuDockBase::ReturnKinematicParameterBinning ( const int  Sample, const std::string &  KinematicParameter  ) const

inlineoverridevirtual

Return the binning used to draw a kinematic parameter.

Implements SampleHandlerInterface.

Definition at line 93 of file SampleHandlerNuDockBase.h.

{ (void)Sample; (void)KinematicParameter; return {}; };

Reweight()

void SampleHandlerNuDockBase::Reweight ( )

overridevirtual

Send current parameter values to the NuDock server.

Send current parameter values to the NuDock server.

Collects oscillation and systematic parameter values from the ParameterHandlerGeneric, converts oscillation parameters from MaCh3 to NuDock convention, and sends a "/set_parameters" request.

Collects oscillation and systematic parameter values from the ParameterHandlerGeneric, converts oscillation parameters from MaCh3 to NuDock convention, and sends a "/set_parameters" request.

Implements SampleHandlerInterface.

Definition at line 49 of file SampleHandlerNuDockBase.cpp.

                                       {
  nlohmann::json request;
  std::unordered_map<std::string, double> osc_params;
  std::unordered_map<std::string, double> xsec_params;
  
  // Loop for systs
  for (const auto& iParam : nudockParamInds) {
    std::string paramName = ParHandler->GetParFancyName(iParam);
    double paramValue = ParHandler->GetParProp(iParam);
    xsec_params[paramName] = paramValue;
  }
 
  // Loop over NuDockOscNameMap_r to get osc params
  for (auto const& pair : NuDockOscNameMap_r) {
    auto const& paramNameM3 = pair.first;
    auto const& paramNameNuDock = pair.second;
    
    int iParam = ParHandler->GetParIndex(paramNameM3);
    double paramValue = ParHandler->GetParProp(iParam);
    // Convert sin2_theta to theta
    FormatOscParsForNuDock(paramNameNuDock, paramValue);
    osc_params[paramNameNuDock] = paramValue;
  }
 
  request["osc_pars"] = osc_params;
  request["sys_pars"] = xsec_params;
 
  auto response = nudock_ptr->send_request("/set_parameters", request);
  if (verbose) {
    try {
      MACH3LOG_INFO("NuDock response: {}", response.dump());
    } catch (const std::exception &e) {
      MACH3LOG_ERROR("Error dumping NuDock response: {}", e.what());
      throw MaCh3Exception(__FILE__, __LINE__);
    }
  }
}

Member Data Documentation

nudock_ptr

std::unique_ptr<NuDock> SampleHandlerNuDockBase::nudock_ptr

protected

Pointer to the NuDock client communication object.

Definition at line 133 of file SampleHandlerNuDockBase.h.

nudockParamInds

std::vector<int> SampleHandlerNuDockBase::nudockParamInds

protected

Cached indices into the ParameterHandler for parameters sent to the server.

Definition at line 142 of file SampleHandlerNuDockBase.h.

ParHandler

ParameterHandlerGeneric* SampleHandlerNuDockBase::ParHandler

protected

Non-owning pointer to the cross-section ParameterHandler.

Definition at line 145 of file SampleHandlerNuDockBase.h.

SampleManager

std::unique_ptr<Manager> SampleHandlerNuDockBase::SampleManager

protected

Manager owning the NuDockClient configuration.

Definition at line 136 of file SampleHandlerNuDockBase.h.

verbose

bool SampleHandlerNuDockBase::verbose

protected

Verbose logging flag, read from the NuDockClient config block.

Definition at line 139 of file SampleHandlerNuDockBase.h.

---

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

• NuDock/SampleHandlerNuDockBase.h
• NuDock/SampleHandlerNuDockBase.cpp