#include <TFCS1DFunctionInt32Histogram.h>

Inheritance diagram for TFCS1DFunctionInt32Histogram:

Collaboration diagram for TFCS1DFunctionInt32Histogram:

Public Types
typedef uint32_t	HistoContent_t

Public Member Functions
	TFCS1DFunctionInt32Histogram (const TH1 *hist=nullptr)

	~TFCS1DFunctionInt32Histogram ()

void	Initialize (const TH1 *hist)

virtual double	rnd_to_fct (double rnd) const
	Function gets random number rnd in the range [0,1) as argument and returns function value according to a histogram distribution. More...

virtual bool	operator== (const TFCS1DFunction &ref) const
	The == operator compares the content of instances. More...

const std::vector< float > &	get_HistoBordersx () const

std::vector< float > &	get_HistoBordersx ()

const std::vector< HistoContent_t > &	get_HistoContents () const

std::vector< HistoContent_t > &	get_HistoContents ()

virtual void	rnd_to_fct (float value[], const float rnd[]) const
	Function gets array of random numbers rnd[] in the range [0,1) as arguments and returns function value in array value. More...

virtual double	rnd_to_fct (double rnd) const=0
	Function gets random number rnd in the range [0,1) as argument and returns function value. More...

virtual int	ndim () const
	Return the number of dimensions for the function. More...

virtual void	rnd_to_fct (float value[], const float rnd[]) const
	Function gets array of random numbers rnd[] in the range [0,1) as arguments and returns function value in array value. More...

virtual std::size_t	MemorySize () const
	Gives the total memory size, including the size of additional memory allocated inside the class. More...

bool	msgLvl (const MSG::Level lvl) const
	Check whether the logging system is active at the provided verbosity level. More...

MsgStream &	msg () const
	Return a stream for sending messages directly (no decoration) More...

MsgStream &	msg (const MSG::Level lvl) const
	Return a decorated starting stream for sending messages. More...

MSG::Level	level () const
	Retrieve output level. More...

virtual void	setLevel (MSG::Level lvl)
	Update outputlevel. More...

Static Public Member Functions
static void unit_test	ATLAS_NOT_THREAD_SAFE (TH1 *hist=nullptr)

static double	get_maxdev (TH1 , TH1 )

static double	CheckAndIntegrate1DHistogram (const TH1 *hist, std::vector< double > &integral_vec, int &first, int &last)

static TH1 *generate_histogram_random_slope	ATLAS_NOT_THREAD_SAFE (int nbinsx=50, double xmin=0, double xmax=1, double zerothreshold=0.1)

static TH1 *generate_histogram_random_gauss	ATLAS_NOT_THREAD_SAFE (int nbinsx=50, int ntoy=100000, double xmin=1, double xmax=5, double xpeak=1.5, double sigma=0.6)

static void unit_test	ATLAS_NOT_THREAD_SAFE (TH1 hist, TFCS1DFunction rtof, int nrnd=1000000, TH1 *histfine=nullptr)

static std::string	startMsg (MSG::Level lvl, const std::string &file, int line)
	Make a message to decorate the start of logging. More...

Static Public Attributes
static const HistoContent_t	s_MaxValue = UINT32_MAX

Protected Attributes
std::vector< float >	m_HistoBorders

std::vector< HistoContent_t >	m_HistoContents

Private Attributes
std::string	m_nm
	Message source name. More...

Static Private Attributes
static boost::thread_specific_ptr< MsgStream > m_msg_tls	ATLAS_THREAD_SAFE
	Do not persistify! More...

Detailed Description

Definition at line 15 of file TFCS1DFunctionInt32Histogram.h.

Member Typedef Documentation

◆ HistoContent_t

typedef uint32_t TFCS1DFunctionInt32Histogram::HistoContent_t

Definition at line 27 of file TFCS1DFunctionInt32Histogram.h.

Constructor & Destructor Documentation

◆ TFCS1DFunctionInt32Histogram()

TFCS1DFunctionInt32Histogram::TFCS1DFunctionInt32Histogram ( const TH1 * hist = nullptr )

inline

Definition at line 17 of file TFCS1DFunctionInt32Histogram.h.

                                                           {
     if (hist)
       Initialize(hist);
   };

