ParameterStructs.h File Reference

Definitions of generic parameter structs and utility templates for MaCh3. More...

#include <set>
#include <list>
#include <unordered_map>
#include "Manager/MaCh3Exception.h"
#include "Manager/MaCh3Logger.h"
#include "Manager/Core.h"
#include "TSpline.h"
#include "TObjString.h"
#include "TFile.h"
#include "TF1.h"
#include "TH2Poly.h"
#include "TH1.h"

Include dependency graph for ParameterStructs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	TypeParameterBase
	Base class storing info for parameters types, helping unify codebase. More...
struct	NormParameter
	ETA - Normalisations for cross-section parameters Carrier for whether you want to apply a systematic to an event or not. More...
struct	FunctionalParameter
	HH - Functional parameters Carrier for whether you want to apply a systematic to an event or not. More...
struct	SplineParameter
	KS: Struct holding info about Spline Systematics. More...
struct	OscillationParameter
	KS: Struct holding info about oscillation Systematics. More...

Typedefs
using	FuncParFuncType = std::function< void(const M3::float_t *, std::size_t)>
	HH - a shorthand type for funcpar functions. More...

Enumerations
enum	RespFuncType { kTSpline3_red , kTF1_red , kRespFuncTypes }
	Make an enum of the spline interpolation type. More...
enum	SplineInterpolation {   kTSpline3 , kLinear , kMonotonic , kAkima ,   kKochanekBartels , kLinearFunc , kSplineInterpolations }
	Make an enum of the spline interpolation type. More...
enum	SystType {   kNorm , kSpline , kFunc , kOsc ,   kSystTypes }

Functions
template<typename T , size_t N>
std::vector< T >	MakeVector (const T(&data)[N])
	Template to make vector out of an array of any length. More...
template<typename T >
void	CleanVector (T &)
	Base case: do nothing for non-vector types. More...
template<typename T >
void	CleanVector (std::vector< T > &v)
	Recursively releases memory held by a std::vector (including nested). More...
template<typename T >
void	CleanContainer (T &)
	Base case: do nothing for non-pointer types. More...
template<typename T >
void	CleanContainer (T *&ptr)
	Deletes an owned raw pointer and nulls it. More...
template<typename T >
void	CleanContainer (std::vector< T > &container)
	Recursively deletes elements stored as pointers inside containers and releases the container capacity. More...
std::string	GetTF1 (const SplineInterpolation i)
	Get function for TF1_red. More...
RespFuncType	SplineInterpolation_ToRespFuncType (const SplineInterpolation i)
	Convert a RespFuncType type to a SplineInterpolation. More...
std::string	SplineInterpolation_ToString (const SplineInterpolation i)
	Convert a LLH type to a string. More...
std::string	SystType_ToString (const SystType i)
	Convert a Syst type type to a string. More...

Detailed Description

Definitions of generic parameter structs and utility templates for MaCh3.

Author

Asher Kaboth

Clarence Wret

Patrick Dunne

Dan Barrow

Ed Atkin

Kamil Skwarczynski

Definition in file ParameterStructs.h.

Typedef Documentation

FuncParFuncType

using FuncParFuncType = std::function<void (const M3::float_t*, std::size_t)>

HH - a shorthand type for funcpar functions.

Definition at line 136 of file ParameterStructs.h.

Enumeration Type Documentation

RespFuncType

enum RespFuncType

Make an enum of the spline interpolation type.

Enumerator
kTSpline3_red	Uses TSpline3_red for interpolation.
kTF1_red	Uses TF1_red for interpolation.
kRespFuncTypes	This only enumerates.

Definition at line 154 of file ParameterStructs.h.

                  {
  kTSpline3_red,  
  kTF1_red,       
  kRespFuncTypes  
};

SplineInterpolation

enum SplineInterpolation

Make an enum of the spline interpolation type.

