F:/myCMT/Online/CCPCHist/CCPCHist/CCPCHist.h File Reference

#include "hist_types.h"

Go to the source code of this file.

Classes
class	HSys
class	Histo
class	PHisto
Defines
#define	H_IllegalID   1
Functions
void *	hccpc_init (char *name)
void *	hccpc_book1 (char *name, char *title, int nx, float xmin, float xmax)
void *	hccpc_profile (char *name, char *title, int nx, float xmin, float xmax)
void *	hccpc_book2 (char *name, char *title, int nx, float xmin, float xmax, int ny, float ymin, float ymax)
int	hfill1 (void *id, float x, float weight)
int	hfill2 (void *id, float x, float y, float weight)
int	hfillp (void *id, float x, float y)
int	hputf (void *id, float *buf)
int	hputd (void *id, double *buf)

---

Define Documentation

#define H_IllegalID   1

Definition at line 4 of file CCPCHist.h.

---

Function Documentation

void* hccpc_book1	(	char *	name,
		char *	title,
		int	nx,
		float	xmin,
		float	xmax
	)

Booking (creating) a 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

Returns:

pointer to the created instance of the histogram. The returned pointer has to be used in subsequent calls, such a the filling routines.

void* hccpc_book2	(	char *	name,
		char *	title,
		int	nx,
		float	xmin,
		float	xmax,
		int	ny,
		float	ymin,
		float	ymax
	)

Booking (creating) a 2-dimensional histogram.

Parameters:

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

Returns:

pointer to the created instance of the histogram. The returned pointer has to be used in subsequent calls, such a the filling routines.

void* hccpc_init

(

char *

name

)

Initializes the histogramming package.

Parameters:

name

Name of the Histogramming system used in the creation of the DIM services.

Returns:

pointer to the instance of the HSys object

void* hccpc_profile	(	char *	name,
		char *	title,
		int	nx,
		float	xmin,
		float	xmax
	)

Booking (creating) a profile histogram.

Parameters:

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

Returns:

pointer to the created instance of the histogram. The returned pointer has to be used in subsequent calls, such a the filling routines.

int hfill1	(	void *	id,
		float	x,
		float	weight
	)

Fills a 1-dimensional histogram.

Parameters:

	id	Pointer to the histogram as returned from the booking routine
	x	abszissa of the bin
	weight	weight to be added to bin contents

int hfill2	(	void *	id,
		float	x,
		float	y,
		float	weight
	)

Fills a 2-dimensional histogram.

Parameters:

	id	Pointer to the histogram as returned from the booking routine
	x	abszissa of the bin
	y	ordinate of the bin
	weight	weight to be added to bin contents

int hfillp	(	void *	id,
		float	x,
		float	y
	)

Fills a profile histogram.

Parameters:

	id	Pointer to the histogram as returned from the booking routine
	x	abszissa of the bin
	y	y-value to be added to bin statistics

int hputd	(	void *	id,
		double *	buf
	)

Load the bin contents of a histogram from a double array

Parameters:

	id	Pointer to the histogram as returned from the booking routine
	buf	array of doubles to containig the values to be loaded into the bin contents of the histogram. The array should be dimensioned at least to nx+2 for 1-dimensional histograms and (nx+2)*(ny+2) for 2-dimensional histograms

int hputf	(	void *	id,
		float *	buf
	)

Load the bin contents of a histogram from a float array

Parameters:

	id	Pointer to the histogram as returned from the booking routine
	buf	array of floats to containig the values to be loaded into the bin contents of the histogram. The array should be dimensioned at least to nx+2 for 1-dimensional histograms and (nx+2)*(ny+2) for 2-dimensional histograms

---