SampleStructs.h File Reference

#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 "Constants/OscillatorConstants.h"

Include dependency graph for SampleStructs.h:

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

Go to the source code of this file.

Classes
struct	KinematicCut
	KS: Small struct used for applying kinematic cuts. More...
struct	BinShiftLookup
	KS: Store bin lookups allowing to quickly find bin after migration. More...
struct	SampleBinningInfo
	KS: Small struct storying info about used binning. More...

Namespaces
	MaCh3Utils

Enumerations
enum	TargetMat {   kTarget_H = 1 , kTarget_C = 12 , kTarget_N = 14 , kTarget_O = 16 ,   kTarget_Al = 27 , kTarget_Ar = 40 , kTarget_Ti = 48 , kTarget_Fe = 56 ,   kTarget_Pb = 207 }
	Enum to track the target material. More...
enum	NuPDG {   kNue = 12 , kNumu = 14 , kNutau = 16 , kNueBar = -12 ,   kNumuBar = -14 , kNutauBar = -16 }
	Enum to track the incoming neutrino species. More...
enum	TestStatistic {   kPoisson , kBarlowBeeston , kIceCube , kPearson ,   kDembinskiAbdelmotteleb , kNTestStatistics }
	Make an enum of the test statistic that we're using. More...

Functions
constexpr unsigned int	str2int (const char *str, const int h=0)
	KS: This is mad way of converting string to int. Why? To be able to use string with switch. More...
std::string	TargetMat_ToString (const TargetMat i)
	Converted the Target Mat to a string. More...
std::string	TestStatistic_ToString (const TestStatistic TestStat)
	Convert a LLH type to a string. More...
int	GetSampleFromGlobalBin (const std::vector< SampleBinningInfo > &BinningInfo, const size_t GlobalBin)
	Get the sample index corresponding to a global bin number. More...
void	SetGlobalBinNumbers (std::vector< SampleBinningInfo > &BinningInfo)
	Sets the GlobalOffset for each SampleBinningInfo to enable linearization of multiple 2D binning samples. More...
double	MaCh3Utils::GetMassFromPDG (const int PDG)
	Return mass for given PDG. More...
int	MaCh3Utils::PDGToNuOscillatorFlavour (const int NuPdg)
	Convert from PDG flavour to NuOscillator type beware that in the case of anti-neutrinos the NuOscillator type simply gets multiplied by -1. More...
std::string	MaCh3Utils::FormatDouble (const double value, const int precision)
	Convert double into string for precision, useful for playing with yaml if you don't want to have in config floating point precision... More...

Detailed Description

Author

Asher Kaboth

Clarence Wret

Patrick Dunne

Dan Barrow

Ed Atkin

Kamil Skwarczynski

Definition in file SampleStructs.h.

Enumeration Type Documentation

NuPDG

enum NuPDG

Enum to track the incoming neutrino species.

Enumerator
kNue
kNumu
kNutau
kNueBar
kNumuBar
kNutauBar

Definition at line 101 of file SampleStructs.h.

           {
// *****************
  kNue = 12,
  kNumu = 14,
  kNutau = 16,
  kNueBar = -12,
  kNumuBar = -14,
  kNutauBar = -16
};

TargetMat

enum TargetMat

Enum to track the target material.

Enumerator
kTarget_H	Hydrogen (Atomic number 1)
kTarget_C	Carbon 12 (Atomic number 6)
kTarget_N	Nitrogen (Atomic number 7)
kTarget_O	Oxygen 16 (Atomic number 8)
kTarget_Al	Aluminum (Atomic number 13)
kTarget_Ar	Argon (Atomic number 18)
kTarget_Ti	Titanium (Atomic number 22)
kTarget_Fe	Iron (Atomic number 26)
kTarget_Pb	Lead (Atomic number 82)

Definition at line 44 of file SampleStructs.h.

               {
// *****************
  kTarget_H  = 1,    
  kTarget_C  = 12,   
  kTarget_N  = 14,   
  kTarget_O  = 16,   
  kTarget_Al = 27,   
  kTarget_Ar = 40,   
  kTarget_Ti = 48,   
  kTarget_Fe = 56,   
  kTarget_Pb = 207   
};

TestStatistic

enum TestStatistic

Make an enum of the test statistic that we're using.

Enumerator
kPoisson	Standard Poisson likelihood [2].
kBarlowBeeston	Barlow-Beeston ([3]) following Conway approximation ([5])
kIceCube	Based on [1].
kPearson	Standard Pearson likelihood [24].
kDembinskiAbdelmotteleb	Based on [6].
kNTestStatistics	Number of test statistics.

