Inheritance diagram for tools::histo::c1d:

Collaboration diagram for tools::histo::c1d:

[legend]

Public Member Functions
bool	set_title (const std::string &a_title)

unsigned int	dimension () const

bool	reset ()

unsigned int	entries () const

double	sum_of_weights () const

bool	convert_to_histogram ()

bool	is_converted () const

bool	scale (double a_scale)

bool	set_histogram (h1d *a_histo)

bool	fill (double aX, double aW=1)

double	lower_edge () const

double	upper_edge () const

double	value (unsigned int a_index) const

double	weight (unsigned int a_index) const

double	mean () const

double	rms () const

bool	convert (unsigned int a_bins, double a_lower_edge, double a_upper_edge)

bool	convert (const std::vector< double > &a_edges)

const histo::h1d &	histogram () const

template<class HISTO >
bool	fill_histogram (HISTO &a_histo) const

bool	set_conversion_parameters (unsigned int aCnvXnumber, double aCnvXmin, double aCnvXmax)

	c1d ()

	c1d (const std::string &a_title, int aLimit=base_cloud::UNLIMITED())

virtual	~c1d ()

	c1d (const c1d &a_from)

c1d &	operator= (const c1d &a_from)

double	lowerEdge () const

double	upperEdge () const

template<class HISTO >
bool	fillHistogram (HISTO &a_histo) const

Public Member Functions inherited from tools::histo::base_cloud
	base_cloud (const base_cloud &a_from)

base_cloud &	operator= (const base_cloud &a_from)

const std::string &	title () const

int	max_entries () const

Static Public Member Functions
static const std::string &	s_class ()

Protected Member Functions
void	clear ()

Protected Member Functions inherited from tools::histo::base_cloud
	base_cloud (int aLimit)

virtual	~base_cloud ()

Protected Attributes
std::vector< double >	m_xs

double	m_lower_x

double	m_upper_x

double	m_Sxw

double	m_Sx2w

unsigned int	m_cnv_x_num

double	m_cnv_x_min

double	m_cnv_x_max

histo::h1d *	m_histo

Protected Attributes inherited from tools::histo::base_cloud
std::string	m_title

int	m_limit

double	m_Sw

std::vector< double >	m_ws

Additional Inherited Members
Static Protected Member Functions inherited from tools::histo::base_cloud
static int	UNLIMITED ()

static unsigned int	BINS ()

Detailed Description

Definition at line 16 of file c1d.

Constructor & Destructor Documentation

◆ c1d() [1/3]

tools::histo::c1d::c1d ( )

inline

Definition at line 165 of file c1d.

   :base_cloud(UNLIMITED())
   ,m_lower_x(0),m_upper_x(0)
   ,m_Sxw(0),m_Sx2w(0)
   ,m_cnv_x_num(0),m_cnv_x_min(0),m_cnv_x_max(0),m_histo(0)
   {}

◆ c1d() [2/3]

tools::histo::c1d::c1d	(	const std::string &	a_title,
		int	aLimit = `base_cloud::UNLIMITED()`
	)

inline

Definition at line 172 of file c1d.

   :base_cloud(aLimit)
   ,m_lower_x(0),m_upper_x(0)
   ,m_Sxw(0),m_Sx2w(0)
   ,m_cnv_x_num(0),m_cnv_x_min(0),m_cnv_x_max(0),m_histo(0)
   {
     set_title(a_title);
   }

◆ ~c1d()

virtual tools::histo::c1d::~c1d ( )

inlinevirtual

Definition at line 181 of file c1d.

181 {delete m_histo;}

◆ c1d() [3/3]

tools::histo::c1d::c1d ( const c1d & a_from )

inline

Definition at line 183 of file c1d.

   :base_cloud(a_from)
   ,m_xs(a_from.m_xs)
   ,m_lower_x(a_from.m_lower_x)
   ,m_upper_x(a_from.m_upper_x)
   ,m_Sxw(a_from.m_Sxw)
   ,m_Sx2w(a_from.m_Sx2w)
   ,m_cnv_x_num(a_from.m_cnv_x_num)
   ,m_cnv_x_min(a_from.m_cnv_x_min)
   ,m_cnv_x_max(a_from.m_cnv_x_max)
   ,m_histo(0)
   {
     if(a_from.m_histo) {
       m_histo = new histo::h1d(*a_from.m_histo);
     }
   }

Member Function Documentation

◆ clear()

void tools::histo::c1d::clear ( )

inlineprotected

Definition at line 225 of file c1d.

               {
     m_lower_x = 0;
     m_upper_x = 0;
     m_Sw = 0;
     m_Sxw = 0;
     m_Sx2w = 0;
     m_xs.clear();
     m_ws.clear();
   }

◆ convert() [1/2]

bool tools::histo::c1d::convert ( const std::vector< double > & a_edges )

inline

Definition at line 135 of file c1d.

                                                  {
     if(m_histo) return true;
     m_histo = new histo::h1d(base_cloud::title(),a_edges);
     if(!m_histo) return false;
     bool status = fill_histogram(*m_histo);
     clear();
     return status;
   }

◆ convert() [2/2]

