Inheritance diagram for tools::histo::b1< TC, TO, TN, TW, TH >:

[legend]

Collaboration diagram for tools::histo::b1< TC, TO, TN, TW, TH >:

Public Types
typedef base_histo< TC, TO, TN, TW, TH >	base_histo_t

typedef parent::axis_t	axis_t

typedef parent::bn_t	bn_t

Public Types inherited from tools::histo::base_histo< TC, TO, TN, TW, TH >
typedef histo_data< TC, TO, TN, TW >	hd_t

typedef axis< TC, TO >	axis_t

typedef axis_t::bn_t	bn_t

typedef unsigned int	dim_t

typedef TC	coordinate_t

typedef TO	offset_t

typedef TN	num_entries_t

typedef TW	weight_t

typedef TH	height_t

typedef std::map< std::string, std::string >	annotations_t

Public Member Functions
virtual TH	bin_error (int) const =0

int	coord_to_index (TC aCoord) const

TC	mean () const

TC	rms () const

TN	bin_entries (int aI) const

TW	bin_Sw (int aI) const

TW	bin_Sw2 (int aI) const

TC	bin_Sxw (int aI) const

TC	bin_Sx2w (int aI) const

TH	bin_height (int aI) const

TC	bin_center (int aI) const

TC	bin_mean (int aI) const

TC	bin_rms (int aI) const

const axis_t &	axis () const

axis_t &	axis ()

void	hprint (std::ostream &a_out)

bool	configure (bn_t aXnumber, TC aXmin, TC aXmax)

bool	configure (const std::vector< TC > &a_edges)

Public Member Functions inherited from tools::histo::base_histo< TC, TO, TN, TW, TH >
const hd_t &	dac () const

bool	equals (const base_histo &a_from, const TW &a_prec, TW(*a_fabs)(TW)) const

const std::string &	title () const

bool	set_title (const std::string &a_title)

dim_t	dimension () const

dim_t	number_of_planes () const

TN	entries () const

TN	all_entries () const

TN	extra_entries () const

TW	equivalent_bin_entries () const

TH	sum_bin_heights () const

TH	sum_all_bin_heights () const

TH	sum_extra_bin_heights () const

TH	min_bin_height () const

TH	max_bin_height () const

bool	min_bin_height_with_entries (TH &a_value) const

bool	max_bin_height_with_entries (TH &a_value) const

bool	has_entries_per_bin () const

bool	get_ith_axis_Sxw (dim_t a_axis, TC &a_value) const

bool	get_ith_axis_Sx2w (dim_t a_axis, TC &a_value) const

TW	get_in_range_Sw () const

TW	get_in_range_Sw2 () const

void	get_Sw_Sw2 (TW &a_sw, TW &a_sw2) const

void	get_all_Sw_Sw2 (TW &a_sw, TW &a_sw2) const

const std::vector< TN > &	bins_entries () const

const std::vector< TW > &	bins_sum_w () const

const std::vector< TW > &	bins_sum_w2 () const

const std::vector< std::vector< TC > > &	bins_sum_xw () const

const std::vector< std::vector< TC > > &	bins_sum_x2w () const

const std::vector< TC > &	in_range_planes_xyw () const

const axis_t &	get_axis (int a_index) const

offset_t	get_bins () const

const std::string &	get_title () const

dim_t	get_dimension () const

bool	is_valid () const

const annotations_t &	annotations () const

annotations_t	annotations ()

void	add_annotation (const std::string &a_key, const std::string &a_value)

bool	annotation (const std::string &a_key, std::string &a_value) const

void	set_annotations (const annotations_t &a_annotations)

void	hprint_annotations (std::ostream &a_out)

Protected Types
enum	{ AxisX =0 }

Protected Types inherited from tools::histo::base_histo< TC, TO, TN, TW, TH >
enum	{ AxisX =0, AxisY =1, AxisZ =2 }

