TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom > Class Template Reference

#include <TFCS1DFunctionTemplateHistogram.h>

Inheritance diagram for TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >:

Collaboration diagram for TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >:

Public Types
typedef TFCS1DFunction_size_t	size_t
typedef Trandom	random_type
typedef Txvec	xvec_type
typedef Ty	y_value_type

Public Member Functions
	TFCS1DFunctionTemplateHistogram (TH1 *hist=nullptr, bool doprint=true)
	~TFCS1DFunctionTemplateHistogram ()
std::size_t	MemorySizeArray () const
std::size_t	MemorySize () const
	Gives the total memory size, including the size of additional memory allocated inside the class. More...
void	set_nbins (size_t nbins)
	set number of bins More...
size_t	get_nbins () const
	return number of bins More...
void	Initialize (const TH1 *hist, bool doprint=true)
	Initialize from root histogram. More...
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...
const Txvec &	get_HistoBordersx () const
Txvec &	get_HistoBordersx ()
const TFCS1DFunction_HistogramContent< Ty, Trandom > &	get_HistoContents () const
TFCS1DFunction_HistogramContent< Ty, Trandom > &	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 bool	operator== (const TFCS1DFunction &ref) const
	The == operator compares the content of instances. 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 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...

Protected Attributes
Txvec	m_HistoBorders
TFCS1DFunction_HistogramContent< Ty, Trandom >	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

template<typename Txvec, typename Ty, typename Trandom = float>
class TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >

Definition at line 15 of file TFCS1DFunctionTemplateHistogram.h.

Member Typedef Documentation

random_type

template<typename Txvec , typename Ty , typename Trandom = float>

typedef Trandom TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::random_type

Definition at line 18 of file TFCS1DFunctionTemplateHistogram.h.

size_t

template<typename Txvec , typename Ty , typename Trandom = float>

typedef TFCS1DFunction_size_t TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::size_t

Definition at line 17 of file TFCS1DFunctionTemplateHistogram.h.

xvec_type

template<typename Txvec , typename Ty , typename Trandom = float>

typedef Txvec TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::xvec_type

Definition at line 19 of file TFCS1DFunctionTemplateHistogram.h.

y_value_type

template<typename Txvec , typename Ty , typename Trandom = float>

typedef Ty TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::y_value_type

Definition at line 20 of file TFCS1DFunctionTemplateHistogram.h.

Constructor & Destructor Documentation

TFCS1DFunctionTemplateHistogram()

template<typename Txvec , typename Ty , typename Trandom = float>

TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::TFCS1DFunctionTemplateHistogram ( TH1 *  hist = nullptr, bool  doprint = true  )

inline

Definition at line 22 of file TFCS1DFunctionTemplateHistogram.h.

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

~TFCS1DFunctionTemplateHistogram()

template<typename Txvec , typename Ty , typename Trandom = float>

TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::~TFCS1DFunctionTemplateHistogram ( )

inline

Definition at line 26 of file TFCS1DFunctionTemplateHistogram.h.

{};

Member Function Documentation

ATLAS_NOT_THREAD_SAFE() [1/3]

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/3]

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/3]

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

staticinherited

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]

template<typename Txvec , typename Ty , typename Trandom = float>

Txvec& TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::get_HistoBordersx ( )

inline

Definition at line 131 of file TFCS1DFunctionTemplateHistogram.h.

{ return m_HistoBorders; };

get_HistoBordersx() [2/2]

template<typename Txvec , typename Ty , typename Trandom = float>

const Txvec& TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::get_HistoBordersx ( ) const

inline

Definition at line 130 of file TFCS1DFunctionTemplateHistogram.h.

{ return m_HistoBorders; };

get_HistoContents() [1/2]

template<typename Txvec , typename Ty , typename Trandom = float>

TFCS1DFunction_HistogramContent<Ty, Trandom>& TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::get_HistoContents ( )

inline

Definition at line 137 of file TFCS1DFunctionTemplateHistogram.h.

                                                                           {
    return m_HistoContents;
  };

