A class that implements a NuDock server for cross-fitter communication. More...

#include <NuDock/NuDockServerBase.h>

Inheritance diagram for NuDockServerBase:

Collaboration diagram for NuDockServerBase:

Public Member Functions
	NuDockServerBase (Manager *const fitMan)
	Construct the NuDock server. More...

virtual	~NuDockServerBase ()
	Destructor. More...

std::string	GetName () const
	Return a human-readable identifier for this fitter. More...

void	setup ()
	Perform one-time server setup. More...

virtual double	getLogLikelihood ()
	Compute the total log-likelihood across all systematics and samples. More...

virtual nlohmann::json	setParameters (const nlohmann::json &request)
	Handle a "set_parameters" request. More...

virtual nlohmann::json	getParametersNames (const nlohmann::json &request)
	Handle a "get_parameter_names" request. More...

virtual nlohmann::json	getParameters (const nlohmann::json &request)
	Handle a "get_parameters" request. More...

virtual nlohmann::json	get2NLL (const nlohmann::json &request)
	Handle a "log_likelihood" request. More...

virtual nlohmann::json	setAsimovPoint (const nlohmann::json &request)
	Handle a "set_asimov" request. More...

virtual nlohmann::json	getMCSpectrum (const nlohmann::json &request)
	Handle a "get_mc_spectrum" request. More...

virtual nlohmann::json	getDataSpectrum (const nlohmann::json &request)
	Handle a "get_data_spectrum" request. More...

void	RunMCMC () override
	No-op implementation — the server does not run own MCMC. More...

Public Member Functions inherited from FitterBase
	FitterBase (Manager *const fitMan)
	Constructor. More...

virtual	~FitterBase ()
	Destructor for the FitterBase class. More...

void	AddSampleHandler (SampleHandlerInterface *sample)
	This function adds a sample PDF object to the analysis framework. The sample PDF object will be utilized in fitting procedures or likelihood scans. More...

void	AddSystObj (ParameterHandlerBase *cov)
	This function adds a Covariance object to the analysis framework. The Covariance object will be utilized in fitting procedures or likelihood scans. More...

void	DragRace (const int NLaps=100)
	Calculates the required time for each sample or covariance object in a drag race simulation. Inspired by Dan's feature. More...

void	RunLLHScan ()
	Perform a 1D likelihood scan. More...

void	RunLLHMap ()
	Perform a general multi-dimensional likelihood scan. More...

void	GetStepScaleBasedOnLLHScan (const std::string &filename="")
	LLH scan is good first estimate of step scale. More...

void	Run2DLLHScan ()
	Perform a 2D likelihood scan. More...

void	RunSigmaVar ()
	Perform a 1D/2D sigma var for all samples. More...

virtual void	StartFromPreviousFit (const std::string &FitName)
	Allow to start from previous fit/chain. More...

std::string	GetName () const
	Get name of class. More...

virtual std::string	GetFancyName () const
	This name is to get include some special algorithm extensions. More...

Protected Attributes
bool	verbose
	Flag controlling verbose logging of server operations. More...

bool	add_prior_llh
	If true, systematic prior likelihoods are added to the total LLH. More...

Protected Attributes inherited from FitterBase
Manager *	fitMan
	The manager for configuration handling. More...

unsigned int	step
	current state More...

double	logLCurr
	current likelihood More...

double	logLProp
	proposed likelihood More...

double	accProb
	current acceptance prob More...

int	accCount
	counts accepted steps More...

unsigned int	stepStart
	step start, by default 0 if we start from previous chain then it will be different More...

std::vector< double >	sample_llh
	store the llh breakdowns More...

std::vector< double >	syst_llh
	systematic llh breakdowns More...

std::vector< SampleHandlerInterface * >	samples
	Sample holder. More...

unsigned int	TotalNSamples
	Total number of samples used, single SampleHandler can store more than one analysis sample! More...

std::vector< ParameterHandlerBase * >	systematics
	Systematic holder. More...

std::unique_ptr< TStopwatch >	clock
	tells global time how long fit took More...

std::unique_ptr< TStopwatch >	stepClock
	tells how long single step/fit iteration took More...