◆ ~TFCS1DFunctionInt32Histogram()

TFCS1DFunctionInt32Histogram::~TFCS1DFunctionInt32Histogram ( )

inline

Definition at line 21 of file TFCS1DFunctionInt32Histogram.h.

21 {};

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/4]

static TH1* generate_histogram_random_slope TFCS1DFunction::ATLAS_NOT_THREAD_SAFE	(	int	nbinsx = `50`,
		double	xmin = `0`,
		double	xmax = `1`,
		double	zerothreshold = `0.1`
	)

staticinherited

◆ ATLAS_NOT_THREAD_SAFE() [2/4]

static TH1* generate_histogram_random_gauss TFCS1DFunction::ATLAS_NOT_THREAD_SAFE	(	int	nbinsx = `50`,
		int	ntoy = `100000`,
		double	xmin = `1`,
		double	xmax = `5`,
		double	xpeak = `1.5`,
		double	sigma = `0.6`
	)

staticinherited

◆ ATLAS_NOT_THREAD_SAFE() [3/4]

static void unit_test TFCS1DFunction::ATLAS_NOT_THREAD_SAFE	(	TH1 *	hist,
		TFCS1DFunction *	rtof,
		int	nrnd = `1000000`,
		TH1 *	histfine = `nullptr`
	)

staticinherited

◆ ATLAS_NOT_THREAD_SAFE() [4/4]

static void unit_test TFCS1DFunctionInt32Histogram::ATLAS_NOT_THREAD_SAFE ( TH1 * hist = nullptr )

static

◆ CheckAndIntegrate1DHistogram()

double TFCS1DFunction::CheckAndIntegrate1DHistogram	(	const TH1 *	hist,
		std::vector< double > &	integral_vec,
		int &	first,
		int &	last
	)

staticinherited

Definition at line 52 of file TFCS1DFunction.cxx.

                                                                              {
   ISF_FCS::MLogging logger;
   Int_t nbins = hist->GetNbinsX();
  
   float integral = 0;
   integral_vec.resize(nbins);
   for (int ix = 1; ix <= nbins; ix++) {
     float binval = hist->GetBinContent(ix);
     if (binval < 0) {
       // Can't work if a bin is negative, forcing bins to 0 in this case
       double fraction = binval / hist->Integral();
       if (TMath::Abs(fraction) > 1e-5) {
         ATH_MSG_NOCLASS(logger, "Warning: bin content is negative in histogram "
                                     << hist->GetName() << " : "
                                     << hist->GetTitle() << " binval=" << binval
                                     << " " << fraction * 100
                                     << "% of integral=" << hist->Integral()
                                     << ". Forcing bin to 0.");
       }
       binval = 0;
     }
     integral += binval;
     integral_vec[ix - 1] = integral;
   }
  
   for (first = 0; first < nbins; first++)
     if (integral_vec[first] != 0)
       break;
   for (last = nbins - 1; last > 0; last--)
     if (integral_vec[last] != integral)
       break;
   last++;
  
   if (integral <= 0) {
     ATH_MSG_NOCLASS(logger, "Error: histogram "
                                 << hist->GetName() << " : " << hist->GetTitle()
                                 << " integral=" << integral << " is <=0");
   }
   return integral;
 }

◆ get_HistoBordersx() [1/2]

std::vector<float>& TFCS1DFunctionInt32Histogram::get_HistoBordersx ( )

inline

Definition at line 39 of file TFCS1DFunctionInt32Histogram.h.

39 { return m_HistoBorders; };

◆ get_HistoBordersx() [2/2]

const std::vector<float>& TFCS1DFunctionInt32Histogram::get_HistoBordersx ( ) const

inline

Definition at line 36 of file TFCS1DFunctionInt32Histogram.h.

                                                     {
     return m_HistoBorders;
   };

◆ get_HistoContents() [1/2]

std::vector<HistoContent_t>& TFCS1DFunctionInt32Histogram::get_HistoContents ( )

inline

Definition at line 43 of file TFCS1DFunctionInt32Histogram.h.

43 { return m_HistoContents; };

◆ get_HistoContents() [2/2]