get_HistoContents() [2/2]

template<typename Txvec , typename Ty , typename Trandom = float>

const TFCS1DFunction_HistogramContent<Ty, Trandom>& TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::get_HistoContents ( ) const

inline

Definition at line 134 of file TFCS1DFunctionTemplateHistogram.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;
}

get_nbins()

template<typename Txvec , typename Ty , typename Trandom = float>

size_t TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::get_nbins ( ) const

inline

return number of bins

Definition at line 40 of file TFCS1DFunctionTemplateHistogram.h.

{ return m_HistoContents.get_nbins(); };

Initialize()

template<typename Txvec , typename Ty , typename Trandom = float>

void TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::Initialize ( const TH1 *  hist, bool  doprint = true  )

inline

Initialize from root histogram.

Depending on the precision of the x- and y-axis, bins are merged if numerical identical

Definition at line 44 of file TFCS1DFunctionTemplateHistogram.h.

                                                        {
    Int_t nbins = hist->GetNbinsX();
 
    std::vector<double> temp_HistoContents;
    int first, last;
    double integral =
        CheckAndIntegrate1DHistogram(hist, temp_HistoContents, first, last);
    if (integral <= 0) {
      set_nbins(0);
    } else {
      set_nbins(nbins);
 
      m_HistoBorders.SetMinMax(hist->GetXaxis()->GetBinLowEdge(first + 1),
                               hist->GetXaxis()->GetBinUpEdge(last + 1));
      Int_t ihist = 0;
      for (Int_t ibin = first; ibin <= last; ++ibin) {
        m_HistoBorders.SetBinLowEdge(ihist,
                                     hist->GetXaxis()->GetBinLowEdge(ibin + 1));
        if (ihist > 0)
          if (m_HistoBorders.GetBinLowEdge(ihist - 1) ==
              m_HistoBorders.GetBinLowEdge(ihist)) {
            if (doprint)
              ATH_MSG_INFO("Skip bin="
                           << ibin + 1
                           << " x=" << hist->GetXaxis()->GetBinLowEdge(ibin + 1)
                           << " fx=" << m_HistoBorders.GetBinLowEdge(ihist));
            --ihist;
            if (doprint)
              ATH_MSG_INFO("     bin="
                           << ibin
                           << " x=" << hist->GetXaxis()->GetBinLowEdge(ibin)
                           << " fx=" << m_HistoBorders.GetBinLowEdge(ihist));
          }
        m_HistoContents.set_fraction(ihist,
                                     temp_HistoContents[ibin] / integral);
        if (ihist > 0)
          if (m_HistoContents.get_fraction(ihist - 1) ==
              m_HistoContents.get_fraction(ihist)) {
            if (doprint)
              ATH_MSG_INFO("Skip fbin="
                           << ihist
                           << " fx=" << m_HistoBorders.GetBinLowEdge(ihist)
                           << " frac=" << m_HistoContents.get_fraction(ihist));
            --ihist;
            if (doprint)
              ATH_MSG_INFO("     fbin="
                           << ihist
                           << " fx=" << m_HistoBorders.GetBinLowEdge(ihist)
                           << " frac=" << m_HistoContents.get_fraction(ihist));
          }
 
        if (doprint)
          ATH_MSG_INFO("bin=" << ibin + 1 << " fbin=" << ihist << "/"
                              << m_HistoBorders.get_nbins() << " x=["
                              << hist->GetXaxis()->GetBinLowEdge(ibin + 1)
                              << "," << hist->GetXaxis()->GetBinUpEdge(ibin + 1)
                              << "] fx=" << m_HistoBorders.GetBinLowEdge(ihist)
                              << " int=" << temp_HistoContents[ibin] / integral
                              << " frac="
                              << m_HistoContents.get_fraction(ihist));
 
        ++ihist;
      }
      if (ihist != nbins) {
        set_nbins(ihist);
        m_HistoBorders.SetMinMax(hist->GetXaxis()->GetBinLowEdge(first + 1),
                                 hist->GetXaxis()->GetBinUpEdge(last + 1));
      }
    }
  }