double	stepTime
	Time of single step. More...

TFile *	outputFile
	Output. More...

TDirectory *	CovFolder
	Output cov folder. More...

TDirectory *	SampleFolder
	Output sample folder. More...

TTree *	outTree
	Output tree with posteriors. More...

int	auto_save
	auto save every N steps More...

bool	fTestLikelihood
	Necessary for some fitting algorithms like PSO. More...

bool	FileSaved
	Checks if file saved not repeat some operations. More...

bool	SettingsSaved
	Checks if setting saved not repeat some operations. More...

bool	OutputPrepared
	Checks if output prepared not repeat some operations. More...

std::string	AlgorithmName
	Name of fitting algorithm that is being used. More...

Additional Inherited Members
Protected Member Functions inherited from FitterBase
void	ProcessMCMC ()
	Process MCMC output. More...

void	PrepareOutput ()
	Prepare the output file. More...

void	SaveOutput ()
	Save output and close files. More...

void	SanitiseInputs ()
	Remove obsolete memory and make other checks before fit starts. More...

void	SaveSettings ()
	Save the settings that the MCMC was run with. More...

bool	GetScanRange (std::map< std::string, std::vector< double >> &scanRanges) const
	YSP: Set up a mapping to store parameters with user-specified ranges, suggested by D. Barrow. More...

void	GetParameterScanRange (const ParameterHandlerBase *cov, const int i, double &CentralValue, double &lower, double &upper, const int n_points, const std::string &suffix="") const
	Helper function to get parameter scan range, central value. More...

bool	CheckSkipParameter (const std::vector< std::string > &SkipVector, const std::string &ParamName) const
	KS: Check whether we want to skip parameter using skip vector. More...

void	CustomRange (const std::string &ParName, const double sigma, double &ParamShiftValue) const
	For comparison with other fitting frameworks (like P-Theta) we usually have to apply different parameter values then usual 1, 3 sigma. More...

std::vector< double >	CalculateBinEdges (double lowerlimit, double upperlimit, int n_points) const

Detailed Description

A class that implements a NuDock server for cross-fitter communication.

NuDockServerBase acts as the server-side adapter in the NuDock protocol. It inherits from FitterBase and translates incoming JSON requests into operations on MaCh3 systematic & sample objects (set/get parameters, compute likelihoods, set Asimov data, retrieve predicted spectra, etc.).

Experiment-specific servers should derive from this class and override the virtual handlers where custom behaviour is needed.

Author: Hank Hua

Definition at line 25 of file NuDockServerBase.h.

Constructor & Destructor Documentation

◆ NuDockServerBase()

NuDockServerBase::NuDockServerBase ( Manager *const fitMan )

Construct the NuDock server.

Parameters

fitMan	Pointer to the MaCh3 manager that owns fit configuration.
fitMan	Pointer to the MaCh3 manager that owns fit configuration.

Definition at line 7 of file NuDockServerBase.cpp.

7 : FitterBase(man) {

8 }

FitterBase::FitterBase

FitterBase(Manager *const fitMan)

Constructor.

Definition: FitterBase.cpp:17

◆ ~NuDockServerBase()

NuDockServerBase::~NuDockServerBase ( )

virtual

Destructor.

Definition at line 13 of file NuDockServerBase.cpp.

13 {

14 }

Member Function Documentation

◆ get2NLL()

nlohmann::json NuDockServerBase::get2NLL ( const nlohmann::json & request )

virtual

Handle a "log_likelihood" request.

Returns twice the log-likelihood (2NLL) to match NuDock convention.

Parameters

request JSON object (unused).

Returns: JSON response with a "log_likelihood" field containing 2*NLL.

Returns twice the log-likelihood (2NLL) to match NuDock convention.

Parameters

request JSON object (unused).

Returns: JSON response with a "log_likelihood" field containing 2*NLL.

Definition at line 329 of file NuDockServerBase.cpp.

                                                                                    {
   nlohmann::json response;
   response["log_likelihood"] = 2*getLogLikelihood();
   return response;
 }

◆ getDataSpectrum()

