SampleStructs.h File Reference

#include <set>
#include <list>
#include <unordered_map>
#include "Manager/MaCh3Exception.h"
#include "Manager/MaCh3Logger.h"
#include "Manager/Core.h"
#include "Parameters/ParameterStructs.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	FunctionalShifter
	Small struct used for applying shifts due to functional params. More...
struct	BinShiftLookup
	KS: Store bin lookups allowing to quickly find bin after migration. More...
struct	BinInfo
	KS: This hold bin extents in N-Dimensions allowing to check if Bin falls into. More...
struct	SampleBinningInfo
	KS: Struct storing all information required for sample binning. More...

Namespaces
	M3
	Main namespace for MaCh3 software.
	M3::Utils
	Utility helpers used across MaCh3.

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
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...
TestStatistic	TestStatFromString (const std::string &likelihood)
	Convert a string to a TestStatistic enum. More...
int	GetSampleFromGlobalBin (const std::vector< SampleBinningInfo > &BinningInfo, const int GlobalBin)
	Get the sample index corresponding to a global bin number. More...
int	GetLocalBinFromGlobalBin (const std::vector< SampleBinningInfo > &BinningInfo, const int GlobalBin)
	Get the local (sample) bin index from a global bin number. More...
double	M3::Utils::GetMassFromPDG (const int PDG)
	Return mass for given PDG. More...
int	M3::Utils::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	M3::Utils::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	Electron neutrino.
kNumu	Muon neutrino.
kNutau	Tau neutrino.
kNueBar	Electron antineutrino.
kNumuBar	Muon antineutrino.
kNutauBar	Tau antineutrino.

Definition at line 94 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 37 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 [27].
kDembinskiAbdelmotteleb	Based on [6].
kNTestStatistics	Number of test statistics.

Definition at line 105 of file SampleStructs.h.

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

Function Documentation

GetLocalBinFromGlobalBin()

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

inline

Get the local (sample) bin index from a global bin number.

Parameters

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

Returns

The bin index within the sample.

Definition at line 720 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 GlobalBin - info.GlobalOffset;
    }
  }
 
  MACH3LOG_ERROR("Couldn't find local bin corresponding to bin {}", GlobalBin);
  throw MaCh3Exception(__FILE__, __LINE__);
 
  return M3::_BAD_INT_;
}

GetSampleFromGlobalBin()

int GetSampleFromGlobalBin ( const std::vector< SampleBinningInfo > &  BinningInfo, const int  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 701 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_;
}

TargetMat_ToString()

std::string TargetMat_ToString ( const TargetMat  i )

inline

Converted the Target Mat to a string.

Definition at line 52 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;
}

TestStatFromString()

TestStatistic TestStatFromString ( const std::string &  likelihood )

inline

Convert a string to a TestStatistic enum.

Definition at line 149 of file SampleStructs.h.

                                                                     {
// **************************************************
  for(int i = 0; i < kNTestStatistics; i++) {
    if(likelihood == TestStatistic_ToString(TestStatistic(i))) {
      return TestStatistic(i);
    }
  }
 
  MACH3LOG_ERROR("Wrong form of test-statistic specified!");
  MACH3LOG_ERROR("You gave {} and I only support:", likelihood);
  for(int i = 0; i < kNTestStatistics; i++)
  {
    MACH3LOG_ERROR("{}", TestStatistic_ToString(TestStatistic(i)));
  }
  throw MaCh3Exception(__FILE__ , __LINE__ );
}

TestStatistic_ToString()

std::string TestStatistic_ToString ( const TestStatistic  TestStat )

inline

Convert a LLH type to a string.

Definition at line 116 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;
}