Enumerator
kTSpline3	Default TSpline3 interpolation.
kLinear	Linear interpolation between knots.
kMonotonic	EM: DOES NOT make the entire spline monotonic, only the segments.
kAkima	EM: Akima spline iis allowed to be discontinuous in 2nd derivative and coefficients in any segment.
kKochanekBartels	KS: Kochanek-Bartels spline: allows local control of tension, continuity, and bias.
kLinearFunc	Liner interpolation using TF1 not spline.
kSplineInterpolations	This only enumerates.

Definition at line 161 of file ParameterStructs.h.

                         {
  kTSpline3,             
  kLinear,               
  kMonotonic,            
  kAkima,                
  kKochanekBartels,      
  kLinearFunc,           
  kSplineInterpolations  
};

SystType

enum SystType

Make an enum of systematic type recognised by covariance class

Todo:

KS: Consider using enum class, it is generally recommended as safer. It will require many static_cast

Enumerator
kNorm	For normalisation parameters.
kSpline	For splined parameters (1D)
kFunc	For functional parameters.
kOsc	For oscillation parameters.
kSystTypes	This only enumerates.

Definition at line 264 of file ParameterStructs.h.

              {
  kNorm,      
  kSpline,    
  kFunc,      
  kOsc,       
  kSystTypes  
};

Function Documentation

CleanContainer() [1/3]

template<typename T >

void CleanContainer

(

std::vector< T > &

container

)

Recursively deletes elements stored as pointers inside containers and releases the container capacity.

This is required for structures like std::vector<T*> or deeply nested pointer containers. Without deleting first, memory is leaked; without shrink_to_fit(), capacity is retained.

Definition at line 86 of file ParameterStructs.h.

                                             {
  // *******************
  for (auto& element : container)
    CleanContainer(element);
 
  container.clear();
  container.shrink_to_fit();
}

CleanContainer() [2/3]

template<typename T >

void CleanContainer

(

T &

)

Base case: do nothing for non-pointer types.

Definition at line 64 of file ParameterStructs.h.

{}

CleanContainer() [3/3]

template<typename T >

void CleanContainer

(

T *&

ptr

)

Deletes an owned raw pointer and nulls it.

Only use when ownership is explicit (allocated with new).

Definition at line 72 of file ParameterStructs.h.

                             {
  // *******************
  delete ptr;
  ptr = nullptr;
}

CleanVector() [1/2]

template<typename T >

void CleanVector

(

std::vector< T > &

v

)

Recursively releases memory held by a std::vector (including nested).

Recursively clears a vector and requests release of its unused capacity. clear() or vec = {} only destroy elements but keep the allocated buffer. For deeply nested vectors we must clean children first, then call shrink_to_fit() to ask the implementation to return the capacity.

Definition at line 52 of file ParameterStructs.h.

                                  {
// *******************
  for (auto& x : v)
    CleanVector(x);
 
  v.clear();
  v.shrink_to_fit();
}

CleanVector() [2/2]

template<typename T >

void CleanVector

(

T &

)

Base case: do nothing for non-vector types.

Definition at line 42 of file ParameterStructs.h.

{}

GetTF1()

std::string GetTF1 ( const SplineInterpolation  i )

inline

Get function for TF1_red.

Parameters

i	Interpolation type

Definition at line 174 of file ParameterStructs.h.

                                                     {
  // **************************************************
  std::string Func = "";
  switch(i) {
    case SplineInterpolation::kLinearFunc:
      Func = "([1]+[0]*x)";
      break;
    case SplineInterpolation::kTSpline3:
    case SplineInterpolation::kLinear:
    case SplineInterpolation::kMonotonic:
    case SplineInterpolation::kAkima:
    case SplineInterpolation::kKochanekBartels:
    case SplineInterpolation::kSplineInterpolations:
      MACH3LOG_ERROR("Interpolation type {} not supported for TF1!", static_cast<int>(i));
      throw MaCh3Exception(__FILE__, __LINE__);
    default:
      MACH3LOG_ERROR("UNKNOWN SPLINE INTERPOLATION SPECIFIED!");
      MACH3LOG_ERROR("You gave {}", static_cast<int>(i));
      throw MaCh3Exception(__FILE__ , __LINE__ );
  }
  return Func;
}