nlohmann::json NuDockServerBase::getDataSpectrum ( const nlohmann::json & request )

virtual

Handle a "get_data_spectrum" request.

Retrieves data bin contents and bin edges from every registered SampleHandlerFD sample, supporting 1-D and 2-D histograms.

Parameters

request JSON object (unused).

Returns: JSON response containing sample names, dimensions, axis titles, bin edges, and bin values.

Exceptions

MaCh3Exception if a sample does not derive from SampleHandlerFD.

Retrieves data bin contents and bin edges from every registered SampleHandlerFD sample, supporting 1-D and 2-D histograms.

Parameters

request JSON object (unused).

Returns: JSON response containing sample names, dimensions, axis titles, bin edges, and bin values.

Exceptions

MaCh3Exception if a sample does not derive from SampleHandlerFD.

Definition at line 244 of file NuDockServerBase.cpp.

                                                                                            {
   nlohmann::json response;
  
   std::vector<std::string> sample_titles = {};
  
   for (size_t ipdf=0; ipdf<samples.size(); ipdf++) {
     auto* base_casted_sample = dynamic_cast<SampleHandlerBase*>(samples[ipdf]);
     if(!base_casted_sample) {
       MACH3LOG_ERROR("Sample object does not derive from SampleHandlerBase. Consider overloading {} for this sample type.", __func__);
       throw MaCh3Exception(__FILE__,__LINE__);
     }
     for (int iSample = 0; iSample < samples[ipdf]->GetNSamples(); ++iSample) {
       std::string sample_title = samples[ipdf]->GetSampleTitle(iSample);
       sample_titles.push_back(sample_title);
  
       int dimension = samples[ipdf]->GetNDim(iSample);
       response["dimensions"][sample_title] = dimension;
  
       if (dimension == 1) {
         TH1toResponse(samples[ipdf]->GetDataHist(iSample), sample_title, response);
       } else if (dimension == 2) {
         TH2toResponse(static_cast<const TH2*>(samples[ipdf]->GetDataHist(iSample)), sample_title, response);
       } else {
         MACH3LOG_ERROR("Not implemented for dim =", dimension);
         throw MaCh3Exception(__FILE__,__LINE__);
       }
     }
   }
   response["sample_names"] = sample_titles;
   return response;
 }

◆ getLogLikelihood()

double NuDockServerBase::getLogLikelihood ( )

virtual

Compute the total log-likelihood across all systematics and samples.

The systematic prior likelihoods are optionally included (controlled by add_prior_llh). Sample likelihoods are always summed.

Returns: The combined log-likelihood value.

The systematic prior likelihoods are optionally included (controlled by add_prior_llh). Sample likelihoods are always summed.

Returns: The combined log-likelihood value.

Definition at line 30 of file NuDockServerBase.cpp.

                                           {
   // HH: Based on MR2T2::ProposeStep()
   // Initial likelihood
   double llh = 0.0;
  
   if (add_prior_llh) {
     // Loop over the systematics and propose the initial step
     for (size_t s = 0; s < systematics.size(); ++s) {
       // Get the likelihood from the systematics
       syst_llh[s] = systematics[s]->GetLikelihood();
       if (verbose) MACH3LOG_INFO("Syst {} llh: {}", systematics[s]->GetName(), syst_llh[s]);
       llh += syst_llh[s];
  
       if (verbose) MACH3LOG_INFO("LLH after {} {}", systematics[s]->GetName(), llh);
     }
   }
  
   // DB for atmospheric event by event sample migration, need to fully reweight all samples to allow event passing prior to likelihood evaluation
   for (size_t i = 0; i < samples.size(); ++i) {
     // Get the sample likelihoods and add them
     sample_llh[i] = samples[i]->GetLikelihood();
     if (verbose) {
       MACH3LOG_INFO("Total LLH in sample handler {}: {}", i, sample_llh[i]);
       for (int iSample = 0; iSample < samples[i]->GetNSamples(); ++iSample) {
         double sample_llh_ind = samples[i]->GetSampleLikelihood(iSample);
         MACH3LOG_INFO("  Sample {} llh: {}", samples[i]->GetSampleTitle(iSample), sample_llh_ind);
       }
     }
     llh += sample_llh[i];
     if (verbose) MACH3LOG_INFO("LLH after sample {} {}", i, llh);  }
  
   return llh;
 }

