manager Class Reference

The manager class is responsible for managing configurations and settings. More...

#include <Manager/Manager.h>

Collaboration diagram for manager:

Public Member Functions
	manager (std::string const &filename)
	Constructs a manager object with the specified file name.
	manager (const YAML::Node ConfigNode)
	Constructs a manager object with the specified YAML.
virtual	~manager ()
	Destroys the manager object.
void	SaveSettings (TFile *const OutputFile)
	Add manager useful information's to TFile, in most cases to Fitter.
void	Print ()
	Print currently used config.
int	GetMCStatLLH ()
	Get likelihood type defined in the config.
std::string	GetFileName ()
	Return name of config.
YAML::Node const &	raw ()
	Return config.
std::string	GetName () const
	Get class name.
template<typename... Args>
void	OverrideSettings (Args &&... args)
	Overrides the configuration settings based on provided arguments.

Private Member Functions
void	Initialise ()
	Common inialiser for both constructors.

Private Attributes
YAML::Node	config
	The YAML node containing the configuration data.
std::string	FileName
	The name of the configuration file.

Detailed Description

The manager class is responsible for managing configurations and settings.

See also

For more details, visit the Wiki.

Author

Ed Atkin

Kamil Skwarczynski

Definition at line 16 of file Manager.h.

Constructor & Destructor Documentation

manager() [1/2]

_MaCh3_Safe_Include_Start_ _MaCh3_Safe_Include_End_ manager::manager ( std::string const &  filename )

explicit

Constructs a manager object with the specified file name.

Parameters

filename

The name of the configuration file.

Definition at line 9 of file Manager.cpp.

: config(M3OpenConfig(filename)) {
// *************************
  FileName = filename;
 
  Initialise();
}

manager() [2/2]

manager::manager

(

const YAML::Node

ConfigNode

)

Constructs a manager object with the specified YAML.

Note

This is primarily used when initializing from a previous chain, allowing the creation of a manager instance based embedded YAML in that chain.

Parameters

ConfigNode

Actual YAML config

Definition at line 18 of file Manager.cpp.

                                          {
// *************************
  config = ConfigNode;
  FileName = "unknown";
 
  Initialise();
}

~manager()

manager::~manager ( )

virtual

Destroys the manager object.

Definition at line 41 of file Manager.cpp.

                  {
// *************************
}

Member Function Documentation

GetFileName()

std::string manager::GetFileName ( )

inline

Return name of config.

Definition at line 39 of file Manager.h.

{return FileName;}

GetMCStatLLH()

int manager::GetMCStatLLH

(

)

Get likelihood type defined in the config.

Definition at line 98 of file Manager.cpp.

                          {
// *************************
  int mc_stat_llh = kNTestStatistics;
  if (config["LikelihoodOptions"])
  {
    auto likelihood = GetFromManager<std::string>(config["LikelihoodOptions"]["TestStatistic"], "Barlow-Beeston", __FILE__ , __LINE__);
 
    for(int i = 0; i < kNTestStatistics; i++) {
      if(likelihood == TestStatistic_ToString(TestStatistic(i))) {
        mc_stat_llh = TestStatistic(i);
        break;
      }
    }
    if(mc_stat_llh == kNTestStatistics)
    {
      MACH3LOG_ERROR("Wrong form of test-statistic specified!");
      MACH3LOG_ERROR("You gave {} and I only support:", likelihood);
      for(int i = 0; i < kNTestStatistics; i++)
      {
        MACH3LOG_ERROR("{}", TestStatistic_ToString(TestStatistic(i)));
      }
      throw MaCh3Exception(__FILE__ , __LINE__ );
    }
  } else {
    MACH3LOG_WARN("Didn't find a TestStatistic specified");
    MACH3LOG_WARN("Defaulting to using a {} likelihood", TestStatistic_ToString(kPoisson));
    mc_stat_llh = kPoisson;
  }
  return mc_stat_llh;
}

GetName()

std::string manager::GetName ( ) const

inline

Get class name.

Definition at line 43 of file Manager.h.

{return "Manager";};

Initialise()

void manager::Initialise ( )

private

Common inialiser for both constructors.

Definition at line 27 of file Manager.cpp.

                         {
// *************************
  SetMaCh3LoggerFormat();
  MaCh3Utils::MaCh3Welcome();
 
  MACH3LOG_INFO("Setting config to be: {}", FileName);
 
  MACH3LOG_INFO("Config is now: ");
  MaCh3Utils::PrintConfig(config);
}

OverrideSettings()

template<typename... Args>

void manager::OverrideSettings ( Args &&...  args )

inline

Overrides the configuration settings based on provided arguments.

Note

Example usage:

FitManager->OverrideSettings("General", "OutputFile", "Wooimbouttamakeanameformyselfere.root");

Definition at line 51 of file Manager.h.

                                        {
    OverrideConfig(config, std::forward<Args>(args)...);
  }

Print()

void manager::Print

(

)

Print currently used config.

Definition at line 90 of file Manager.cpp.

                    {
// *************************
  MACH3LOG_INFO("---------------------------------");
  MaCh3Utils::PrintConfig(config);
  MACH3LOG_INFO("---------------------------------");
}

raw()

YAML::Node const & manager::raw ( )

inline

Return config.

Definition at line 41 of file Manager.h.

{return config;}

SaveSettings()

void manager::SaveSettings

(

TFile *const

OutputFile

)

Add manager useful information's to TFile, in most cases to Fitter.

Parameters

OutputFile

The ROOT TFile to which the information will be added.

Definition at line 49 of file Manager.cpp.

                                                  {
// *************************
  std::string OutputFilename = std::string(OutputFile->GetName());
  OutputFile->cd();
 
  // EM: embed the config used for this app
  TMacro ConfigSave = YAMLtoTMacro(config, "MaCh3_Config");
  ConfigSave.Write();
 
  // The Branch!
  TTree *SaveBranch = new TTree("Settings", "Settings");
 
  // Fill the doubles
  SaveBranch->Branch("Output", &OutputFilename);
 
  // Get settings defined by pre-processor directives, e.g. CPU MP and GPU
  #ifdef MULTITHREAD
  bool cpu_mp_on = true;
  int n_cpus = omp_get_max_threads();
  #else
  bool cpu_mp_on = false;
  int n_cpus = 1;
  #endif
 
  #ifdef MaCh3_CUDA
  bool gpu_on = true;
  #else
  bool gpu_on = false;
  #endif
 
  SaveBranch->Branch("GPU",   &gpu_on);
  SaveBranch->Branch("CPUMP", &cpu_mp_on);
  SaveBranch->Branch("nCPUs", &n_cpus);
 
  SaveBranch->Fill();
  SaveBranch->Write();
 
  delete SaveBranch;
}

Member Data Documentation

config

YAML::Node manager::config

private

The YAML node containing the configuration data.

Definition at line 60 of file Manager.h.

FileName

std::string manager::FileName

private

The name of the configuration file.

Definition at line 62 of file Manager.h.

---

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

• Manager/Manager.h
• Manager/Manager.cpp