Protected Types inherited from tools::histo::histo_data< TC, TO, TN, TW >
typedef axis< TC, TO >	axis_t

typedef unsigned int	dim_t

typedef std::map< std::string, std::string >	annotations_t

Protected Member Functions
	b1 (const std::string &a_title, bn_t aXnumber, TC aXmin, TC aXmax)

	b1 (const std::string &a_title, const std::vector< TC > &a_edges)

virtual	~b1 ()

	b1 (const b1 &a_from)

b1 &	operator= (const b1 &a_from)

bool	_find_offset (int aI, TO &a_offset) const

Protected Member Functions inherited from tools::histo::base_histo< TC, TO, TN, TW, TH >
virtual TH	get_bin_height (TO) const =0

void	base_from_data (const hd_t &a_from)

hd_t	base_get_data () const

	base_histo ()

virtual	~base_histo ()

	base_histo (const base_histo &a_from)

base_histo &	operator= (const base_histo &a_from)

bool	configure (dim_t a_dim, const std::vector< bn_t > &aNumbers, const std::vector< TC > &aMins, const std::vector< TC > &aMaxs)

bool	configure (dim_t a_dim, const std::vector< std::vector< TC > > &a_edges)

void	base_reset ()

void	base_allocate ()

bool	is_compatible (const base_histo &a_histo)

void	base_add (const base_histo &a_histo)

void	base_subtract (const base_histo &a_histo)

bool	base_multiply (const base_histo &a_histo)

bool	base_divide (const base_histo &a_histo)

bool	base_multiply (TW a_factor)

bool	get_ith_axis_mean (dim_t a_axis, TC &a_value) const

bool	get_ith_axis_rms (dim_t a_axis, TC &a_value) const

TN	get_bin_entries (const std::vector< int > &aIs) const

Protected Member Functions inherited from tools::histo::histo_data< TC, TO, TN, TW >
void	reset_fast_getters ()

	histo_data ()

	histo_data (const histo_data &a_from)

histo_data &	operator= (const histo_data &a_from)

virtual	~histo_data ()

void	update_fast_getters ()

bool	equals (const histo_data &a_from, const TW &a_prec, TW(*a_fabs)(TW)) const

bool	equals_TH (const histo_data &a_from, const TW &a_prec, TW(*a_fabs)(TW), bool a_cmp_bin_Sw2) const

Additional Inherited Members
Protected Attributes inherited from tools::histo::histo_data< TC, TO, TN, TW >
std::string	m_title

dim_t	m_dimension

TO	m_bin_number

std::vector< TN >	m_bin_entries

std::vector< TW >	m_bin_Sw

std::vector< TW >	m_bin_Sw2

std::vector< std::vector< TC > >	m_bin_Sxw

std::vector< std::vector< TC > >	m_bin_Sx2w

std::vector< axis_t >	m_axes

std::vector< TC >	m_in_range_plane_Sxyw

std::map< std::string, std::string >	m_annotations

TN	m_all_entries

TN	m_in_range_entries

TW	m_in_range_Sw

TW	m_in_range_Sw2

std::vector< TC >	m_in_range_Sxw

std::vector< TC >	m_in_range_Sx2w

Detailed Description

template<class TC, class TO, class TN, class TW, class TH>
class tools::histo::b1< TC, TO, TN, TW, TH >

Definition at line 15 of file b1.

Member Typedef Documentation

◆ axis_t

template<class TC , class TO , class TN , class TW , class TH >

typedef parent::axis_t tools::histo::b1< TC, TO, TN, TW, TH >::axis_t

Definition at line 21 of file b1.

◆ base_histo_t

template<class TC , class TO , class TN , class TW , class TH >

typedef base_histo<TC,TO,TN,TW,TH> tools::histo::b1< TC, TO, TN, TW, TH >::base_histo_t

Definition at line 20 of file b1.

◆ bn_t

template<class TC , class TO , class TN , class TW , class TH >