bool tools::histo::c1d::convert	(	unsigned int	a_bins,
		double	a_lower_edge,
		double	a_upper_edge
	)

inline

Definition at line 126 of file c1d.

                                                                            {
     if(m_histo) return true;
     m_histo = new histo::h1d(base_cloud::title(),a_bins,a_lower_edge,a_upper_edge);
     if(!m_histo) return false;
     bool status = fill_histogram(*m_histo);
     clear();
     return status;
   }

◆ convert_to_histogram()

bool tools::histo::c1d::convert_to_histogram ( )

inline

Definition at line 44 of file c1d.

                              {
     if( (m_cnv_x_num<=0) || (m_cnv_x_max<=m_cnv_x_min) ) {
       // Cloud min, max should be included in the histo.
       double dx = 0.01 * (upper_edge() - lower_edge())/BINS();
       return convert(BINS(),lower_edge(),upper_edge() + dx);
     } else {
       return convert(m_cnv_x_num,m_cnv_x_min,m_cnv_x_max);
     }
   }

◆ dimension()

unsigned int tools::histo::c1d::dimension ( ) const

inline

Definition at line 29 of file c1d.

29 {return 1;}

◆ entries()

unsigned int tools::histo::c1d::entries ( ) const

inline

Definition at line 36 of file c1d.

                                {
     return m_histo ? m_histo->all_entries() : (unsigned int)m_ws.size();
   }

◆ fill()

bool tools::histo::c1d::fill	(	double	aX,
		double	aW = `1`
	)

inline

Definition at line 75 of file c1d.

                                     {
     if(!m_histo && (m_limit!=UNLIMITED()) &&
        ((int)m_xs.size()>=m_limit)){
       convert_to_histogram();
     }
  
     if(m_histo) {
       return m_histo->fill(aX,aW);
     } else {
       if(m_xs.size()) {
         m_lower_x = mn<double>(aX,m_lower_x);
         m_upper_x = mx<double>(aX,m_upper_x);
       } else {
         m_lower_x = aX;
         m_upper_x = aX;
       }
       m_xs.push_back(aX);
       m_ws.push_back(aW);
       m_Sw += aW;
       double xw = aX * aW;
       m_Sxw += xw;
       m_Sx2w += aX * xw;
       return true;
     }
   }

◆ fill_histogram()

template<class HISTO >

bool tools::histo::c1d::fill_histogram ( HISTO & a_histo ) const

inline

Definition at line 149 of file c1d.

                                             {
     size_t number = m_xs.size();
     for(size_t index=0;index<number;index++) {
       if(!a_histo.fill(m_xs[index],m_ws[index])) return false;
     }
     return true;
   }

◆ fillHistogram()

template<class HISTO >

bool tools::histo::c1d::fillHistogram ( HISTO & a_histo ) const

inline

Definition at line 223 of file c1d.

223 {return fill_histogram<HISTO>(a_histo);}

◆ histogram()

const histo::h1d& tools::histo::c1d::histogram ( ) const

inline

Definition at line 144 of file c1d.

                                     {
     if(!m_histo) const_cast<c1d&>(*this).convert_to_histogram();
     return *m_histo;
   }

◆ is_converted()

bool tools::histo::c1d::is_converted ( ) const

inline

Definition at line 54 of file c1d.

54 {return m_histo ? true : false;}

◆ lower_edge()

double tools::histo::c1d::lower_edge ( ) const

inline

Definition at line 101 of file c1d.

                             {
     return (m_histo ? m_histo->axis().lower_edge() : m_lower_x);
   }

◆ lowerEdge()

double tools::histo::c1d::lowerEdge ( ) const

inline

Definition at line 220 of file c1d.

220 {return lower_edge();}

◆ mean()

double tools::histo::c1d::mean ( ) const

inline

Definition at line 109 of file c1d.

                       {
     return (m_histo ? m_histo->mean() : (m_Sw?m_Sxw/m_Sw:0));
   }

◆ operator=()

c1d& tools::histo::c1d::operator= ( const c1d & a_from )

inline

Definition at line 200 of file c1d.

                                    {
     base_cloud::operator=(a_from);
     if(&a_from==this) return *this;
     m_xs = a_from.m_xs;
     m_lower_x = a_from.m_lower_x;
     m_upper_x = a_from.m_upper_x;
     m_Sxw = a_from.m_Sxw;
     m_Sx2w = a_from.m_Sx2w;
     m_cnv_x_num = a_from.m_cnv_x_num;
     m_cnv_x_min = a_from.m_cnv_x_min;
     m_cnv_x_max = a_from.m_cnv_x_max;
     delete m_histo;
     m_histo = 0;
     if(a_from.m_histo) {
       m_histo = new histo::h1d(*a_from.m_histo);
     }
     return *this;
   }

◆ reset()

bool tools::histo::c1d::reset ( )

inline

Definition at line 30 of file c1d.

                {
     clear();
     delete m_histo;
     m_histo = 0;
     return true;
   }

◆ rms()

double tools::histo::c1d::rms ( ) const

inline

