PSHist::Profile Class Reference
[PSHist package]

Interface for profile histogram class. More...

#include <Profile.h>

List of all members.

Public Member Functions
virtual	~Profile ()
virtual void	fill (double x, double y, double weight=1.0)=0
	Fill histogram.
virtual void	fillN (unsigned n, const double *x, const double *y, const double *weight=0)=0
	Fill histogram with multiple values.
virtual void	reset ()=0
	Reset the accumulated contents of a histogram.
virtual void	print (std::ostream &o) const =0
	Print some basic information about histogram to a stream.

---

Detailed Description

Interface for profile histogram class.

Currently this interface defines only very simple filling operations.

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

See also:

HManager

Version:

Id

Profile.h 2050 2011-06-29 21:30:05Z salnikov@SLAC.STANFORD.EDU

Author:

Mikhail S. Dubrovin

Definition at line 42 of file Profile.h.

---

Constructor & Destructor Documentation

virtual PSHist::Profile::~Profile

(

)

[inline, virtual]

Definition at line 46 of file Profile.h.

---

Member Function Documentation

virtual void PSHist::Profile::fill	(	double	x,
		double	y,
		double	weight = 1.0
	)			[pure virtual]

Fill histogram.

Parameters:

[in]	x	Histogrammed value.
[in]	y	Histogrammed value.
[in]	weight	Weight assigned to this value.

virtual void PSHist::Profile::fillN	(	unsigned	n,
		const double *	x,
		const double *	y,
		const double *	weight = 0
	)			[pure virtual]

Fill histogram with multiple values.

This method is equivalent to calling fill() multiple times but implementation may provide more efficient way if you have many values to fill histogram at once.

Parameters:

[in]	n	Size of the values array.
[in]	x	Histogrammed values array, array size is n.
[in]	y	Histogrammed values array, array size is n.
[in]	weight	Weight assigned to these values, if pointer is zero then weight 1 is assumed for every value.

virtual void PSHist::Profile::print

(

std::ostream &

o

)

const [pure virtual]

Print some basic information about histogram to a stream.

virtual void PSHist::Profile::reset

(

)

[pure virtual]

Reset the accumulated contents of a histogram.

---

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

• PSHist/include/Profile.h

---