KS: Class describing MaCh3 modes used in the analysis, it is being initialised from config. More...

#include <Manager/MaCh3Modes.h>

Collaboration diagram for MaCh3Modes:

Public Member Functions
	MaCh3Modes (std::string const &filename)
	KS: Initialise MaCh3 modes using path to config. More...

	MaCh3Modes (const YAML::Node &config)
	KS: Initialise MaCh3 modes using config. More...

virtual	~MaCh3Modes ()
	KS: Empty destructor. More...

void	Print () const
	KS: Print info about initialised modes. More...

int	GetNModes () const
	KS: Get number of modes, keep in mind actual number is +1 greater due to unknown category. More...

of MaCh3 mode
KS: Make sure we don't have two modes with the same name
std::map< std::string, MaCh3Modes_t >	Mode
	KS: Handy map which helps find mode number based on string. More...

std::map< MaCh3Modes_t, MaCh3ModeInfo >	fMode
	KS: Main map storing info about used modes. More...

std::vector< int >	ModeMap
	KS: Handy map helping us find MaCh3 mode based on Generator mode value. More...

std::string	Title
	KS: Name of loaded modes. More...

std::string	Generator
	KS: Name of generator like NEUT, NuWro etc. this is to make stuff fancy. More...

int	NModes
	KS: Number of modes, keep in mind actual number is +1 greater due to unknown category. More...

int	nCCModes
	DB: Number of CC modes. More...

MaCh3Modes_t	GetMode (const std::string &name) const

std::string	GetMaCh3ModeName (const int Index) const
	KS: Get normal name of mode, if mode not known you will get UNKNOWN_BAD. More...

int	GetMaCh3ModePlotColor (const int Index) const
	KS: Get normal name of mode, if mode not known you will get UNKNOWN_BAD. More...

std::string	GetMaCh3ModeFancyName (const int Index) const
	KS: Get fancy name of mode, if mode not known you will get UNKNOWN_BAD. More...

bool	IsMaCh3ModeNC (const int Index) const
	DB: Get IsNC (a check whether the given MaCh3 corresponds to a Neutral Current mode) More...

std::string	GetSplineSuffixFromMaCh3Mode (const int Index)
	DB: Get binned spline mode suffic from MaCh3 Mode. More...

MaCh3Modes_t	GetModeFromGenerator (const int Index) const
	KS: Get MaCh3 mode from generator mode. More...

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

int	GetNCCModes () const
	Return count of CC modes. More...

void	Initialise (const YAML::Node &config)
	KS: Initialise MaCh3 modes based on provided config. More...

MaCh3Modes_t	EnsureModeNameRegistered (std::string const &name)

void	DeclareNewMode (std::string const &name, std::string const &fancyname, int PlotColor, std::vector< int > const &GenMap, const bool IsNC, const std::string &SplineSuffix)
	KS: Add new mode. More...

void	PrepareMap ()
	KS: Fill ModeMap. More...

Detailed Description

KS: Class describing MaCh3 modes used in the analysis, it is being initialised from config.

The class provides a translation layer between generator-specific interaction mode definitions and the analysis-level categories used inside MaCh3.

Different neutrino generators use different numbering and naming conventions. Additionally, an analysis may wish to group or redefine these modes. MaCh3Modes allows the user to define an experiment-specific mapping via a YAML configuration file.

The class builds:

A list of MaCh3 analysis modes
A mapping from generator mode IDs → MaCh3 categories
A protected fallback category (UNKNOWN_BAD) for unmapped values

Configuration Example

Example YAML configuration used to initialise the modes:

#########################################
Title: "T2K Interaction modes"
 
GeneratorName: "NEUT"
 
MaCh3Modes: [
  "CCQE",
  "CC1pipm",
  "2p2h",
]
 
CCQE:
  Name: "CCQE"
  GeneratorMaping: [1]      # 1 = CCQE
 
CC1pipm:
  Name: "CC 1#pi^{#pm}"
  GeneratorMaping: [11, 13] # 11 = CC1pi+1p, 13 = CC1pi+1n
 
2p2h:
  Name: "2p2h"
  GeneratorMaping: [2]      # 2 = (Nieves) MEC / 2p2h

Example Initialisation Dump

After loading the configuration, MaCh3 produces a mapping table like:

Printing MaCh3 Modes Called: T2K Interaction modes
===============================================================
#   | Name     | FancyName           | NEUT Modes
---------------------------------------------------------------
0   | CCQE     | CCQE                | 1
1   | CC1pipm  | CC 1#pi^{#pm}       | 11 13
2   | 2p2h     | 2p2h                | 2
===============================================================
 
NEUT Modes | Name
---------------------------
0          | UNKNOWN_BAD
1          | CCQE
2          | 2p2h
3–10       | UNKNOWN_BAD
11         | CC1pipm
12         | UNKNOWN_BAD
13         | CC1pipm
===============================================================

Unknown Category Handling

Generators such as NEUT define many interaction codes that may not be used in a given analysis. Any generator mode not explicitly mapped is assigned to UNKNOWN_BAD.

This behaviour:

Prevents segfaults from invalid lookups
Allows sparse or partial mode definitions
Provides a safe catch-all for unexpected generator values

Usage Examples

Access a specific mode:

MaCh3Modes_t kMaCh3_CCQE = Modes->GetMode("CCQE");

MaCh3Modes_t

int MaCh3Modes_t

Enumerator of MaCh3Mode.

Definition: MaCh3Modes.h:14

Loop over all defined modes:

for (int j = 0; j < Modes->GetNModes() + 1; ++j) {
  Modes->GetMaCh3ModeName(j);
}

Note: If you attempt to access a mode outside the defined range, the class will return the UNKNOWN_BAD category instead of throwing.

Author: Kamil Skwarczynski; Daniel Barrow

Definition at line 135 of file MaCh3Modes.h.

Constructor & Destructor Documentation

◆ MaCh3Modes() [1/2]

MaCh3Modes::MaCh3Modes ( std::string const & filename )

KS: Initialise MaCh3 modes using path to config.

Definition at line 5 of file MaCh3Modes.cpp.

                                                 {
 // *******************
   // Load config
   YAML::Node config = M3OpenConfig(filename);
   Initialise(config);
 }

◆ MaCh3Modes() [2/2]

MaCh3Modes::MaCh3Modes ( const YAML::Node & config )

KS: Initialise MaCh3 modes using config.

Definition at line 13 of file MaCh3Modes.cpp.

                                              {
 // *******************
   Initialise(config);
 }

◆ ~MaCh3Modes()

virtual MaCh3Modes::~MaCh3Modes ( )

inlinevirtual

KS: Empty destructor.

Definition at line 142 of file MaCh3Modes.h.

142 {};

Member Function Documentation

◆ DeclareNewMode()

void MaCh3Modes::DeclareNewMode	(	std::string const &	name,
		std::string const &	fancyname,
		int	PlotColor,
		std::vector< int > const &	GenMap,
		const bool	IsNC,
		const std::string &	SplineSuffix
	)

inlineprivate

KS: Add new mode.

Definition at line 107 of file MaCh3Modes.cpp.

                                                {
 // *******************
   MaCh3ModeInfo newinfo;
   newinfo.GeneratorMaping = GenMap;
   newinfo.FancyName = fancyname;
   newinfo.PlotColor = PlotColor;
   newinfo.Name = name;
   newinfo.IsNC = IsNC;
   newinfo.SplineSuffix = SplineSuffix;
  
   MaCh3Modes_t index = EnsureModeNameRegistered(name);
  
   fMode.emplace(index, newinfo);
   NModes++;
 }

◆ EnsureModeNameRegistered()

MaCh3Modes_t MaCh3Modes::EnsureModeNameRegistered ( std::string const & name )

inlineprivate

Definition at line 96 of file MaCh3Modes.cpp.

                                                                        {
 // *******************
   if (Mode.count(name)) {
     return Mode[name];
   }
   MaCh3Modes_t index = MaCh3Modes_t(Mode.size());
   Mode[name] = index;
   return index;
 }

◆ GetMaCh3ModeFancyName()

std::string MaCh3Modes::GetMaCh3ModeFancyName ( const int Index ) const

KS: Get fancy name of mode, if mode not known you will get UNKNOWN_BAD.

