#include <TFCS1DFunctionTemplateHelpers.h>

Inheritance diagram for TFCS1DFunction_HistogramInt16BinEdges:

Collaboration diagram for TFCS1DFunction_HistogramInt16BinEdges:

Public Types
typedef TFCS1DFunction_size_t	size_t

typedef float	value_type

typedef float	random_type

typedef uint16_t	internal_storage_type

Public Member Functions
	TFCS1DFunction_HistogramInt16BinEdges (size_t nbins=0)

std::size_t	MemorySizeArray () const

std::size_t	MemorySize () const

void	set_nbins (size_t nbins)
	set number of bins More...

size_t	get_nbins () const
	return number of bins More...

void	SetBinLowEdge (size_t pos, const float &value)
	set position of lower edge of bins. More...

const float	GetBinLowEdge (size_t pos) const
	get position of lower edge of bins. More...

const float	GetBinLength (size_t pos) const
	get the length of a bin More...

void	SetMin (const float &value)
	set and get minimum More...

const float &	GetMin () const

void	SetMax (const float &value)
	set and get maximum More...

const float &	GetMax () const

void	SetMinMax (const float &valuemin, const float &valuemax)
	set minimum and maximum More...

const float	Length () const
	Get length of interval of all bins. More...

float	position (size_t pos, const float &drnd) const
	return linear interpolated position for bin pos. More...

float	position_lin (size_t pos, float m, const float &drnd) const
	return interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos. More...

float	position_exp (size_t pos, float beta, const float &drnd) const
	return exponentially interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos. More...

Private Member Functions
size_t	size () const

Private Attributes
TFCS1DFunction_Array< uint16_t >	m_array

float	m_Min

float	m_Max

Detailed Description

Definition at line 516 of file TFCS1DFunctionTemplateHelpers.h.

Member Typedef Documentation

◆ internal_storage_type

typedef uint16_t TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::internal_storage_type

inherited

Definition at line 381 of file TFCS1DFunctionTemplateHelpers.h.

◆ random_type

typedef float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::random_type

inherited

Definition at line 380 of file TFCS1DFunctionTemplateHelpers.h.

◆ size_t

typedef TFCS1DFunction_size_t TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::size_t

inherited

Definition at line 378 of file TFCS1DFunctionTemplateHelpers.h.

◆ value_type

typedef float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::value_type

inherited

Definition at line 379 of file TFCS1DFunctionTemplateHelpers.h.

Constructor & Destructor Documentation

◆ TFCS1DFunction_HistogramInt16BinEdges()

TFCS1DFunction_HistogramInt16BinEdges::TFCS1DFunction_HistogramInt16BinEdges ( size_t nbins = 0 )

inline

Definition at line 519 of file TFCS1DFunctionTemplateHelpers.h.

520 : TFCS1DFunction_HistogramCompactBinEdges<float, uint16_t, float>(

521 nbins){};

Member Function Documentation

◆ get_nbins()

size_t TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::get_nbins

inlineinherited

return number of bins

Definition at line 394 of file TFCS1DFunctionTemplateHelpers.h.

394 { return size() + 1; };

◆ GetBinLength()

const float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::GetBinLength ( size_t pos ) const

inlineinherited

get the length of a bin

Definition at line 424 of file TFCS1DFunctionTemplateHelpers.h.

                                                 {
     return GetBinLowEdge(pos + 1) - GetBinLowEdge(pos);
   };

◆ GetBinLowEdge()

const float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::GetBinLowEdge ( size_t pos ) const

inlineinherited

get position of lower edge of bins.

Requires GetMin() and GetMax() to be set and may not be changed!

Definition at line 413 of file TFCS1DFunctionTemplateHelpers.h.

                                                  {
     if (pos == 0)
       return GetMin();
     if (pos >= get_nbins())
       return GetMax();
     return GetMin() +
            Length() * TFCS1DFunction_Numeric<Tint, T>::ToNormalizedRange(
                           m_array[pos - 1]);
   };

◆ GetMax()

const float & TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::GetMax

inlineinherited

Definition at line 434 of file TFCS1DFunctionTemplateHelpers.h.

434 { return m_Max; };

◆ GetMin()

const float & TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::GetMin

inlineinherited

Definition at line 430 of file TFCS1DFunctionTemplateHelpers.h.

430 { return m_Min; };

◆ Length()

const float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::Length

inlineinherited

Get length of interval of all bins.

Definition at line 443 of file TFCS1DFunctionTemplateHelpers.h.

443 { return GetMax() - GetMin(); };

◆ MemorySize()

std::size_t TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::MemorySize

inlineinherited

Definition at line 388 of file TFCS1DFunctionTemplateHelpers.h.

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

◆ MemorySizeArray()

std::size_t TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::MemorySizeArray

inlineinherited

Definition at line 387 of file TFCS1DFunctionTemplateHelpers.h.

387 { return m_array.MemorySizeArray(); };

◆ position()

float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::position	(	size_t	pos,
		const float &	drnd
	)		const

inlineinherited

return linear interpolated position for bin pos.

Interpolation is done with a random value in the range [0,1]