typedef parent::bn_t tools::histo::b1< TC, TO, TN, TW, TH >::bn_t

Definition at line 22 of file b1.

Member Enumeration Documentation

◆ anonymous enum

template<class TC , class TO , class TN , class TW , class TH >

anonymous enum

protected

Enumerator
AxisX

Definition at line 18 of file b1.

18 {AxisX=0};

Constructor & Destructor Documentation

◆ b1() [1/3]

template<class TC , class TO , class TN , class TW , class TH >

tools::histo::b1< TC, TO, TN, TW, TH >::b1	(	const std::string &	a_title,
		bn_t	aXnumber,
		TC	aXmin,
		TC	aXmax
	)

inlineprotected

Definition at line 150 of file b1.

                                                                {
     parent::m_title = a_title;
     std::vector<bn_t> nbins;
     nbins.push_back(aXnumber);
     std::vector<TC> mins;
     mins.push_back(aXmin);
     std::vector<TC> maxs;
     maxs.push_back(aXmax);
     parent::configure(1,nbins,mins,maxs);
   }

◆ b1() [2/3]

template<class TC , class TO , class TN , class TW , class TH >

tools::histo::b1< TC, TO, TN, TW, TH >::b1	(	const std::string &	a_title,
		const std::vector< TC > &	a_edges
	)

inlineprotected

Definition at line 160 of file b1.

                                                             {
     parent::m_title = a_title;
     std::vector< std::vector<TC> > edges(1);
     edges[0] = a_edges;
     parent::configure(1,edges);
   }

◆ ~b1()

template<class TC , class TO , class TN , class TW , class TH >

virtual tools::histo::b1< TC, TO, TN, TW, TH >::~b1 ( )

inlineprotectedvirtual

Definition at line 167 of file b1.

167 {}

◆ b1() [3/3]

template<class TC , class TO , class TN , class TW , class TH >

tools::histo::b1< TC, TO, TN, TW, TH >::b1 ( const b1< TC, TO, TN, TW, TH > & a_from )

inlineprotected

Definition at line 169 of file b1.

169 :parent(a_from){}

Member Function Documentation

◆ _find_offset()

template<class TC , class TO , class TN , class TW , class TH >

bool tools::histo::b1< TC, TO, TN, TW, TH >::_find_offset	(	int	aI,
		TO &	a_offset
	)		const

inlineprotected

Definition at line 191 of file b1.

                                                {
     if(parent::m_dimension!=1) {a_offset=0;return false;}
     bn_t ibin;
     if(!parent::m_axes[0].in_range_to_absolute_index(aI,ibin)) {a_offset=0;return false;}
     a_offset = ibin;
     return true;
   }

◆ axis() [1/2]

template<class TC , class TO , class TN , class TW , class TH >

axis_t& tools::histo::b1< TC, TO, TN, TW, TH >::axis ( )

inline

Definition at line 104 of file b1.

104 {return parent::m_axes[0];} //touchy

◆ axis() [2/2]

template<class TC , class TO , class TN , class TW , class TH >

const axis_t& tools::histo::b1< TC, TO, TN, TW, TH >::axis ( ) const

inline

Definition at line 103 of file b1.

103 {return parent::m_axes[0];}

◆ bin_center()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::bin_center ( int aI ) const

inline

Definition at line 81 of file b1.

81 {return parent::m_axes[0].bin_center(aI);}

◆ bin_entries()

template<class TC , class TO , class TN , class TW , class TH >

TN tools::histo::b1< TC, TO, TN, TW, TH >::bin_entries ( int aI ) const

inline

Definition at line 47 of file b1.

                                {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     return parent::m_bin_entries[offset];
   }

◆ bin_error()

template<class TC , class TO , class TN , class TW , class TH >

virtual TH tools::histo::b1< TC, TO, TN, TW, TH >::bin_error ( int ) const

pure virtual

