MaCh3  2.4.2
Reference Guide
ParameterHandlerGeneric.h
Go to the documentation of this file.
1 #pragma once
2 
3 // MaCh3 includes
6 
14  public:
21  ParameterHandlerGeneric(const std::vector<std::string>& FileNames, std::string name = "xsec_cov", double threshold = -1, int FirstPCAdpar = -999, int LastPCAdpar = -999);
24 
25  // General Getter functions not split by detector
28  inline std::vector<std::string> GetParSampleID(const int i) const { return _fSampleNames[i];};
31  inline std::string GetParamTypeString(const int i) const { return SystType_ToString(_fParamType[i]); }
34  inline SystType GetParamType(const int i) const {return _fParamType[i];}
35 
38  inline SplineInterpolation GetParSplineInterpolation(const int i) const {return SplineParams.at(i)._SplineInterpolationType;}
40  const std::vector<SplineInterpolation> GetSplineInterpolationFromSampleName(const std::string& SampleName);
43  std::string GetParSplineName(const int i) const {return _fSplineNames[i];}
44 
46  const std::vector<int> GetGlobalSystIndexFromSampleName(const std::string& SampleName, const SystType Type);
49  inline double GetParSplineKnotUpperBound(const int i) const {return SplineParams.at(i)._SplineKnotUpBound;}
52  inline double GetParSplineKnotLowerBound(const int i) const {return SplineParams.at(i)._SplineKnotLowBound;}
53 
57  int GetNumParamsFromSampleName(const std::string& SampleName, const SystType Type);
61  const std::vector<std::string> GetParsNamesFromSampleName(const std::string& SampleName, const SystType Type);
65  const std::vector<int> GetParsIndexFromSampleName(const std::string& SampleName, const SystType Type);
66 
68  const std::vector<std::string> GetSplineParsNamesFromSampleName(const std::string& SampleName);
70  const std::vector<std::string> GetSplineFileParsNamesFromSampleName(const std::string& SampleName);
71 
73  const std::vector< std::vector<int> > GetSplineModeVecFromSampleName(const std::string& SampleName);
77  const std::vector<int> GetSystIndexFromSampleName(const std::string& SampleName, const SystType Type) const;
79  const std::vector<NormParameter> GetNormParsFromSampleName(const std::string& SampleName) const;
81  const std::vector<FunctionalParameter> GetFunctionalParametersFromSampleName(const std::string& SampleName) const;
83  const std::vector<SplineParameter> GetSplineParsFromSampleName(const std::string& SampleName) const;
84 
89  bool IsParFromGroup(const int i, const std::string& Group) const;
90 
92  int GetNumParFromGroup(const std::string& Group) const;
94  std::vector<std::string> GetUniqueParameterGroups();
95 
100  void SetGroupOnlyParameters(const std::string& Group, const std::vector<double>& Pars = {});
103  void SetGroupOnlyParameters(const std::vector<std::string>& Groups);
104 
107  void SetFixGroupOnlyParameters(const std::string& Group);
110  void SetFixGroupOnlyParameters(const std::vector<std::string>& Groups);
111 
114  void SetFreeGroupOnlyParameters(const std::string& Group);
117  void SetFreeGroupOnlyParameters(const std::vector<std::string>& Groups);
118 
121  void ToggleFixGroupOnlyParameters(const std::string& Group);
124  void ToggleFixGroupOnlyParameters(const std::vector<std::string>& Groups);
125 
129  void DumpMatrixToFile(const std::string& Name);
130 
132  std::vector<const double*> GetOscParsFromSampleName(const std::string& SampleName);
133 
134  protected:
136  void Print();
138  void PrintGlobablInfo();
140  void PrintNormParams();
142  void PrintSplineParams();
144  void PrintFunctionalParams();
146  void PrintOscillationParams();
148  void PrintParameterGroups();
149 
152 
165  template <typename FilterFunc, typename ActionFunc>
166  void IterateOverParams(const std::string& SampleName, FilterFunc filter, ActionFunc action);
167 
171  void InitParams();
172 
176 
180  inline NormParameter GetNormParameter(const YAML::Node& param, const int Index);
181 
185  inline OscillationParameter GetOscillationParameters(const YAML::Node& param, const int Index);
186 
190  inline FunctionalParameter GetFunctionalParameters(const YAML::Node& param, const int Index);
194  inline SplineParameter GetSplineParameter(const YAML::Node& param, const int Index);
199  inline void GetBaseParameter(const YAML::Node& param, const int Index, TypeParameterBase& Parameter);
200 
207  template<typename ParamT>
208  std::vector<ParamT> GetTypeParamsFromSampleName(const std::map<int, int>& indexMap, const std::vector<ParamT>& params, const std::string& SampleName) const;
209 
211  std::vector<SystType> _fParamType;
212 
214  std::vector<std::string> _fSplineNames;
215 
217  std::vector<std::string> _ParameterGroup;
218 
220  std::vector<std::map<int, int>> _fSystToGlobalSystIndexMap;
221 
223  std::vector<SplineParameter> SplineParams;
224 
226  std::vector<NormParameter> NormParams;
227 
229  std::vector<FunctionalParameter> FuncParams;
230 
232  std::vector<OscillationParameter> OscParams;
233 };
SplineInterpolation
Make an enum of the spline interpolation type.
std::string SystType_ToString(const SystType i)
Convert a Syst type type to a string.
SystType
std::vector< std::string > FileNames
Definition: ProcessMCMC.cpp:28
Base class responsible for handling of systematic error parameters. Capable of using PCA or using ada...
std::vector< std::vector< std::string > > _fSampleNames
Tells to which samples object param should be applied.
Class responsible for handling of systematic error parameters with different types defined in the con...
void PrintNormParams()
Prints normalization parameters.
FunctionalParameter GetFunctionalParameters(const YAML::Node &param, const int Index)
Get Func params.
std::vector< SplineParameter > SplineParams
Vector containing info for normalisation systematics.
void PrintParameterGroups()
Prints groups of parameters.
SplineParameter GetSplineParameter(const YAML::Node &param, const int Index)
Get Spline params.
const std::vector< NormParameter > GetNormParsFromSampleName(const std::string &SampleName) const
DB Get norm/func parameters depending on given SampleName.
void Print()
Print information about the whole object once it is set.
ParameterHandlerGeneric(const std::vector< std::string > &FileNames, std::string name="xsec_cov", double threshold=-1, int FirstPCAdpar=-999, int LastPCAdpar=-999)
Constructor.
std::vector< std::string > _fSplineNames
Name of spline in TTree (TBranch),.
void PrintOscillationParams()
Prints oscillation parameters.
SystType GetParamType(const int i) const
Returns enum describing our param type.
void ToggleFixGroupOnlyParameters(const std::string &Group)
TN Method to toggle fix/free parameters within a group.
const std::vector< int > GetSystIndexFromSampleName(const std::string &SampleName, const SystType Type) const
Grab the index of the syst relative to global numbering.
void PrintSplineParams()
Prints spline parameters.
void InitParams()
Initializes the systematic parameters from the configuration file. This function loads parameters lik...
const std::vector< int > GetGlobalSystIndexFromSampleName(const std::string &SampleName, const SystType Type)
DB Get spline parameters depending on given SampleName.
std::vector< NormParameter > NormParams
Vector containing info for normalisation systematics.
std::vector< std::string > GetParSampleID(const int i) const
ETA - just return the int of the SampleName, this can be removed to do a string comp at some point.
double GetParSplineKnotUpperBound(const int i) const
EM: value at which we cap spline knot weight.
std::vector< std::map< int, int > > _fSystToGlobalSystIndexMap
Map between number of given parameter type with global parameter numbering. For example 2nd norm para...
void SetGroupOnlyParameters(const std::string &Group, const std::vector< double > &Pars={})
KS Function to set to prior parameters of a given group or values from vector.
std::vector< SystType > _fParamType
Type of parameter like norm, spline etc.
void PrintFunctionalParams()
Prints functional parameters.
void CheckCorrectInitialisation()
KS: Check if matrix is correctly initialised.
const std::vector< std::string > GetSplineFileParsNamesFromSampleName(const std::string &SampleName)
DB Get spline parameters depending on given SampleName.
const std::vector< int > GetParsIndexFromSampleName(const std::string &SampleName, const SystType Type)
DB Grab the parameter indices for the relevant SampleName.
const std::vector< SplineParameter > GetSplineParsFromSampleName(const std::string &SampleName) const
KS: Grab the Spline parameters for the relevant SampleName.
std::string GetParSplineName(const int i) const
Get the name of the spline associated with the spline at index i.
void PrintGlobablInfo()
Prints general information about the ParameterHandler object.
const std::vector< FunctionalParameter > GetFunctionalParametersFromSampleName(const std::string &SampleName) const
HH Get functional parameters for the relevant SampleName.
void SetFreeGroupOnlyParameters(const std::string &Group)
TN Method to set parameters within a group to be treated as free.
NormParameter GetNormParameter(const YAML::Node &param, const int Index)
Get Norm params.
void InitParametersTypeFromConfig()
Parses the YAML configuration to set up cross-section parameters. The YAML file defines the types of ...
std::vector< ParamT > GetTypeParamsFromSampleName(const std::map< int, int > &indexMap, const std::vector< ParamT > &params, const std::string &SampleName) const
Retrieve parameters that apply to a given sample name.
int GetNumParamsFromSampleName(const std::string &SampleName, const SystType Type)
DB Grab the number of parameters for the relevant SampleName.
const std::vector< std::string > GetParsNamesFromSampleName(const std::string &SampleName, const SystType Type)
DB Grab the parameter names for the relevant SampleName.
std::vector< FunctionalParameter > FuncParams
Vector containing info for functional systematics.
std::vector< OscillationParameter > OscParams
Vector containing info for functional systematics.
void DumpMatrixToFile(const std::string &Name)
Dump Matrix to ROOT file, useful when we need to pass matrix info to another fitting group.
SplineInterpolation GetParSplineInterpolation(const int i) const
Get interpolation type for a given parameter.
std::vector< std::string > GetUniqueParameterGroups()
KS: Get names of all unique parameter groups.
const std::vector< std::string > GetSplineParsNamesFromSampleName(const std::string &SampleName)
DB Get spline parameters depending on given SampleName.
OscillationParameter GetOscillationParameters(const YAML::Node &param, const int Index)
Get Osc params.
std::string GetParamTypeString(const int i) const
ETA - just return a string of "spline", "norm" or "functional".
bool IsParFromGroup(const int i, const std::string &Group) const
Checks if parameter belongs to a given group.
void SetFixGroupOnlyParameters(const std::string &Group)
TN Method to set parameters within a group to be fixed to their prior values.
void IterateOverParams(const std::string &SampleName, FilterFunc filter, ActionFunc action)
Iterates over parameters and applies a filter and action function.
void GetBaseParameter(const YAML::Node &param, const int Index, TypeParameterBase &Parameter)
Fill base parameters.
std::vector< std::string > _ParameterGroup
KS: Allow to group parameters for example to affect only cross-section or only flux etc.
const std::vector< SplineInterpolation > GetSplineInterpolationFromSampleName(const std::string &SampleName)
Get the interpolation types for splines affecting a particular SampleName.
double GetParSplineKnotLowerBound(const int i) const
EM: value at which we cap spline knot weight.
std::vector< const double * > GetOscParsFromSampleName(const std::string &SampleName)
Get pointers to Osc params from Sample name.
const std::vector< std::vector< int > > GetSplineModeVecFromSampleName(const std::string &SampleName)
DB Grab the Spline Modes for the relevant SampleName.
int GetNumParFromGroup(const std::string &Group) const
KS: Check how many parameters are associated with given group.
HH - Functional parameters Carrier for whether you want to apply a systematic to an event or not.
ETA - Normalisations for cross-section parameters Carrier for whether you want to apply a systematic ...
KS: Struct holding info about oscillation Systematics.
KS: Struct holding info about Spline Systematics.
Base class storing info for parameters types, helping unify codebase.