KS: Small struct storying info about used binning. More...

#include <Samples/SampleStructs.h>

Collaboration diagram for SampleBinningInfo:

Public Member Functions
int	GetBin (const int xBin, const int yBin) const
	Get linear bin index from 2D bin indices. More...

int	GetBinSafe (const int xBin, const int yBin) const
	Get linear bin index from 2D bin indices with additional checks. More...

int	GetBinGlobal (const int xBin, const int yBin) const
	Calculates the global bin number for a given 2D bin, accounting for multiple binning samples. More...

int	FindXBin (const double XVar, const int NomXBin) const
	DB Find the relevant bin in the PDF for each event. More...

void	InitialiseLookUpSingleDimension (std::vector< BinShiftLookup > &BinLookup, const std::vector< double > &BinEdges, const size_t TotBins)
	Initializes lookup arrays for efficient bin migration in a single dimension. More...

void	InitialiseBinMigrationLookUp ()
	Initialise special lookup arrays allowing to more efficiently perform bin-migration These arrays store the lower and upper edges of each bin and their neighboring bins. More...

Public Attributes
std::vector< double >	XBinEdges
	Vector to hold x-axis bin-edges. More...

std::vector< double >	YBinEdges
	Vector to hold y-axis bin-edges. More...

size_t	nXBins = M3::_BAD_INT_
	Number of X axis bins in the histogram used for likelihood calculation. More...

size_t	nYBins = M3::_BAD_INT_
	Number of Y axis bins in the histogram used for likelihood calculation. More...

size_t	nBins = M3::_BAD_INT_
	Number of total bins. More...

size_t	GlobalOffset = M3::_BAD_INT_
	If you have binning for multiple samples and trying to define 1D vector let's. More...

std::vector< BinShiftLookup >	xBinLookup
	Bin lookups for X axis only. More...

Detailed Description

KS: Small struct storying info about used binning.

Definition at line 183 of file SampleStructs.h.

Member Function Documentation

◆ FindXBin()

int SampleBinningInfo::FindXBin	(	const double	XVar,
		const int	NomXBin
	)		const

inline

DB Find the relevant bin in the PDF for each event.

Definition at line 231 of file SampleStructs.h.

                                                            {
     // KS: Get reference to avoid repeated indexing and help with performance
     const auto& xBin = xBinLookup[NomXBin];
  
     //DB Check to see if momentum shift has moved bins
     //DB - First , check to see if the event is outside of the binning range and skip event if it is
      if (XVar < XBinEdges[0] || XVar >= XBinEdges[nXBins]) {
       return -1;
     }
     //DB - Second, check to see if the event is still in the nominal bin
     else if (XVar < xBin.upper_binedge && XVar >= xBin.lower_binedge) {
       return NomXBin;
     }
     //DB - Thirdly, check the adjacent bins first as Eb+CC+EScale shifts aren't likely to move an Erec more than 1bin width
     //Shifted down one bin from the event bin at nominal
     else if (XVar < xBin.lower_binedge && XVar >= xBin.lower_lower_binedge) {
       return NomXBin-1;
     }
     //Shifted up one bin from the event bin at nominal
     else if (XVar < xBin.upper_upper_binedge && XVar >= xBin.upper_binedge) {
       return NomXBin+1;
     }
     //DB - If we end up in this loop, the event has been shifted outside of its nominal bin, but is still within the allowed binning range
     else {
       // KS: Perform binary search to find correct bin. We already checked if isn't outside of bounds
       return static_cast<int>(std::distance(XBinEdges.begin(), std::upper_bound(XBinEdges.begin(), XBinEdges.end(), XVar)) - 1);
     }
   }

◆ GetBin()

int SampleBinningInfo::GetBin	(	const int	xBin,
		const int	yBin
	)		const

inline

Get linear bin index from 2D bin indices.

Parameters

xBin	The bin index along the X axis (0-based)
yBin	The bin index along the Y axis (0-based)

Returns: The linear bin index corresponding to (xBin, yBin)

Definition at line 205 of file SampleStructs.h.

                                                    {
     return static_cast<int>(yBin * nXBins + xBin);
   }

◆ GetBinGlobal()

int SampleBinningInfo::GetBinGlobal	(	const int	xBin,
		const int	yBin
	)		const

inline

Calculates the global bin number for a given 2D bin, accounting for multiple binning samples.

Parameters

xBin	The bin index along the X axis (0-based)
yBin	The bin index along the Y axis (0-based)

Definition at line 226 of file SampleStructs.h.

                                                          {
     return static_cast<int>(GlobalOffset + GetBin(xBin, yBin));
   }

◆ GetBinSafe()

int SampleBinningInfo::GetBinSafe	(	const int	xBin,
		const int	yBin
	)		const

inline

Get linear bin index from 2D bin indices with additional checks.

Parameters