Implemented in tools::histo::p1< TC, TO, TN, TW, TH, TV >, tools::histo::p1< double, unsigned int, unsigned int, double, double, double >, tools::histo::h1< TC, TO, TN, TW, TH >, tools::histo::h1< double, unsigned int, unsigned int, float, float >, and tools::histo::h1< double, unsigned int, unsigned int, double, double >.

◆ bin_height()

template<class TC , class TO , class TN , class TW , class TH >

TH tools::histo::b1< TC, TO, TN, TW, TH >::bin_height ( int aI ) const

inline

Definition at line 75 of file b1.

                               {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     return this->get_bin_height(offset);
   }

◆ bin_mean()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::bin_mean ( int aI ) const

inline

Definition at line 83 of file b1.

                             {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     TW sw = parent::m_bin_Sw[offset];
     if(sw==0) return 0;
     return parent::m_bin_Sxw[offset][AxisX]/sw;
   }

◆ bin_rms()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::bin_rms ( int aI ) const

inline

Definition at line 91 of file b1.

                            {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     TW sw = parent::m_bin_Sw[offset];
     if(sw==0) return 0;
     TC sxw = parent::m_bin_Sxw[offset][AxisX];
     TC sx2w = parent::m_bin_Sx2w[offset][AxisX];
     TC _mean = sxw/sw;
     return ::sqrt(::fabs((sx2w / sw) - _mean * _mean));
   }

◆ bin_Sw()

template<class TC , class TO , class TN , class TW , class TH >

TW tools::histo::b1< TC, TO, TN, TW, TH >::bin_Sw ( int aI ) const

inline

Definition at line 53 of file b1.

                           {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     return parent::m_bin_Sw[offset];
   }

◆ bin_Sw2()

template<class TC , class TO , class TN , class TW , class TH >

TW tools::histo::b1< TC, TO, TN, TW, TH >::bin_Sw2 ( int aI ) const

inline

Definition at line 59 of file b1.

                            {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     return parent::m_bin_Sw2[offset];
   }

◆ bin_Sx2w()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::bin_Sx2w ( int aI ) const

inline

Definition at line 69 of file b1.

                             {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     return parent::m_bin_Sx2w[offset][AxisX];
   }

◆ bin_Sxw()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::bin_Sxw ( int aI ) const

inline

Definition at line 64 of file b1.

                            {
     TO offset;
     if(!_find_offset(aI,offset)) return 0;
     return parent::m_bin_Sxw[offset][AxisX];
   }

◆ configure() [1/2]

template<class TC , class TO , class TN , class TW , class TH >

bool tools::histo::b1< TC, TO, TN, TW, TH >::configure	(	bn_t	aXnumber,
		TC	aXmin,
		TC	aXmax
	)

inline

Definition at line 176 of file b1.

                                                  {
     std::vector<bn_t> nbins;
     nbins.push_back(aXnumber);
     std::vector<TC> mins;
     mins.push_back(aXmin);
     std::vector<TC> maxs;
     maxs.push_back(aXmax);
     return parent::configure(1,nbins,mins,maxs);
   }

◆ configure() [2/2]

template<class TC , class TO , class TN , class TW , class TH >

bool tools::histo::b1< TC, TO, TN, TW, TH >::configure ( const std::vector< TC > & a_edges )

inline

Definition at line 185 of file b1.

                                                {
     std::vector< std::vector<TC> > edges(1);
     edges[0] = a_edges;
     return parent::configure(1,edges);
   }

◆ coord_to_index()

template<class TC , class TO , class TN , class TW , class TH >

int tools::histo::b1< TC, TO, TN, TW, TH >::coord_to_index ( TC aCoord ) const

inline

Definition at line 27 of file b1.

                                       {
     return axis().coord_to_index(aCoord);
   }

◆ hprint()

template<class TC , class TO , class TN , class TW , class TH >

void tools::histo::b1< TC, TO, TN, TW, TH >::hprint ( std::ostream & a_out )

inline