Definition at line 112 of file SampleStructs.h.

                   {
  kPoisson,                 
  kBarlowBeeston,           
  kIceCube,                 
  kPearson,                 
  kDembinskiAbdelmotteleb,  
  kNTestStatistics          
};

Function Documentation

GetSampleFromGlobalBin()

int GetSampleFromGlobalBin ( const std::vector< SampleBinningInfo > &  BinningInfo, const size_t  GlobalBin  )

inline

Get the sample index corresponding to a global bin number.

Parameters

BinningInfo	Vector of SampleBinningInfo structs.
GlobalBin	The global bin number.

Returns

The index of the sample, or garbage if not found.

Definition at line 304 of file SampleStructs.h.

                                                                                                           {
  for (size_t iSample = 0; iSample < BinningInfo.size(); ++iSample) {
    const SampleBinningInfo& info = BinningInfo[iSample];
    if (GlobalBin >= info.GlobalOffset && GlobalBin < info.GlobalOffset + info.nBins) {
      return static_cast<int>(iSample);
    }
  }
 
  MACH3LOG_ERROR("Couldn't find sample corresponding to bin {}", GlobalBin);
  throw MaCh3Exception(__FILE__, __LINE__);
 
  // GlobalBin is out of range for all samples
  return M3::_BAD_INT_;
}

SetGlobalBinNumbers()

void SetGlobalBinNumbers ( std::vector< SampleBinningInfo > &  BinningInfo )

inline

Sets the GlobalOffset for each SampleBinningInfo to enable linearization of multiple 2D binning samples.

Parameters

BinningInfo

Vector of SampleBinningInfo structs to be updated with global offsets.

Definition at line 321 of file SampleStructs.h.

                                                                           {
  if (BinningInfo.empty()) {
    MACH3LOG_ERROR("No binning samples provided.");
    throw MaCh3Exception(__FILE__, __LINE__);
  }
 
  size_t GlobalOffsetCounter = 0;
  for(size_t iSample = 0; iSample < BinningInfo.size(); iSample++){
    BinningInfo[iSample].GlobalOffset = GlobalOffsetCounter;
    GlobalOffsetCounter += BinningInfo[iSample].nBins;
  }
}

str2int()

constexpr unsigned int str2int ( const char *  str, const int  h = 0  )

constexpr

KS: This is mad way of converting string to int. Why? To be able to use string with switch.

Definition at line 36 of file SampleStructs.h.

                                                                 {
// *******************
  return !str[h] ? 5381 : (str2int(str, h+1) * 33) ^ str[h];
}

TargetMat_ToString()

std::string TargetMat_ToString ( const TargetMat  i )

inline

Converted the Target Mat to a string.

Definition at line 59 of file SampleStructs.h.

                                                       {
// *****************
  std::string name;
 
  switch(i) {
    case kTarget_H:
      name = "Hydrogen";
      break;
    case kTarget_C:
      name = "Carbon";
      break;
    case kTarget_N:
      name = "Nitrogen";
      break;
    case kTarget_O:
      name = "Oxygen";
      break;
    case kTarget_Al:
      name = "Aluminium";
      break;
    case kTarget_Ar:
      name = "Argon";
      break;
    case kTarget_Ti:
      name = "Titanium";
      break;
    case kTarget_Fe:
      name = "Iron";
      break;
    case kTarget_Pb:
      name = "Lead";
      break;
    default:
      name = "TargetMat_Undefined";
      break;
  }
 
  return name;
}

TestStatistic_ToString()

std::string TestStatistic_ToString ( const TestStatistic  TestStat )

inline

Convert a LLH type to a string.

Definition at line 123 of file SampleStructs.h.

                                                                      {
// **************************************************
  std::string name = "";
 
  switch(TestStat) {
    case TestStatistic::kPoisson:
    name = "Poisson";
    break;
    case TestStatistic::kBarlowBeeston:
    name = "Barlow-Beeston";
    break;
    case TestStatistic::kIceCube:
    name = "IceCube";
    break;
    case TestStatistic::kPearson:
    name = "Pearson";
    break;
    case TestStatistic::kDembinskiAbdelmotteleb:
    name = "Dembinski-Abdelmotteleb";
    break;
    case TestStatistic::kNTestStatistics:
      MACH3LOG_ERROR("kNTestStatistics is not a valid TestStatistic!");
      throw MaCh3Exception(__FILE__, __LINE__);
    default:
      MACH3LOG_ERROR("UNKNOWN LIKELIHOOD SPECIFIED!");
      MACH3LOG_ERROR("You gave test-statistic {}", static_cast<int>(TestStat));
      throw MaCh3Exception(__FILE__ , __LINE__ );
  }
  return name;
}