xBin	The bin index along the X axis (0-based)
yBin	The bin index along the Y axis (0-based)

Returns: The linear bin index corresponding to (xBin, yBin)

Warning: this performs additional checks so do not use in parts of code used during fit

Definition at line 214 of file SampleStructs.h.

                                                        {
     if (xBin < 0 || yBin < 0 || static_cast<size_t>(xBin) >= nXBins || static_cast<size_t>(yBin) >= nYBins) {
       MACH3LOG_ERROR("GetBinSafe: Bin indices out of range: xBin={}, yBin={}, max xBin={}, max yBin={}",
                      xBin, yBin, nXBins - 1, nYBins - 1);
       throw MaCh3Exception(__FILE__, __LINE__);
     }
     return GetBin(xBin, yBin);
   }

◆ InitialiseBinMigrationLookUp()

void SampleBinningInfo::InitialiseBinMigrationLookUp ( )

inline

Initialise special lookup arrays allowing to more efficiently perform bin-migration These arrays store the lower and upper edges of each bin and their neighboring bins.

Todo:: KS: This could be expanded easily for Y axis

Definition at line 294 of file SampleStructs.h.

                                       {
     InitialiseLookUpSingleDimension(xBinLookup, XBinEdges, nXBins);
   }

◆ InitialiseLookUpSingleDimension()

void SampleBinningInfo::InitialiseLookUpSingleDimension	(	std::vector< BinShiftLookup > &	BinLookup,
		const std::vector< double > &	BinEdges,
		const size_t	TotBins
	)

inline

Initializes lookup arrays for efficient bin migration in a single dimension.

Parameters

BinLookup	Reference to the BinShiftLookup struct to be initialized.
BinEdges	Vector of bin edges defining the bin boundaries.
TotBins	Number of bins in the dimension.

Definition at line 264 of file SampleStructs.h.

                                                                                                                                       {
     BinLookup.resize(TotBins);
     //Set rw_pdf_bin and upper_binedge and lower_binedge for each skmc_base
     for(size_t bin_i = 0; bin_i < TotBins; bin_i++){
       double low_lower_edge = M3::_DEFAULT_RETURN_VAL_;
       double low_edge = BinEdges[bin_i];
       double upper_edge = BinEdges[bin_i+1];
       double upper_upper_edge = M3::_DEFAULT_RETURN_VAL_;
  
       if (bin_i == 0) {
         low_lower_edge = BinEdges[0];
       } else {
         low_lower_edge = BinEdges[bin_i-1];
       }
  
       if (bin_i + 2 < TotBins) {
         upper_upper_edge = BinEdges[bin_i + 2];
       } else if (bin_i + 1 < TotBins) {
         upper_upper_edge = BinEdges[bin_i + 1];
       }
  
       BinLookup[bin_i].lower_binedge = low_edge;
       BinLookup[bin_i].upper_binedge = upper_edge;
       BinLookup[bin_i].lower_lower_binedge = low_lower_edge;
       BinLookup[bin_i].upper_upper_binedge = upper_upper_edge;
     }
   }

Member Data Documentation

◆ GlobalOffset

size_t SampleBinningInfo::GlobalOffset = M3::_BAD_INT_

If you have binning for multiple samples and trying to define 1D vector let's.

Definition at line 197 of file SampleStructs.h.

◆ nBins

size_t SampleBinningInfo::nBins = M3::_BAD_INT_

Number of total bins.

Definition at line 195 of file SampleStructs.h.

◆ nXBins

size_t SampleBinningInfo::nXBins = M3::_BAD_INT_

Number of X axis bins in the histogram used for likelihood calculation.

Definition at line 191 of file SampleStructs.h.

◆ nYBins

size_t SampleBinningInfo::nYBins = M3::_BAD_INT_

Number of Y axis bins in the histogram used for likelihood calculation.

Definition at line 193 of file SampleStructs.h.

◆ XBinEdges

std::vector<double> SampleBinningInfo::XBinEdges

Vector to hold x-axis bin-edges.

Definition at line 186 of file SampleStructs.h.

◆ xBinLookup

std::vector<BinShiftLookup> SampleBinningInfo::xBinLookup

Bin lookups for X axis only.

Definition at line 199 of file SampleStructs.h.

◆ YBinEdges

std::vector<double> SampleBinningInfo::YBinEdges

Vector to hold y-axis bin-edges.

Definition at line 188 of file SampleStructs.h.

The documentation for this struct was generated from the following file:

Samples/SampleStructs.h

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ FindXBin()

◆ GetBin()

◆ GetBinGlobal()

◆ GetBinSafe()

◆ InitialiseBinMigrationLookUp()

◆ InitialiseLookUpSingleDimension()

Member Data Documentation

◆ GlobalOffset

◆ nBins

◆ nXBins

◆ nYBins

◆ XBinEdges

◆ xBinLookup

◆ YBinEdges