Definition at line 107 of file b1.

                                  {
     // A la HPRINT.
     a_out << parent::dimension() << parent::title() << std::endl;
     a_out
       << " * ENTRIES = " << parent::all_entries()
       << " * ALL CHANNELS = " << parent::sum_bin_heights()
       << " * UNDERFLOW = " << bin_height(axis_t::UNDERFLOW_BIN)
       << " * OVERFLOW = " << bin_height(axis_t::OVERFLOW_BIN)
       << std::endl;
     a_out
       << " * BIN WID = " << axis().bin_width(0)
       << " * MEAN VALUE = " << mean()
       << " * R . M . S = " << rms()
       << std::endl;
  
     // Some bins :
     bn_t bins = axis().bins();
     a_out
       << " * ENTRIES[0]   = "
       << bin_entries(0)
       << " * HEIGHT[0] = "
       << bin_height(0)
       << " * ERROR[0] = "
       << bin_error(0)
       << std::endl;
     a_out
       << " * ENTRIES[N/2] = "
       << bin_entries(bins/2)
       << " * HEIGHT[N/2] = "
       << bin_height(bins/2)
       << " * ERROR[N/2] = "
       << bin_error(bins/2)
       << std::endl;
     a_out
       << " * ENTRIES[N-1] = "
       << bin_entries(bins-1)
       << " * HEIGHT[N-1] = "
       << bin_height(bins-1)
       << " * ERROR[N-1] = "
       << bin_error(bins-1)
       << std::endl;
   }

◆ mean()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::mean ( ) const

inline

Definition at line 30 of file b1.

                   {
     //TC value;
     //parent::get_ith_axis_mean(AxisX,value); //can return false.
     //return value;
     if(parent::m_in_range_Sw==0) return 0;
     return parent::m_in_range_Sxw[0]/parent::m_in_range_Sw;
   }

◆ operator=()

template<class TC , class TO , class TN , class TW , class TH >

b1& tools::histo::b1< TC, TO, TN, TW, TH >::operator= ( const b1< TC, TO, TN, TW, TH > & a_from )

inlineprotected

Definition at line 170 of file b1.

                                   {
     if(&a_from==this) return *this;
     parent::operator=(a_from);
     return *this;
   }

◆ rms()

template<class TC , class TO , class TN , class TW , class TH >

TC tools::histo::b1< TC, TO, TN, TW, TH >::rms ( ) const

inline

Definition at line 37 of file b1.

                  {
     //TC value;
     //parent::get_ith_axis_rms(AxisX,value); //can return false.
     //return value;
     if(parent::m_in_range_Sw==0) return 0;
     TC _mean = parent::m_in_range_Sxw[0]/parent::m_in_range_Sw;
     return ::sqrt(::fabs((parent::m_in_range_Sx2w[0] / parent::m_in_range_Sw) - _mean * _mean));
   }

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

/Users/barrand/private/dev/softinex/g4tools/g4tools/tools/histo/b1

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class TC, class TO, class TN, class TW, class TH> class tools::histo::b1< TC, TO, TN, TW, TH >

Member Typedef Documentation

◆ axis_t

◆ base_histo_t

◆ bn_t

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ b1() [1/3]

◆ b1() [2/3]

◆ ~b1()

◆ b1() [3/3]

Member Function Documentation

◆ _find_offset()

◆ axis() [1/2]

◆ axis() [2/2]

◆ bin_center()

◆ bin_entries()

◆ bin_error()

◆ bin_height()

◆ bin_mean()

◆ bin_rms()

◆ bin_Sw()

◆ bin_Sw2()

◆ bin_Sx2w()

◆ bin_Sxw()

◆ configure() [1/2]

◆ configure() [2/2]

◆ coord_to_index()

◆ hprint()

◆ mean()

◆ operator=()

◆ rms()

template<class TC, class TO, class TN, class TW, class TH>
class tools::histo::b1< TC, TO, TN, TW, TH >