Definition at line 186 of file MaCh3Modes.cpp.

                                                                  {
 // *******************
   // return UNKNOWN_BAD if out of boundary
   if(Index < 0)
     MACH3LOG_CRITICAL("Mode you look for is smaller than 0 and equal to {}", Index);
  
   if(Index > NModes)
   {
     MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", Index, NModes, fMode.at(NModes).Name);
     return fMode.at(NModes).FancyName;
   }
   return fMode.at(Index).FancyName;
 }

◆ GetMaCh3ModeName()

std::string MaCh3Modes::GetMaCh3ModeName ( const int Index ) const

KS: Get normal name of mode, if mode not known you will get UNKNOWN_BAD.

Definition at line 156 of file MaCh3Modes.cpp.

                                                             {
 // *******************
   if(Index < 0)
     MACH3LOG_CRITICAL("Mode you look for is smaller than 0 and equal to {}", Index);
  
   // return UNKNOWN_BAD if out of boundary
   if(Index > NModes)
   {
     MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", Index, NModes, fMode.at(NModes).Name);
     return fMode.at(NModes).Name;
   }
   return fMode.at(Index).Name;
 }

◆ GetMaCh3ModePlotColor()

int MaCh3Modes::GetMaCh3ModePlotColor ( const int Index ) const

KS: Get normal name of mode, if mode not known you will get UNKNOWN_BAD.

Definition at line 228 of file MaCh3Modes.cpp.

                                                            {
 // *******************
   // return UNKNOWN_BAD if out of boundary
   if(Index < 0)
     MACH3LOG_CRITICAL("Mode you look for is smaller than 0 and equal to {}", Index);
  
   if(Index > NModes)
   {
     MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", Index, NModes, fMode.at(NModes).PlotColor);
     return fMode.at(NModes).PlotColor;
   }
   return fMode.at(Index).PlotColor;
 }

◆ GetMode()

MaCh3Modes_t MaCh3Modes::GetMode ( const std::string & name ) const

Definition at line 201 of file MaCh3Modes.cpp.

                                                             {
 // *******************
   if (Mode.count(name)) {
     return Mode.at(name);
   }
   MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", name, NModes, fMode.at(NModes).Name);
  
   // return UNKNOWN_BAD
   return NModes;
 }

◆ GetModeFromGenerator()

MaCh3Modes_t MaCh3Modes::GetModeFromGenerator ( const int Index ) const

KS: Get MaCh3 mode from generator mode.

Definition at line 213 of file MaCh3Modes.cpp.

                                                                    {
 // *******************
   if(Index < 0)
     MACH3LOG_CRITICAL("Mode you look for is smaller than 0 and equal to {}", Index);
  
   if(Index >= static_cast<int>(ModeMap.size()))
   {
     MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", Index, NModes, fMode.at(NModes).Name);
     return NModes;
   }
  
   return ModeMap[Index];
 }

◆ GetName()

std::string MaCh3Modes::GetName ( ) const

inline

Get class name.

Definition at line 165 of file MaCh3Modes.h.

165 {return "MaCh3Modes";};

◆ GetNCCModes()

int MaCh3Modes::GetNCCModes ( ) const

inline

Return count of CC modes.

Definition at line 167 of file MaCh3Modes.h.

167 {return nCCModes;};

MaCh3Modes::nCCModes

int nCCModes

DB: Number of CC modes.

Definition: MaCh3Modes.h:203

◆ GetNModes()

int MaCh3Modes::GetNModes ( ) const

inline

KS: Get number of modes, keep in mind actual number is +1 greater due to unknown category.

Definition at line 148 of file MaCh3Modes.h.

148 {return NModes;}

◆ GetSplineSuffixFromMaCh3Mode()

std::string MaCh3Modes::GetSplineSuffixFromMaCh3Mode ( const int Index )

DB: Get binned spline mode suffic from MaCh3 Mode.

Definition at line 243 of file MaCh3Modes.cpp.

                                                                   {
   // *******************
   // return UNKNOWN_BAD if out of boundary
   if(Index < 0)
     MACH3LOG_CRITICAL("Mode you look for is smaller than 0 and equal to {}", Index);
  
   if(Index > NModes) {
     MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", Index, NModes, fMode[NModes].SplineSuffix);
     return fMode[NModes].SplineSuffix;
   }
  
   return fMode[Index].SplineSuffix;
 }

◆ Initialise()

void MaCh3Modes::Initialise ( const YAML::Node & config )