const std::vector<HistoContent_t>& TFCS1DFunctionInt32Histogram::get_HistoContents ( ) const

inline

Definition at line 40 of file TFCS1DFunctionInt32Histogram.h.

                                                              {
     return m_HistoContents;
   };

◆ get_maxdev()

double TFCS1DFunction::get_maxdev	(	TH1 *	h_input1,
		TH1 *	h_approx1
	)

staticinherited

Definition at line 21 of file TFCS1DFunction.cxx.

                                                                {
   TH1D *h_input = (TH1D *)h_input1->Clone("h_input");
   TH1D *h_approx = (TH1D *)h_approx1->Clone("h_approx");
  
   double maxdev = 0.0;
  
   // normalize the histos to the same area:
   double integral_input = h_input->Integral();
   double integral_approx = 0.0;
   for (int b = 1; b <= h_input->GetNbinsX(); b++)
     integral_approx +=
         h_approx->GetBinContent(h_approx->FindBin(h_input->GetBinCenter(b)));
   h_approx->Scale(integral_input / integral_approx);
  
   double ymax = h_approx->GetBinContent(h_approx->GetNbinsX()) -
                 h_approx->GetBinContent(h_approx->GetMinimumBin());
   for (int i = 1; i <= h_input->GetNbinsX(); i++) {
     double val = fabs(h_approx->GetBinContent(
                           h_approx->FindBin(h_input->GetBinCenter(i))) -
                       h_input->GetBinContent(i)) /
                  ymax;
     if (val > maxdev)
       maxdev = val;
   }
  
   delete h_input;
   delete h_approx;
  
   return maxdev * 100.0;
 }

◆ Initialize()

void TFCS1DFunctionInt32Histogram::Initialize ( const TH1 * hist )

Definition at line 22 of file TFCS1DFunctionInt32Histogram.cxx.

                                                              {
   Int_t nbinsx = hist->GetNbinsX();
   Int_t nbins = nbinsx;
  
   float integral = 0;
   m_HistoBorders.resize(nbinsx + 1);
   m_HistoContents.resize(nbins);
   std::vector<double> temp_HistoContents(nbins);
   int ibin = 0;
   for (int ix = 1; ix <= nbinsx; ix++) {
     float binval = hist->GetBinContent(ix);
     if (binval < 0) {
       // Can't work if a bin is negative, forcing bins to 0 in this case
       double fraction = binval / hist->Integral();
       if (TMath::Abs(fraction) > 1e-5) {
         ATH_MSG_WARNING("bin content is negative in histogram "
                         << hist->GetName() << " : " << hist->GetTitle()
                         << " binval=" << binval << " " << fraction * 100
                         << "% of integral=" << hist->Integral()
                         << ". Forcing bin to 0.");
       }
       binval = 0;
     }
     integral += binval;
     temp_HistoContents[ibin] = integral;
     ++ibin;
   }
   if (integral <= 0) {
     ATH_MSG_ERROR("histogram " << hist->GetName() << " : " << hist->GetTitle()
                                << " integral=" << integral << " is <=0");
     m_HistoBorders.resize(0);
     m_HistoContents.resize(0);
     return;
   }
  
   for (int ix = 1; ix <= nbinsx; ix++)
     m_HistoBorders[ix - 1] = hist->GetXaxis()->GetBinLowEdge(ix);
   m_HistoBorders[nbinsx] = hist->GetXaxis()->GetXmax();
  
   for (ibin = 0; ibin < nbins; ++ibin) {
     m_HistoContents[ibin] = s_MaxValue * (temp_HistoContents[ibin] / integral);
   }
 }

◆ level()

MSG::Level ISF_FCS::MLogging::level ( ) const

inlineinherited

Retrieve output level.

Definition at line 201 of file MLogging.h.

201 { return msg().level(); }

◆ MemorySize()

virtual std::size_t TFCSFunction::MemorySize ( ) const

inlinevirtualinherited

Gives the total memory size, including the size of additional memory allocated inside the class.

Reimplemented in TFCS2DFunctionTemplateHistogram< Txvec, Tyvec, Tz, Trandom >, and TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >.

Definition at line 19 of file TFCSFunction.h.