MakeVector()

template<typename T , size_t N>

std::vector<T> MakeVector

(

const T(&)

data[N]

)

Template to make vector out of an array of any length.

Definition at line 35 of file ParameterStructs.h.

                                              {
// *******************
  return std::vector<T>(data, data+N);
}

SplineInterpolation_ToRespFuncType()

RespFuncType SplineInterpolation_ToRespFuncType ( const SplineInterpolation  i )

inline

Convert a RespFuncType type to a SplineInterpolation.

Parameters

i	Interpolation type

Definition at line 200 of file ParameterStructs.h.

                                                                                    {
// **************************************************
  RespFuncType Type = kRespFuncTypes;
  switch(i) {
    case SplineInterpolation::kTSpline3:
    case SplineInterpolation::kLinear:
    case SplineInterpolation::kMonotonic:
    case SplineInterpolation::kAkima:
    case SplineInterpolation::kKochanekBartels:
      Type = RespFuncType::kTSpline3_red;
      break;
    case SplineInterpolation::kLinearFunc:
      Type = RespFuncType::kTF1_red;
      break;
    case SplineInterpolation::kSplineInterpolations:
      MACH3LOG_ERROR("kSplineInterpolations is not a valid interpolation type!");
      throw MaCh3Exception(__FILE__, __LINE__);
    default:
      MACH3LOG_ERROR("UNKNOWN SPLINE INTERPOLATION SPECIFIED!");
      MACH3LOG_ERROR("You gave {}", static_cast<int>(i));
      throw MaCh3Exception(__FILE__, __LINE__);
  }
  return Type;
}

SplineInterpolation_ToString()

std::string SplineInterpolation_ToString ( const SplineInterpolation  i )

inline

Convert a LLH type to a string.

Definition at line 227 of file ParameterStructs.h.

                                                                           {
// **************************************************
  std::string name = "";
  switch(i) {
    //  TSpline3 (third order spline in ROOT)
    case SplineInterpolation::kTSpline3:
      name = "TSpline3";
      break;
    case SplineInterpolation::kLinear:
      name = "Linear";
      break;
    case SplineInterpolation::kMonotonic:
      name = "Monotonic";
      break;
    //  (Experimental) Akima_Spline (crd order spline which is allowed to be discontinuous in 2nd deriv)
    case SplineInterpolation::kAkima:
      name = "Akima";
      break;
    case SplineInterpolation::kKochanekBartels:
      name = "KochanekBartels";
      break;
    case SplineInterpolation::kLinearFunc:
      name = "LinearFunc";
      break;
    case SplineInterpolation::kSplineInterpolations:
      MACH3LOG_ERROR("kSplineInterpolations is not a valid interpolation type!");
      throw MaCh3Exception(__FILE__, __LINE__);
    default:
      MACH3LOG_ERROR("UNKNOWN SPLINE INTERPOLATION SPECIFIED!");
      MACH3LOG_ERROR("You gave {}", static_cast<int>(i));
      throw MaCh3Exception(__FILE__ , __LINE__ );
  }
  return name;
}

SystType_ToString()

std::string SystType_ToString ( const SystType  i )

inline

Convert a Syst type type to a string.

Definition at line 293 of file ParameterStructs.h.

                                                     {
// **************************************************
  std::string name = "";
  switch(i) {
    case SystType::kNorm:
      name = "Norm";
      break;
    case SystType::kSpline:
      name = "Spline";
      break;
    case SystType::kFunc:
      name = "Functional";
      break;
    case SystType::kOsc:
      name = "Oscillation";
      break;
    case SystType::kSystTypes:
      MACH3LOG_ERROR("kSystTypes is not a valid SystType!");
      throw MaCh3Exception(__FILE__, __LINE__);
    default:
      MACH3LOG_ERROR("UNKNOWN SYST TYPE SPECIFIED!");
      MACH3LOG_ERROR("You gave {}", static_cast<int>(i));
      throw MaCh3Exception(__FILE__ , __LINE__ );
  }
  return name;
}