inlineprivate

KS: Initialise MaCh3 modes based on provided config.

Parameters

config YAML-based config used for class initialisation

Definition at line 19 of file MaCh3Modes.cpp.

                                                   {
 // *******************
   NModes = 0;
   nCCModes = 0;
  
   Title = config["Title"].as<std::string>();
   Generator = config["GeneratorName"].as<std::string>();
  
   auto names = Get<std::vector<std::string>>(config["MaCh3Modes"], __FILE__, __LINE__);
  
   for(size_t i = 0; i < names.size(); i++)
   {
     DeclareNewMode(names[i],
                    Get<std::string>(config[names[i]]["Name"], __FILE__, __LINE__),
                    Get<int>(config[names[i]]["PlotColor"], __FILE__, __LINE__),
                    Get<std::vector<int>>(config[names[i]]["GeneratorMaping"], __FILE__, __LINE__),
                    Get<bool>(config[names[i]]["IsNC"], __FILE__, __LINE__),
                    Get<std::string>(config[names[i]]["SplineSuffix"], __FILE__, __LINE__));
  
     if (!Get<bool>(config[names[i]]["IsNC"], __FILE__, __LINE__)) {
       nCCModes += 1;
     }
   }
   // Add unknown category, it's better to have garbage category where all undefined modes will go rather than get random crashes
   DeclareNewMode("UNKNOWN_BAD",
                  "UNKNOWN_BAD",
                  kBlack,
                  {},
                  false,
                  "UNKNOWN_BAD");
   // This is hack to not have bad mode
   NModes--;
  
   PrepareMap();
  
   Print();
 }

◆ IsMaCh3ModeNC()

bool MaCh3Modes::IsMaCh3ModeNC ( const int Index ) const

DB: Get IsNC (a check whether the given MaCh3 corresponds to a Neutral Current mode)

Definition at line 171 of file MaCh3Modes.cpp.

                                                     {
 // *******************
   if(Index < 0)
     MACH3LOG_CRITICAL("Mode you look for is smaller than 0 and equal to {}", Index);
   
   // return UNKNOWN_BAD if out of boundary
   if(Index > NModes)
   {
     MACH3LOG_DEBUG("Asking for mode {}, while I only have {}, returning {} mode", Index, NModes, fMode.at(NModes).Name);
     return fMode.at(NModes).IsNC;
   }
   return fMode.at(Index).IsNC;
 }

◆ PrepareMap()

void MaCh3Modes::PrepareMap ( )

inlineprivate

KS: Fill ModeMap.

Definition at line 129 of file MaCh3Modes.cpp.

                             {
 // *******************
   int maxElement = 0;
   for(int i = 0; i < NModes; ++i) {
     for(size_t j = 0; j < fMode[i].GeneratorMaping.size(); j++) {
       maxElement = std::max(maxElement, fMode[i].GeneratorMaping[j]);
     }
   }
   ModeMap.resize(maxElement+1, Mode["UNKNOWN_BAD"]);
  
   for(int m = 0; m < NModes; ++m) {
     for(size_t i = 0; i < fMode[m].GeneratorMaping.size(); ++i) {
       if(fMode[m].GeneratorMaping[i] < 0) {
         MACH3LOG_ERROR("Negative value of Mode {} for mode {}", fMode[m].GeneratorMaping[i], fMode[m].Name);
         throw MaCh3Exception(__FILE__ , __LINE__ );
       }
       if(ModeMap[fMode[m].GeneratorMaping[i]] != Mode["UNKNOWN_BAD"])
       {
         MACH3LOG_ERROR("Generator mode {} already defined in mode {} can't do this for mode {}", fMode[m].GeneratorMaping[i], fMode[ModeMap[fMode[m].GeneratorMaping[i]]].Name, fMode[m].Name);
         throw MaCh3Exception(__FILE__ , __LINE__ );
       }
       ModeMap[fMode[m].GeneratorMaping[i]] = m;
     }
   }
 }

◆ Print()

void MaCh3Modes::Print ( ) const

KS: Print info about initialised modes.