◆ getMCSpectrum()

nlohmann::json NuDockServerBase::getMCSpectrum ( const nlohmann::json & request )

virtual

Handle a "get_mc_spectrum" request.

Retrieves predicted bin contents and bin edges from every registered SampleHandlerFD sample, supporting 1-D and 2-D histograms.

Parameters

request JSON object (unused).

Returns: JSON response containing sample names, dimensions, axis titles, bin edges, and bin values.

Exceptions

MaCh3Exception if a sample does not derive from SampleHandlerFD.

Retrieves predicted bin contents and bin edges from every registered SampleHandlerFD sample, supporting 1-D and 2-D histograms.

Parameters

request JSON object (unused).

Returns: JSON response containing sample names, dimensions, axis titles, bin edges, and bin values.

Exceptions

MaCh3Exception if a sample does not derive from SampleHandlerFD.

Definition at line 209 of file NuDockServerBase.cpp.

                                                                                          {
   nlohmann::json response;
  
   std::vector<std::string> sample_titles = {};
  
   for (size_t ipdf=0; ipdf<samples.size(); ipdf++) {
     auto* base_casted_sample = dynamic_cast<SampleHandlerBase*>(samples[ipdf]);
     if(!base_casted_sample) {
       MACH3LOG_ERROR("Sample object does not derive from SampleHandlerBase. Consider overloading {} for this sample type.", __func__);
       throw MaCh3Exception(__FILE__,__LINE__);
     }
     for (int iSample = 0; iSample < samples[ipdf]->GetNSamples(); ++iSample) {
       std::string sample_title = samples[ipdf]->GetSampleTitle(iSample);
       sample_titles.push_back(sample_title);
  
       int dimension = samples[ipdf]->GetNDim(iSample);
       response["dimensions"][sample_title] = dimension;
  
       if (dimension == 1) {
         TH1toResponse(samples[ipdf]->GetMCHist(iSample), sample_title, response);
       } else if (dimension == 2) {
         TH2toResponse(static_cast<const TH2*>(samples[ipdf]->GetMCHist(iSample)), sample_title, response);
       } else {
         MACH3LOG_ERROR("Not implemented for dim =", dimension);
         throw MaCh3Exception(__FILE__,__LINE__);
       }
     }
   }
   response["sample_names"] = sample_titles;
   return response;
 }

◆ GetName()

std::string NuDockServerBase::GetName ( ) const

inline

Return a human-readable identifier for this fitter.

Definition at line 35 of file NuDockServerBase.h.

35 {return "NuDockServer";};

◆ getParameters()

nlohmann::json NuDockServerBase::getParameters ( const nlohmann::json & request )

virtual

Handle a "get_parameters" request.

Returns current values of oscillation and systematic parameters.

Parameters

request JSON object (unused).

Returns: JSON response with "osc_pars" and "sys_pars" maps.

Returns current values of oscillation and systematic parameters.

Parameters

request JSON object (unused).

Returns: JSON response with "osc_pars" and "sys_pars" maps.

Definition at line 300 of file NuDockServerBase.cpp.

                                                                                          {
   std::map<std::string, double> osc_params;
   std::map<std::string, double> syst_params;
  
   for (size_t s = 0; s < systematics.size(); ++s) {
     int npars = systematics[s]->GetNumParams();
     for (int p = 0; p < npars; ++p) {
       std::string param_name = systematics[s]->GetParFancyName(p);
       double param_value = systematics[s]->GetParProp(p);
       if (NuDockOscNameMap_r.find(param_name) != NuDockOscNameMap_r.end()){
         param_name = NuDockOscNameMap_r.at(param_name);
         osc_params[param_name] = param_value;
       } else {
         if (!systematics[s]->IsParameterFixed(p)) {
           syst_params[param_name] = param_value;
         }
       }
     }
   }
   // Convert maps to json
   nlohmann::json response;
   response["sys_pars"] = syst_params;
   response["osc_pars"] = osc_params;
   return response;
 }

