ParameterTunes Class Reference

Class storing tune values, for example allowing flexibly to retrieve parameter values for for PostND tunes. More...

#include <Parameters/ParameterTunes.h>

Collaboration diagram for ParameterTunes:

Public Member Functions
	ParameterTunes (const YAML::Node &Settings)
	Constructor. More...
virtual	~ParameterTunes ()
std::vector< double >	GetTune (const int TuneNumber) const
	Return vector of tune vales for each parameter. More...
std::vector< double >	GetTune (const std::string &TuneName) const
	Return vector of tune vales for each parameter. More...
void	PrintTunes () const
	Simply print all tunes and associated values. More...

Private Attributes
std::vector< std::string >	TuneNames
	Name of each Tun. More...
std::vector< std::vector< double > >	TuneValues
	Values for each Tune and Parameter. More...
std::unordered_map< std::string, int >	TuneMap
	Map between tune name and value. More...

Detailed Description

Class storing tune values, for example allowing flexibly to retrieve parameter values for for PostND tunes.

Author

Kamil Skwarczynski

Definition at line 9 of file ParameterTunes.h.

Constructor & Destructor Documentation

ParameterTunes()

ParameterTunes::ParameterTunes

(

const YAML::Node &

Settings

)

Constructor.

Definition at line 4 of file ParameterTunes.cpp.

                                                       {
// ********************************************
  std::map<std::string, std::vector<double>> orderedTunes;
 
  // Loop over all systematics
  for (const auto& sysNode : Settings) {
    const auto& values = sysNode["Systematic"]["ParameterValues"];
 
    for (const auto& tuneNode : values) {
      std::string key = tuneNode.first.as<std::string>();
      if (key == "PreFitValue") continue;
 
      double val = tuneNode.second.as<double>();
      orderedTunes[key].push_back(val);
    }
  }
 
  size_t expectedSize = 0;
  bool hasMismatch = false;
  std::ostringstream errorMsg;
  errorMsg << "Inconsistent number of parameter values across tunes:\n";
 
  for (const auto& kv : orderedTunes) {
    const auto& vals = kv.second;
    if (expectedSize == 0) {
      expectedSize = vals.size();
    } else if (vals.size() != expectedSize) {
      hasMismatch = true;
    }
    errorMsg << " - Tune '" << kv.first << "': " << vals.size() << " values\n";
  }
 
  if (hasMismatch) {
    errorMsg << "Expected all tunes to have " << expectedSize << " values.";
    MACH3LOG_ERROR("{}", errorMsg.str());
    throw MaCh3Exception(__FILE__, __LINE__);
  }
 
  int idx = 0;
  for (const auto& kv : orderedTunes) {
    TuneNames.push_back(kv.first);
    TuneValues.push_back(kv.second);
    TuneMap[kv.first] = idx++;
  }
 
  // KS: Log final summary of found tunes
  MACH3LOG_INFO("Found {} tunes:", TuneNames.size());
  for (size_t i = 0; i < TuneNames.size(); ++i) {
    MACH3LOG_INFO("  Tune {} {}", i, TuneNames[i]);
  }
  #ifdef DEBUG
  PrintTunes();
  #endif
}

~ParameterTunes()

ParameterTunes::~ParameterTunes ( )

virtual

Definition at line 60 of file ParameterTunes.cpp.

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

Member Function Documentation

GetTune() [1/2]

std::vector< double > ParameterTunes::GetTune

(

const int

TuneNumber

)

const

Return vector of tune vales for each parameter.

Definition at line 65 of file ParameterTunes.cpp.

                                                                    {
// ********************************************
  if (TuneNumber >= static_cast<int>(TuneValues.size())) {
    MACH3LOG_ERROR("I only have {} tune(s), but you asked for index {}", TuneValues.size(), TuneNumber);
    throw MaCh3Exception(__FILE__, __LINE__);
  }
 
  return TuneValues[TuneNumber];
}

GetTune() [2/2]

std::vector< double > ParameterTunes::GetTune

(

const std::string &

TuneName

)

const

Return vector of tune vales for each parameter.

Definition at line 76 of file ParameterTunes.cpp.

                                                                         {
// ********************************************
  auto it = TuneMap.find(TuneName);
  if (it == TuneMap.end()) {
    MACH3LOG_ERROR("Tune '{}' not found. Available tunes: {}", TuneName, fmt::join(TuneNames, ", "));
    throw MaCh3Exception(__FILE__, __LINE__);
  }
 
  return GetTune(it->second);
}

PrintTunes()

void ParameterTunes::PrintTunes

(

)

const

Simply print all tunes and associated values.

Definition at line 88 of file ParameterTunes.cpp.

                                      {
// ********************************************
  MACH3LOG_INFO("Available tunes:");
  for (size_t i = 0; i < TuneNames.size(); ++i) {
    MACH3LOG_INFO("  Tune {} {}", i, TuneNames[i]);
      for (size_t j = 0; j < TuneValues[i].size(); ++j) {
        MACH3LOG_INFO("    Value {} = {}", j, TuneValues[i][j]);
    }
  }
}

Member Data Documentation

TuneMap

std::unordered_map<std::string, int> ParameterTunes::TuneMap

private

Map between tune name and value.

Definition at line 28 of file ParameterTunes.h.

TuneNames

std::vector<std::string> ParameterTunes::TuneNames

private

Name of each Tun.

Definition at line 24 of file ParameterTunes.h.

TuneValues

std::vector<std::vector<double> > ParameterTunes::TuneValues

private

Values for each Tune and Parameter.

Definition at line 26 of file ParameterTunes.h.

---

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

• Parameters/ParameterTunes.h
• Parameters/ParameterTunes.cpp