MaCh3  2.6.0
Reference Guide
ParameterHandlerGeneric.h
Go to the documentation of this file.
1 #pragma once
2 
3 // MaCh3 includes
6 
15  public:
22  ParameterHandlerGeneric(const std::vector<std::string>& FileNames, std::string name = "xsec_cov", double threshold = -1, int FirstPCAdpar = -999, int LastPCAdpar = -999);
25 
26  // General Getter functions not split by detector
29  std::vector<std::string> GetParSampleID(const int i) const { return _fSampleNames[i];};
32  std::string GetParamTypeString(const int i) const { return SystType_ToString(_fParamType[i]); }
35  SystType GetParamType(const int i) const {return _fParamType[i];}
36 
39  SplineInterpolation GetParSplineInterpolation(const int i) const {return SplineParams.at(i)._SplineInterpolationType;}
41  const std::vector<SplineInterpolation> GetSplineInterpolationFromSampleName(const std::string& SampleName) const;
44  std::string GetParSplineName(const int i) const {return SplineParams.at(i)._fSplineNames;}
45 
47  const std::vector<int> GetGlobalSystIndexFromSampleName(const std::string& SampleName, const SystType Type) const;
50  double GetParSplineKnotUpperBound(const int i) const {return SplineParams.at(i)._SplineKnotUpBound;}
53  double GetParSplineKnotLowerBound(const int i) const {return SplineParams.at(i)._SplineKnotLowBound;}
54 
58  int GetNumParamsFromSampleName(const std::string& SampleName, const SystType Type) const;
62  const std::vector<std::string> GetParsNamesFromSampleName(const std::string& SampleName, const SystType Type) const;
66  const std::vector<int> GetParsIndexFromSampleName(const std::string& SampleName, const SystType Type) const;
67 
69  const std::vector<std::string> GetSplineParsNamesFromSampleName(const std::string& SampleName) const;
71  const std::vector<std::string> GetSplineFileParsNamesFromSampleName(const std::string& SampleName) const;
72 
74  const std::vector< std::vector<int> > GetSplineModeVecFromSampleName(const std::string& SampleName) const;
78  const std::vector<int> GetSystIndexFromSampleName(const std::string& SampleName, const SystType Type) const;
80  const std::vector<NormParameter> GetNormParsFromSampleName(const std::string& SampleName) const;
82  const std::vector<FunctionalParameter> GetFunctionalParametersFromSampleName(const std::string& SampleName) const;
84  const std::vector<SplineParameter> GetSplineParsFromSampleName(const std::string& SampleName) const;
85 
90  bool IsParFromGroup(const int i, const std::string& Group) const;
91 
93  int GetNumParFromGroup(const std::string& Group) const;
95  std::vector<std::string> GetUniqueParameterGroups() const;
96 
101  void SetGroupOnlyParameters(const std::string& Group, const std::vector<double>& Pars = {});
104  void SetGroupOnlyParameters(const std::vector<std::string>& Groups);
105 
108  void SetFixGroupOnlyParameters(const std::string& Group);
111  void SetFixGroupOnlyParameters(const std::vector<std::string>& Groups);
112 
115  void SetFreeGroupOnlyParameters(const std::string& Group);
118  void SetFreeGroupOnlyParameters(const std::vector<std::string>& Groups);
119 
123  void DumpMatrixToFile(const std::string& Name);
124 
126  std::vector<const M3::float_t*> GetOscParsFromSampleName(const std::string& SampleName) const;
127 
128  protected:
131  void InitialiseFromConfig(const std::vector<std::string>& YAMLFile);
133  void Print() const;
135  void PrintGlobablInfo() const;
137  void PrintNormParams() const;
139  void PrintSplineParams() const;
141  void PrintFunctionalParams() const;
143  void PrintOscillationParams() const;
145  void PrintParameterGroups() const;
146 
148  void CheckCorrectInitialisation() const;
150  void LoadCorrelationFromConfig(std::vector<std::map<std::string,double>>& Correlations,
151  std::map<std::string, int>& CorrNamesMap);
153  void LoadAndMergeYAML(const std::vector<std::string>& YAMLFile,
154  std::map<std::pair<int,int>, std::unique_ptr<TMatrixDSym>>& overrides);
167  template <typename FilterFunc, typename ActionFunc>
168  void IterateOverParams(const std::string& SampleName, FilterFunc filter, ActionFunc action) const;
169 
173  void InitParameters();
174 
178 
182  NormParameter GetNormParameter(const YAML::Node& param, const int Index) const;
183 
187  OscillationParameter GetOscillationParameters(const YAML::Node& param, const int Index) const;
188 
192  FunctionalParameter GetFunctionalParameters(const YAML::Node& param, const int Index) const;
196  SplineParameter GetSplineParameter(const YAML::Node& param, const int Index) const;
201  void GetBaseParameter(const YAML::Node& param, const int Index, TypeParameterBase& Parameter) const;
202 
206  bool AppliesToSample(const int SystIndex, const std::string& SampleName) const;
207 
214  template<typename ParamT>
215  std::vector<ParamT> GetTypeParamsFromSampleName(const std::map<int, int>& indexMap, const std::vector<ParamT>& params, const std::string& SampleName) const;
216 
218  std::vector<std::vector<std::string>> _fSampleNames;
219 
221  std::vector<SystType> _fParamType;
222 
224  std::vector<std::string> _ParameterGroup;
225 
227  std::vector<std::map<int, int>> _fSystToGlobalSystIndexMap;
228 
230  std::vector<SplineParameter> SplineParams;
231 
233  std::vector<NormParameter> NormParams;
234 
236  std::vector<FunctionalParameter> FuncParams;
237 
239  std::vector<OscillationParameter> OscParams;
240 };
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 for handling systematic uncertainty parameters.
Class responsible for handling of systematic error parameters with different types defined in the con...
void PrintGlobablInfo() const
Prints general information about the ParameterHandler object.
void Print() const
Print information about the whole object once it is set.
std::vector< SplineParameter > SplineParams
Vector containing info for normalisation systematics.
FunctionalParameter GetFunctionalParameters(const YAML::Node &param, const int Index) const
Get Func params.
const std::vector< NormParameter > GetNormParsFromSampleName(const std::string &SampleName) const
DB Get norm/func parameters depending on given SampleName.
std::vector< std::string > GetUniqueParameterGroups() const
KS: Get names of all unique parameter groups.
ParameterHandlerGeneric(const std::vector< std::string > &FileNames, std::string name="xsec_cov", double threshold=-1, int FirstPCAdpar=-999, int LastPCAdpar=-999)
Constructor.
void PrintSplineParams() const
Prints spline parameters.
std::vector< const M3::float_t * > GetOscParsFromSampleName(const std::string &SampleName) const
Get pointers to Osc params from Sample name.
void IterateOverParams(const std::string &SampleName, FilterFunc filter, ActionFunc action) const
Iterates over parameters and applies a filter and action function.
const std::vector< int > GetParsIndexFromSampleName(const std::string &SampleName, const SystType Type) const
DB Grab the parameter indices for the relevant SampleName.
SplineParameter GetSplineParameter(const YAML::Node &param, const int Index) const
Get Spline params.
SystType GetParamType(const int i) const
Returns enum describing our param type.
const std::vector< int > GetSystIndexFromSampleName(const std::string &SampleName, const SystType Type) const
Grab the index of the syst relative to global numbering.
void GetBaseParameter(const YAML::Node &param, const int Index, TypeParameterBase &Parameter) const
Fill base parameters.
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 LoadCorrelationFromConfig(std::vector< std::map< std::string, double >> &Correlations, std::map< std::string, int > &CorrNamesMap)
Load correlation from yaml config.
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.
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 PrintOscillationParams() const
Prints oscillation parameters.
const std::vector< std::string > GetSplineFileParsNamesFromSampleName(const std::string &SampleName) const
DB Get spline parameters depending on given SampleName.
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.
void InitParametersTypeFromConfig()
Parses the YAML configuration to set up cross-section parameters. The YAML file defines the types of ...
std::vector< std::vector< std::string > > _fSampleNames
Tells to which samples object param should be applied.
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.
std::vector< FunctionalParameter > FuncParams
Vector containing info for functional systematics.
int GetNumParamsFromSampleName(const std::string &SampleName, const SystType Type) const
DB Grab the number of parameters for the relevant SampleName.
void PrintFunctionalParams() const
Prints functional parameters.
const std::vector< std::string > GetParsNamesFromSampleName(const std::string &SampleName, const SystType Type) const
DB Grab the parameter names for the relevant SampleName.
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.
const std::vector< std::string > GetSplineParsNamesFromSampleName(const std::string &SampleName) const
DB Get spline parameters depending on given SampleName.
SplineInterpolation GetParSplineInterpolation(const int i) const
Get interpolation type for a given parameter.
void InitParameters()
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) const
DB Get spline parameters depending on given SampleName.
OscillationParameter GetOscillationParameters(const YAML::Node &param, const int Index) const
Get Osc params.
NormParameter GetNormParameter(const YAML::Node &param, const int Index) const
Get Norm params.
bool AppliesToSample(const int SystIndex, const std::string &SampleName) const
Check if parameter is affecting given sample name.
const std::vector< SplineInterpolation > GetSplineInterpolationFromSampleName(const std::string &SampleName) const
Get the interpolation types for splines affecting a particular SampleName.
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 CheckCorrectInitialisation() const
KS: Check if matrix is correctly initialised.
void InitialiseFromConfig(const std::vector< std::string > &YAMLFile)
Initialisation of the class using config.
void SetFixGroupOnlyParameters(const std::string &Group)
TN Method to set parameters within a group to be fixed to their prior values.
std::vector< std::string > _ParameterGroup
KS: Allow to group parameters for example to affect only cross-section or only flux etc.
void LoadAndMergeYAML(const std::vector< std::string > &YAMLFile, std::map< std::pair< int, int >, std::unique_ptr< TMatrixDSym >> &overrides)
Initialise single yaml based on several yaml files.
double GetParSplineKnotLowerBound(const int i) const
EM: value at which we cap spline knot weight.
void PrintNormParams() const
Prints normalization parameters.
int GetNumParFromGroup(const std::string &Group) const
KS: Check how many parameters are associated with given group.
const std::vector< std::vector< int > > GetSplineModeVecFromSampleName(const std::string &SampleName) const
DB Grab the Spline Modes for the relevant SampleName.
void PrintParameterGroups() const
Prints groups of parameters.
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.