Definition at line 58 of file MaCh3Modes.cpp.

                              {
 // *******************
   MACH3LOG_INFO("Printing MaCh3 Modes Called: {}", Title);
  
   MACH3LOG_INFO("========================================================================");
   MACH3LOG_INFO("{:<5} {:2} {:<20} {:2} {:<20} {:2} {:<30}", "#", "|", "Name", "|", "FancyName", "|", Generator+" Modes");
   MACH3LOG_INFO("------------------------------------------------------------------------");
   for(int i = 0; i < NModes; ++i) {
     try {
       auto Name = fMode.at(i).Name;
       auto FancyName = fMode.at(i).FancyName;
       auto Values = fMode.at(i).GeneratorMaping;
       std::string generatorModes;
       for (const int& element : Values) {
         generatorModes += std::to_string(element) + " ";
       }
       MACH3LOG_INFO("{:<5} {:2} {:<20} {:2} {:<20} {:2} {:<30}", i, "|", Name, "|", FancyName, "|", generatorModes);
     } catch (const std::out_of_range& e) {
       MACH3LOG_ERROR("Index {} is out of bounds for fMode. Check NModes or fMode size.", i);
       throw MaCh3Exception(__FILE__ , __LINE__ );
     }
   }
   MACH3LOG_INFO("========================================================================");
   MACH3LOG_INFO("==========================");
   MACH3LOG_INFO("{:<10} {:2} {:<30}", Generator + " Modes", "|", "Name");
   MACH3LOG_INFO("--------------------------");
   for (size_t i = 0; i < ModeMap.size(); ++i) {
     try {
       MACH3LOG_INFO("{:<10} {:2} {:<30}", i, "|", fMode.at(ModeMap[i]).Name);
     } catch (const std::out_of_range& e) {
       MACH3LOG_ERROR("ModeMap[{}] = {} is out of bounds for fMode. Check ModeMap or fMode size.", i, ModeMap[i]);
       throw MaCh3Exception(__FILE__ , __LINE__ );
     }
   }
   MACH3LOG_INFO("==========================");
 }

Member Data Documentation

◆ fMode

std::map<MaCh3Modes_t, MaCh3ModeInfo> MaCh3Modes::fMode

private

KS: Main map storing info about used modes.

Definition at line 192 of file MaCh3Modes.h.

◆ Generator

std::string MaCh3Modes::Generator

private

KS: Name of generator like NEUT, NuWro etc. this is to make stuff fancy.

Definition at line 199 of file MaCh3Modes.h.

◆ Mode

std::map<std::string, MaCh3Modes_t> MaCh3Modes::Mode

private

KS: Handy map which helps find mode number based on string.

Definition at line 190 of file MaCh3Modes.h.

◆ ModeMap

std::vector<int> MaCh3Modes::ModeMap

private

KS: Handy map helping us find MaCh3 mode based on Generator mode value.

Definition at line 194 of file MaCh3Modes.h.

◆ nCCModes

int MaCh3Modes::nCCModes

private

DB: Number of CC modes.

Definition at line 203 of file MaCh3Modes.h.

◆ NModes

int MaCh3Modes::NModes

private

KS: Number of modes, keep in mind actual number is +1 greater due to unknown category.

Definition at line 201 of file MaCh3Modes.h.

◆ Title

std::string MaCh3Modes::Title

private

KS: Name of loaded modes.

Definition at line 197 of file MaCh3Modes.h.

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

Manager/MaCh3Modes.h
Manager/MaCh3Modes.cpp

Public Member Functions

of MaCh3 mode

Detailed Description

Configuration Example

Example Initialisation Dump

Unknown Category Handling

Usage Examples

Constructor & Destructor Documentation

◆ MaCh3Modes() [1/2]

◆ MaCh3Modes() [2/2]

◆ ~MaCh3Modes()

Member Function Documentation

◆ DeclareNewMode()

◆ EnsureModeNameRegistered()

◆ GetMaCh3ModeFancyName()

◆ GetMaCh3ModeName()

◆ GetMaCh3ModePlotColor()

◆ GetMode()

◆ GetModeFromGenerator()

◆ GetName()

◆ GetNCCModes()

◆ GetNModes()

◆ GetSplineSuffixFromMaCh3Mode()

◆ Initialise()

◆ IsMaCh3ModeNC()

◆ PrepareMap()

◆ Print()

Member Data Documentation

◆ fMode

◆ Generator

◆ Mode

◆ ModeMap

◆ nCCModes

◆ NModes

◆ Title