Definition at line 447 of file TFCS1DFunctionTemplateHelpers.h.

                                                            {
     T pos1 = GetBinLowEdge(pos);
     T pos2 = GetBinLowEdge(pos + 1);
     return (1 - drnd) * pos1 + drnd * pos2;
   };

◆ position_exp()

float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::position_exp	(	size_t	pos,
		float	beta,
		const float &	drnd
	)		const

inlineinherited

return exponentially interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos.

Interpolation is done with a random value in the range [0,1]

(m_array[pos+1] - m_array[pos]);

Definition at line 478 of file TFCS1DFunctionTemplateHelpers.h.

                                                                              {
     Trandom z = drnd; 
     T pos1 = GetBinLowEdge(pos);
     T pos2 = GetBinLowEdge(pos + 1);
     if (fabs(beta) < 1.0e-8)
       return (1 - z) * pos1 + z * pos2;
     else {
       T deltax = m_array[pos + 1] - m_array[pos];
       if (deltax == 0)
         return m_array[pos];
       else {
         z = 1 / beta * log(1.0 + drnd * (exp(beta * deltax) - 1.0)) / deltax;
       }
     }
  
     return (1 - z) * pos1 + z * pos2;
   };

◆ position_lin()

float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::position_lin	(	size_t	pos,
		float	m,
		const float &	drnd
	)		const

inlineinherited

return interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos.

Interpolation is done with a random value in the range [0,1] return linearly interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos. Interpolation is done with a random value in the range [0,1]

Definition at line 460 of file TFCS1DFunctionTemplateHelpers.h.

                                                                           {
     if (m > 2)
       m = 2;
     if (m < -2)
       m = -2;
     Trandom x =
         fabs(m) > 0.001
             ? (0.5 * std::sqrt(m * (m + 8 * drnd - 4) + 4) - 1) / m + 0.5
             : drnd;
     T pos1 = GetBinLowEdge(pos);
     T pos2 = GetBinLowEdge(pos + 1);
     return (1 - x) * pos1 + x * pos2;
   };

◆ set_nbins()

void TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::set_nbins ( size_t nbins )

inlineinherited

set number of bins

Definition at line 391 of file TFCS1DFunctionTemplateHelpers.h.

391 { m_array.resize(nbins >= 1 ? nbins - 1 : 0); };

◆ SetBinLowEdge()

void TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::SetBinLowEdge	(	size_t	pos,
		const float &	value
	)

inlineinherited

set position of lower edge of bins.

Requires GetMin() and GetMax() to be set and may not be changed!

Definition at line 398 of file TFCS1DFunctionTemplateHelpers.h.

                                                  {
     if (pos == 0) {
       SetMin(value);
       return;
     }
     if (pos >= get_nbins()) {
       SetMax(value);
       return;
     }
     m_array[pos - 1] = TFCS1DFunction_Numeric<Tint, T>::ExpandToMaxRange(
         (value - GetMin()) / Length());
   };

◆ SetMax()

void TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::SetMax ( const float & value )

inlineinherited

set and get maximum

Definition at line 433 of file TFCS1DFunctionTemplateHelpers.h.

433 { m_Max = value; };

◆ SetMin()

void TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::SetMin ( const float & value )

inlineinherited

set and get minimum

Definition at line 429 of file TFCS1DFunctionTemplateHelpers.h.

429 { m_Min = value; };

◆ SetMinMax()

void TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::SetMinMax	(	const float &	valuemin,
		const float &	valuemax
	)

inlineinherited

set minimum and maximum

Definition at line 437 of file TFCS1DFunctionTemplateHelpers.h.

                                                        {
     SetMin(valuemin);
     SetMax(valuemax);
   };

◆ size()

size_t TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::size

inlineprivateinherited

Definition at line 498 of file TFCS1DFunctionTemplateHelpers.h.

498 { return m_array.size(); };

Member Data Documentation

◆ m_array

TFCS1DFunction_Array<uint16_t > TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::m_array

privateinherited

Definition at line 497 of file TFCS1DFunctionTemplateHelpers.h.

◆ m_Max

float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::m_Max

privateinherited

Definition at line 500 of file TFCS1DFunctionTemplateHelpers.h.

◆ m_Min

float TFCS1DFunction_HistogramCompactBinEdges< float , uint16_t , float >::m_Min

privateinherited

Definition at line 499 of file TFCS1DFunctionTemplateHelpers.h.

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

TFCS1DFunctionTemplateHelpers.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ internal_storage_type

◆ random_type

◆ size_t

◆ value_type

Constructor & Destructor Documentation

◆ TFCS1DFunction_HistogramInt16BinEdges()

Member Function Documentation

◆ get_nbins()

◆ GetBinLength()

◆ GetBinLowEdge()

◆ GetMax()

◆ GetMin()

◆ Length()

◆ MemorySize()

◆ MemorySizeArray()

◆ position()

◆ position_exp()

◆ position_lin()

◆ set_nbins()

◆ SetBinLowEdge()

◆ SetMax()

◆ SetMin()

◆ SetMinMax()

◆ size()

Member Data Documentation

◆ m_array

◆ m_Max

◆ m_Min