◆ getParametersNames()

nlohmann::json NuDockServerBase::getParametersNames ( const nlohmann::json & request )

virtual

Handle a "get_parameter_names" request.

Returns the names of all unfixed, non-oscillation systematic parameters.

Parameters

request JSON object (unused).

Returns: JSON response with a "sys_pars" array of parameter name strings.

Returns the names of all unfixed, non-oscillation systematic parameters.

Parameters

request JSON object (unused).

Returns: JSON response with a "sys_pars" array of parameter name strings.

Definition at line 279 of file NuDockServerBase.cpp.

                                                                                               {
   std::vector<std::string> syst_par_names;
  
   for (size_t s = 0; s < systematics.size(); ++s) {
     int npars = systematics[s]->GetNumParams();
     for (int p = 0; p < npars; ++p) {
       std::string param_name = systematics[s]->GetParFancyName(p);
       if (NuDockOscNameMap_r.find(param_name) != NuDockOscNameMap_r.end()) continue;
       if (!systematics[s]->IsParameterFixed(p)) {
         syst_par_names.push_back(param_name);
       }
     }
   }
   nlohmann::json response;
   response["sys_pars"] = syst_par_names;
   return response;
 }

◆ RunMCMC()

void NuDockServerBase::RunMCMC ( )

inlineoverridevirtual

No-op implementation — the server does not run own MCMC.

Implements FitterBase.

Definition at line 118 of file NuDockServerBase.h.

118 {return; /* do nothing */};

◆ setAsimovPoint()

nlohmann::json NuDockServerBase::setAsimovPoint ( const nlohmann::json & request )

virtual

Handle a "set_asimov" request.

Reweights all samples then clones the MC prediction as the "data". Prefit parameter central values are updated to match the current proposed values.

Parameters

request JSON object (unused).

Returns: JSON response with a "status" field.

Reweights all samples then clones the MC prediction as the "data". Prefit parameter central values are updated to match the current proposed values.

Parameters

request JSON object (unused).

Returns: JSON response with a "status" field.

Definition at line 119 of file NuDockServerBase.cpp.

                                                                                           {
   // reweight sample and add to data
   for (size_t ipdf=0; ipdf<samples.size(); ipdf++) {
     samples[ipdf]->Reweight();
     auto* base_casted_sample = dynamic_cast<SampleHandlerBase*>(samples[ipdf]);
     if(!base_casted_sample) {
       MACH3LOG_ERROR("Sample object does not derive from SampleHandlerBase. Consider overloading {} for this sample type.", __func__);
       throw MaCh3Exception(__FILE__,__LINE__);
     }
     for (int iSample = 0; iSample < samples[ipdf]->GetNSamples(); ++iSample) {
       base_casted_sample->AddData(iSample, base_casted_sample->GetMCArray(iSample));
     }
   }
  
   // set prefit parameter values to the current parameter values
   for (size_t s = 0; s < systematics.size(); ++s) {
     int npars = systematics[s]->GetNumParams();
     for (int p = 0; p < npars; ++p) {
       std::string param_name = systematics[s]->GetParFancyName(p);
       double param_value = systematics[s]->GetParCurr(p);
       systematics[s]->SetPar(p, param_value);
       if (verbose) MACH3LOG_INFO("Setting prefit param {} to current value {}", param_name, param_value);
     }
   }
  
   nlohmann::json response;
   response["status"] = "success";
   return response;
 }

◆ setParameters()

nlohmann::json NuDockServerBase::setParameters ( const nlohmann::json & request )

virtual

Handle a "set_parameters" request.

Expects the JSON payload to contain "sys_pars" and "osc_pars" maps. Oscillation parameters are converted from NuDock convention to MaCh3 convention before being applied. Samples are reweighted after all parameters are updated.

Parameters

request JSON object with "sys_pars" and "osc_pars" entries.

Returns: JSON response with a "status" field.

Expects the JSON payload to contain "sys_pars" and "osc_pars" maps. Oscillation parameters are converted from NuDock convention to MaCh3 convention before being applied. Samples are reweighted after all parameters are updated.