Definition at line 112 of file c1d.

                      {
     double _rms = 0; //FIXME nan.
     if(m_histo) {
       _rms = m_histo->rms();
     } else {
       if(m_Sw==0) {
       } else {
         double _mean = m_Sxw / m_Sw;
         _rms = ::sqrt(::fabs( (m_Sx2w / m_Sw) - _mean * _mean));
       }
     }
     return _rms;
   }

◆ s_class()

static const std::string& tools::histo::c1d::s_class ( )

inlinestatic

Definition at line 18 of file c1d.

                                     {
     static const std::string s_v("tools::histo::c1d");
     return s_v;
   }

◆ scale()

bool tools::histo::c1d::scale ( double a_scale )

inline

Definition at line 55 of file c1d.

                              {
     if(m_histo) {
       return m_histo->scale(a_scale);
     } else {
       size_t number = m_ws.size();
       for(size_t index=0;index<number;index++) m_ws[index] *= a_scale;
       m_Sw *= a_scale;
       m_Sxw *= a_scale;
       m_Sx2w *= a_scale;
       return true;
     }
   }

◆ set_conversion_parameters()

bool tools::histo::c1d::set_conversion_parameters	(	unsigned int	aCnvXnumber,
		double	aCnvXmin,
		double	aCnvXmax
	)

inline

Definition at line 156 of file c1d.

                                                                  {
     m_cnv_x_num = aCnvXnumber;
     m_cnv_x_min = aCnvXmin;
     m_cnv_x_max = aCnvXmax;
     return true;
   }

◆ set_histogram()

bool tools::histo::c1d::set_histogram ( h1d * a_histo )

inline

Definition at line 68 of file c1d.

                                   { //we take ownership of a_histo.
     reset();
     m_histo = a_histo;
     return true;
   }

◆ set_title()

bool tools::histo::c1d::set_title ( const std::string & a_title )

inline

Definition at line 23 of file c1d.

                                           {
     m_title = a_title;
     if(m_histo) m_histo->set_title(a_title);
     return true;
   }

◆ sum_of_weights()

double tools::histo::c1d::sum_of_weights ( ) const

inline

Definition at line 40 of file c1d.

                                 {
     return (m_histo ? m_histo->sum_bin_heights() : m_Sw);
   }

◆ upper_edge()

double tools::histo::c1d::upper_edge ( ) const

inline

Definition at line 104 of file c1d.

                             {
     return (m_histo ? m_histo->axis().upper_edge() : m_upper_x);
   }

◆ upperEdge()

double tools::histo::c1d::upperEdge ( ) const

inline

Definition at line 221 of file c1d.

221 {return upper_edge();}

◆ value()

double tools::histo::c1d::value ( unsigned int a_index ) const

inline

Definition at line 107 of file c1d.

107 {return (m_histo ?0:m_xs[a_index]);}

◆ weight()

double tools::histo::c1d::weight ( unsigned int a_index ) const

inline

Definition at line 108 of file c1d.

108 {return (m_histo ?0:m_ws[a_index]);}

Member Data Documentation

◆ m_cnv_x_max

double tools::histo::c1d::m_cnv_x_max

protected

Definition at line 244 of file c1d.

◆ m_cnv_x_min

double tools::histo::c1d::m_cnv_x_min

protected

Definition at line 243 of file c1d.

◆ m_cnv_x_num

unsigned int tools::histo::c1d::m_cnv_x_num

protected

Definition at line 242 of file c1d.

◆ m_histo

histo::h1d* tools::histo::c1d::m_histo

protected

Definition at line 245 of file c1d.

◆ m_lower_x

double tools::histo::c1d::m_lower_x

protected

Definition at line 237 of file c1d.

◆ m_Sx2w

double tools::histo::c1d::m_Sx2w

protected

Definition at line 240 of file c1d.

◆ m_Sxw

double tools::histo::c1d::m_Sxw

protected

Definition at line 239 of file c1d.

◆ m_upper_x

double tools::histo::c1d::m_upper_x

protected

Definition at line 238 of file c1d.

◆ m_xs

std::vector<double> tools::histo::c1d::m_xs

protected

Definition at line 236 of file c1d.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ c1d() [1/3]

◆ c1d() [2/3]

◆ ~c1d()

◆ c1d() [3/3]

Member Function Documentation

◆ clear()

◆ convert() [1/2]

◆ convert() [2/2]

◆ convert_to_histogram()

◆ dimension()

◆ entries()

◆ fill()

◆ fill_histogram()

◆ fillHistogram()

◆ histogram()

◆ is_converted()

◆ lower_edge()

◆ lowerEdge()

◆ mean()

◆ operator=()

◆ reset()

◆ rms()

◆ s_class()

◆ scale()

◆ set_conversion_parameters()

◆ set_histogram()

◆ set_title()

◆ sum_of_weights()

◆ upper_edge()

◆ upperEdge()

◆ value()

◆ weight()

Member Data Documentation

◆ m_cnv_x_max

◆ m_cnv_x_min

◆ m_cnv_x_num

◆ m_histo

◆ m_lower_x

◆ m_Sx2w

◆ m_Sxw

◆ m_upper_x

◆ m_xs