19 { return sizeof(*this); };

◆ msg() [1/2]

MsgStream & ISF_FCS::MLogging::msg ( ) const

inlineinherited

Return a stream for sending messages directly (no decoration)

Definition at line 231 of file MLogging.h.

                                       {
   MsgStream *ms = m_msg_tls.get();
   if (!ms) {
     ms = new MsgStream(Athena::getMessageSvc(), m_nm);
     m_msg_tls.reset(ms);
   }
   return *ms;
 }

◆ msg() [2/2]

MsgStream & ISF_FCS::MLogging::msg ( const MSG::Level lvl ) const

inlineinherited

Return a decorated starting stream for sending messages.

Definition at line 240 of file MLogging.h.

                                                         {
   return msg() << lvl;
 }

◆ msgLvl()

bool ISF_FCS::MLogging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Check whether the logging system is active at the provided verbosity level.

Definition at line 222 of file MLogging.h.

                                                      {
   if (msg().level() <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ ndim()

virtual int TFCS1DFunction::ndim ( ) const

inlinevirtualinherited

Return the number of dimensions for the function.

Reimplemented from TFCSFunction.

Definition at line 22 of file TFCS1DFunction.h.

22 { return 1; };

◆ operator==()

bool TFCS1DFunctionInt32Histogram::operator== ( const TFCS1DFunction & ref ) const

virtual

The == operator compares the content of instances.

The implementation in the base class only returns true for a comparison with itself

Reimplemented from TFCS1DFunction.

Definition at line 94 of file TFCS1DFunctionInt32Histogram.cxx.

                                                                              {
   if (IsA() != ref.IsA())
     return false;
   const TFCS1DFunctionInt32Histogram &ref_typed =
       static_cast<const TFCS1DFunctionInt32Histogram &>(ref);
  
   if (m_HistoBorders != ref_typed.m_HistoBorders)
     return false;
   if (m_HistoContents != ref_typed.m_HistoContents)
     return false;
   return true;
 }

◆ rnd_to_fct() [1/4]

double TFCS1DFunctionInt32Histogram::rnd_to_fct ( double rnd ) const

virtual

Function gets random number rnd in the range [0,1) as argument and returns function value according to a histogram distribution.

Implements TFCS1DFunction.

Definition at line 66 of file TFCS1DFunctionInt32Histogram.cxx.

                                                                 {
   if (m_HistoContents.empty()) {
     return 0;
   }
   HistoContent_t int_rnd = s_MaxValue * rnd;
   auto it =
       std::upper_bound(m_HistoContents.begin(), m_HistoContents.end(), int_rnd);
   int ibin = std::distance(m_HistoContents.begin(), it);
   if (ibin >= (int)m_HistoContents.size())
     ibin = m_HistoContents.size() - 1;
   Int_t binx = ibin;
  
   HistoContent_t basecont = 0;
   if (ibin > 0)
     basecont = m_HistoContents[ibin - 1];
  
   HistoContent_t dcont = m_HistoContents[ibin] - basecont;
   if (dcont > 0) {
     return m_HistoBorders[binx] +
            ((m_HistoBorders[binx + 1] - m_HistoBorders[binx]) *
             (int_rnd - basecont)) /
                dcont;
   } else {
     return m_HistoBorders[binx] +
            (m_HistoBorders[binx + 1] - m_HistoBorders[binx]) / 2;
   }
 }

◆ rnd_to_fct() [2/4]

virtual double TFCS1DFunction::rnd_to_fct

Function gets random number rnd in the range [0,1) as argument and returns function value.

◆ rnd_to_fct() [3/4]

void TFCS1DFunction::rnd_to_fct

Function gets array of random numbers rnd[] in the range [0,1) as arguments and returns function value in array value.

For a n-dimensional function, value and rnd should both have n elements.

Definition at line 27 of file TFCS1DFunction.cxx.

                                                                       {
   value[0] = rnd_to_fct(rnd[0]);
 }

◆ rnd_to_fct() [4/4]

void TFCS1DFunction::rnd_to_fct	(	float	value[],
		const float	rnd[]
	)		const

virtualinherited

Function gets array of random numbers rnd[] in the range [0,1) as arguments and returns function value in array value.

For a n-dimensional function, value and rnd should both have n elements.

Implements TFCSFunction.

Definition at line 17 of file TFCS1DFunction.cxx.

                                                                       {
   value[0] = rnd_to_fct(rnd[0]);
 }

◆ setLevel()

void ISF_FCS::MLogging::setLevel ( MSG::Level lvl )

virtualinherited

Update outputlevel.

Definition at line 105 of file MLogging.cxx.

                                     {
   lvl = (lvl >= MSG::NUM_LEVELS) ? MSG::ALWAYS
         : (lvl < MSG::NIL)       ? MSG::NIL
                                  : lvl;
   msg().setLevel(lvl);
 }

◆ startMsg()

std::string ISF_FCS::MLogging::startMsg	(	MSG::Level	lvl,
		const std::string &	file,
		int	line
	)

staticinherited

Make a message to decorate the start of logging.

Print a message for the start of logging.

Definition at line 116 of file MLogging.cxx.

                                                                           {
   int col1_len = 20;
   int col2_len = 5;
   int col3_len = 10;
   auto last_slash = file.find_last_of('/');
   int path_len = last_slash == std::string::npos ? 0 : last_slash;
   int trim_point = path_len;
   int total_len = file.length();
   if (total_len - path_len > col1_len)
     trim_point = total_len - col1_len;
   std::string trimmed_name = file.substr(trim_point);
   const char *LevelNames[MSG::NUM_LEVELS] = {
       "NIL", "VERBOSE", "DEBUG", "INFO", "WARNING", "ERROR", "FATAL", "ALWAYS"};
   std::string level = LevelNames[lvl];
   std::string level_string = std::string("(") + level + ") ";
   std::stringstream output;
   output << std::setw(col1_len) << std::right << trimmed_name << ":"
          << std::setw(col2_len) << std::left << line << std::setw(col3_len)
          << std::right << level_string;
   return output.str();
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

boost::thread_specific_ptr<MsgStream> m_msg_tls ISF_FCS::MLogging::ATLAS_THREAD_SAFE

inlinestaticprivateinherited

Do not persistify!

MsgStream instance (a std::cout like with print-out levels)

Definition at line 215 of file MLogging.h.

◆ m_HistoBorders

std::vector<float> TFCS1DFunctionInt32Histogram::m_HistoBorders

protected

Definition at line 48 of file TFCS1DFunctionInt32Histogram.h.

◆ m_HistoContents

std::vector<HistoContent_t> TFCS1DFunctionInt32Histogram::m_HistoContents

protected

Definition at line 49 of file TFCS1DFunctionInt32Histogram.h.

◆ m_nm

std::string ISF_FCS::MLogging::m_nm

privateinherited

Message source name.

Definition at line 211 of file MLogging.h.

◆ s_MaxValue

const TFCS1DFunctionInt32Histogram::HistoContent_t TFCS1DFunctionInt32Histogram::s_MaxValue = UINT32_MAX

static

Definition at line 28 of file TFCS1DFunctionInt32Histogram.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ HistoContent_t

Constructor & Destructor Documentation

◆ TFCS1DFunctionInt32Histogram()

◆ ~TFCS1DFunctionInt32Histogram()

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/4]

◆ ATLAS_NOT_THREAD_SAFE() [2/4]

◆ ATLAS_NOT_THREAD_SAFE() [3/4]

◆ ATLAS_NOT_THREAD_SAFE() [4/4]

◆ CheckAndIntegrate1DHistogram()

◆ get_HistoBordersx() [1/2]

◆ get_HistoBordersx() [2/2]

◆ get_HistoContents() [1/2]

◆ get_HistoContents() [2/2]

◆ get_maxdev()

◆ Initialize()

◆ level()

◆ MemorySize()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ ndim()

◆ operator==()

◆ rnd_to_fct() [1/4]

◆ rnd_to_fct() [2/4]

◆ rnd_to_fct() [3/4]

◆ rnd_to_fct() [4/4]

◆ setLevel()

◆ startMsg()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_HistoBorders

◆ m_HistoContents

◆ m_nm

◆ s_MaxValue