level()

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

inlineinherited

Retrieve output level.

Definition at line 201 of file MLogging.h.

{ return msg().level(); }

MemorySize()

template<typename Txvec , typename Ty , typename Trandom = float>

std::size_t TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::MemorySize ( ) const

inlinevirtual

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

Reimplemented from TFCSFunction.

Definition at line 31 of file TFCS1DFunctionTemplateHistogram.h.

{ return sizeof(*this) + MemorySizeArray(); };

MemorySizeArray()

template<typename Txvec , typename Ty , typename Trandom = float>

std::size_t TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::MemorySizeArray ( ) const

inline

Definition at line 28 of file TFCS1DFunctionTemplateHistogram.h.

                                    {
    return m_HistoBorders.MemorySizeArray() + m_HistoContents.MemorySizeArray();
  };

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.

{ return 1; };

operator==()

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

inlinevirtualinherited

The == operator compares the content of instances.

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

Reimplemented in TFCS1DFunctionInt32Histogram.

Definition at line 36 of file TFCS1DFunction.h.

                                                           {
    return this == &ref;
  };

rnd_to_fct() [1/4]

template<typename Txvec , typename Ty , typename Trandom = float>

virtual double TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::rnd_to_fct ( double  rnd ) const

inlinevirtual

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

Implements TFCS1DFunction.

Reimplemented in TFCS1DFunctionTemplateInterpolationHistogram< Txvec, Ty, Trandom >, TFCS1DFunctionTemplateInterpolationHistogram< TFCS1DFunction_HistogramInt8BinEdges, uint16_t, float >, TFCS1DFunctionTemplateInterpolationHistogram< TFCS1DFunction_HistogramInt8BinEdges, uint8_t, float >, TFCS1DFunctionTemplateInterpolationHistogram< TFCS1DFunction_HistogramInt16BinEdges, uint16_t, float >, and TFCS1DFunctionTemplateInterpolationHistogram< TFCS1DFunction_HistogramInt16BinEdges, uint32_t, float >.

Definition at line 119 of file TFCS1DFunctionTemplateHistogram.h.

                                              {
    if (m_HistoContents.get_nbins() == 0)
      return 0;
    Trandom residual_rnd;
    size_t ibin = m_HistoContents.get_bin(rnd, residual_rnd);
    // ATH_MSG_INFO( fx="<<m_HistoBorders.GetBinLowEdge(ibin)<<"
    // frac="<<m_HistoContents.get_fraction(ibin)<<"
    // residual_rnd="<<residual_rnd);
    return m_HistoBorders.position(ibin, residual_rnd);
  }

rnd_to_fct() [2/4]

template<typename Txvec , typename Ty , typename Trandom = float>

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 ( 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]);
}

rnd_to_fct() [4/4]

template<typename Txvec , typename Ty , typename Trandom = float>

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]);
}

set_nbins()

template<typename Txvec , typename Ty , typename Trandom = float>

void TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::set_nbins ( size_t  nbins )

inline

set number of bins

Definition at line 34 of file TFCS1DFunctionTemplateHistogram.h.

                               {
    m_HistoBorders.set_nbins(nbins);
    m_HistoContents.set_nbins(nbins);
  };

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

template<typename Txvec , typename Ty , typename Trandom = float>

Txvec TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::m_HistoBorders

protected

Definition at line 142 of file TFCS1DFunctionTemplateHistogram.h.

m_HistoContents

template<typename Txvec , typename Ty , typename Trandom = float>

TFCS1DFunction_HistogramContent<Ty, Trandom> TFCS1DFunctionTemplateHistogram< Txvec, Ty, Trandom >::m_HistoContents

protected

Definition at line 143 of file TFCS1DFunctionTemplateHistogram.h.

m_nm

std::string ISF_FCS::MLogging::m_nm

privateinherited

Message source name.

Definition at line 211 of file MLogging.h.

---

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

• TFCS1DFunctionTemplateHistogram.h