Parameters

request JSON object with "sys_pars" and "osc_pars" entries.

Returns: JSON response with a "status" field.

Definition at line 67 of file NuDockServerBase.cpp.

                                                                         {
   if (verbose) {
     MACH3LOG_INFO("Setting parameters from NuDock request: {}", request.dump());
   }
   std::map<std::string, double> syst_params = request["sys_pars"].get<std::map<std::string, double>>();
   std::map<std::string, double> osc_params = request["osc_pars"].get<std::map<std::string, double>>();
   // Loop over systematic objects
   for (size_t s = 0; s < systematics.size(); ++s) {
     int npars = systematics[s]->GetNumParams();
     // Loop over each parameter in the systematics object
     for (int p = 0; p < npars; ++p) {
       std::string param_name = systematics[s]->GetParFancyName(p);
       // Check if this is an oscillation parameter
       if (NuDockOscNameMap_r.find(param_name) != NuDockOscNameMap_r.end()) {
         std::string param_name_nudock = NuDockOscNameMap_r.at(param_name);
         // Check if it exists in the request
         if (osc_params.find(param_name_nudock) != osc_params.end()) {
           double param_value = osc_params[param_name_nudock];
           FormatOscParsForMaCh3(param_name_nudock, param_value);
           systematics[s]->SetParCurrProp(p, param_value);
           if (verbose) MACH3LOG_INFO("Setting osc param {} to value {}", param_name, param_value);
         } else {
           MACH3LOG_WARN("Oscillation parameter {} not found in request", param_name);
         }
       } else {
         if (!systematics[s]->IsParameterFixed(p)) {
           // Non-oscillation parameter
           // Check if it exists in the request
           if (syst_params.find(param_name) != syst_params.end()) {
             double param_value = syst_params[param_name];
             systematics[s]->SetParCurrProp(p, param_value);
             if (verbose) MACH3LOG_INFO("Setting syst param {} to value {}", param_name, param_value);
           } else {
             MACH3LOG_WARN("Systematic parameter {} not found in request", param_name);
           }
         }
       }
     }
   }
   // HH: Reweights here is probably a better idea than getLikelihood, thanks to Jude
   for (size_t i = 0; i < samples.size(); ++i) {
     samples[i]->Reweight();
   }
  
   nlohmann::json response;
   response["status"] = "success";
   return response;
 }

◆ setup()

void NuDockServerBase::setup ( )

Perform one-time server setup.

Resizes internal likelihood storage vectors and reads the "Verbose" and "AddPriorLLH" flags from the NuDock configuration block.

Definition at line 19 of file NuDockServerBase.cpp.

                              {
   // Resize the likelihood storage vectors
   syst_llh.resize(systematics.size(), M3::_BAD_DOUBLE_);
   sample_llh.resize(samples.size(), M3::_BAD_DOUBLE_);
   verbose = GetFromManager(fitMan->raw()["NuDock"]["Verbose"], false, __FILE__, __LINE__);
   add_prior_llh = GetFromManager(fitMan->raw()["NuDock"]["AddPriorLLH"], false, __FILE__, __LINE__);
 }

Member Data Documentation

◆ add_prior_llh

bool NuDockServerBase::add_prior_llh

protected

If true, systematic prior likelihoods are added to the total LLH.

Definition at line 124 of file NuDockServerBase.h.

◆ verbose

bool NuDockServerBase::verbose

protected

Flag controlling verbose logging of server operations.

Definition at line 122 of file NuDockServerBase.h.

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

NuDock/NuDockServerBase.h
NuDock/NuDockServerBase.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NuDockServerBase()

◆ ~NuDockServerBase()

Member Function Documentation

◆ get2NLL()

◆ getDataSpectrum()

◆ getLogLikelihood()

◆ getMCSpectrum()

◆ GetName()

◆ getParameters()

◆ getParametersNames()

◆ RunMCMC()

◆ setAsimovPoint()

◆ setParameters()

◆ setup()

Member Data Documentation

◆ add_prior_llh

◆ verbose