Histo Class Reference

#include <CCPCHist.h>

List of all members.

Public Member Functions

 Histo (char *name, char *title, int nx, float xmin, float xmax)
 Histo (char *name, char *title, int nx, float xmin, float xmax, int ny, float ymin, float ymax)
 Histo ()
virtual ~Histo ()
void clear (void)
int put (float *from)
int put (double *from)
int putnents (int ne)
int get (float *to)
int get (double *to)
int geterr (float *to)
int geterr (double *to)
int getnents ()
int fill (float x)
int fill (float x, float weight)
int fill (float x, float y, float weight)

Private Attributes

CCPCHisto * m_h


Detailed Description

Definition at line 23 of file CCPCHist.h.


Constructor & Destructor Documentation

Histo::Histo ( char *  name,
char *  title,
int  nx,
float  xmin,
float  xmax 
)

Constructor for 1-dimensional histogram

Parameters:
name The name of the histogram.
title The title of the histogram
nx The number of bins
xmin The minimum x-value
xmax The maximum x-value

Histo::Histo ( char *  name,
char *  title,
int  nx,
float  xmin,
float  xmax,
int  ny,
float  ymin,
float  ymax 
)

Constructor for 2-dimensional histogram

Parameters:
name The name of the histogram.
title The title of the histogram
nx The number of bins
xmin The minimum x-value
xmax The maximum x-value
ny The number of bins
ymin The minimum y-value
ymax The maximum y-value

Histo::Histo (  ) 

virtual Histo::~Histo (  )  [virtual]


Member Function Documentation

void Histo::clear ( void   ) 

Clears Contents of histogram

int Histo::put ( float *  from  ) 

Loads contents of float array as bin contents into histogram

Parameters:
from Array of floats to be loaded into the histogram contents

int Histo::put ( double *  from  ) 

Loads contents of float array as bin contents into histogram

Parameters:
from Array of doubles to be loaded into the histogram contents

int Histo::putnents ( int  ne  ) 

Loads the Number-of-Entries

Parameters:
ne Integer number of entried to be loaded

int Histo::get ( float *  to  ) 

retrieve the contents of the histogram bins

Parameters:
to Array of floats to receive the histogram contents

int Histo::get ( double *  to  ) 

retrieve the contents of the histogram

Parameters:
to Array of double to receive the histogram contents

int Histo::geterr ( float *  to  ) 

retrieve the bin errors of the histogram

Parameters:
to Array of floats to receive the bin errors of the histogram

int Histo::geterr ( double *  to  ) 

retrieve the bin errors of the histogram

Parameters:
to Array of doubles to receive the bin errors of the histogram

int Histo::getnents (  ) 

returns the number of entries of a histogram

int Histo::fill ( float  x  ) 

Increment the contents of the bin containg the argument by 1

Parameters:
x abszissa value of the bin to be incremented

int Histo::fill ( float  x,
float  weight 
)

Increments the contents of the bin containg the first argument by the weight argument (1-dimensional histograms)
OR
Increments the bin contents of the bin containing the pair (x,weight) of a 2-dimentional histogram by 1

Parameters:
x abszissa value of the bin to be incremented
weight increment of the bin contents (1-dimentional histograms)
OR
ordinate value of the bin to be incremented (2-dimentional histograms)

int Histo::fill ( float  x,
float  y,
float  weight 
)

Increments the contents of the bin containg the first two argument by the weight argument This signature is only valid for 2-dimensional histograms

Parameters:
x abszissa value of the bin to be incremented
y ordinate value of the bin to be incremented
weight increment of the bin contents


Member Data Documentation

CCPCHisto* Histo::m_h [private]

Definition at line 26 of file CCPCHist.h.


The documentation for this class was generated from the following file:
Generated on Fri Mar 23 13:50:04 2007 for CCPCHDoc by  doxygen 1.5.1-p1