RAIDA  1.9.0
IHistogram3D.h
1 // -*- C++ -*-
2 // AID-GENERATED
3 // =========================================================================
4 // This class was generated by AID - Abstract Interface Definition
5 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
6 // =========================================================================
7 #ifndef AIDA_IHISTOGRAM3D_H
8 #define AIDA_IHISTOGRAM3D_H 1
9 
10 // This file is part of the AIDA library
11 // Copyright (C) 2002 by the AIDA team. All rights reserved.
12 // This library is free software and under the terms of the
13 // GNU Library General Public License described in the LGPL.txt
14 
15 #include "AIDA/IHistogram.h"
16 
17 namespace AIDA {
18 
19 class IAxis;
20 
28 class IHistogram3D : virtual public IHistogram {
29 
30 public:
32  virtual ~IHistogram3D() { /* nop */; }
33 
44  virtual bool fill(double x, double y, double z, double weight = 1.) = 0;
45 
54  virtual double binMeanX(int indexX, int indexY, int indexZ) const = 0;
55 
64  virtual double binMeanY(int indexX, int indexY, int indexZ) const = 0;
65 
74  virtual double binMeanZ(int indexX, int indexY, int indexZ) const = 0;
75 
84  virtual int binEntries(int indexX, int indexY, int indexZ) const = 0;
85 
93  virtual int binEntriesX(int index) const = 0;
94 
102  virtual int binEntriesY(int index) const = 0;
103 
111  virtual int binEntriesZ(int index) const = 0;
112 
121  virtual double binHeight(int indexX, int indexY, int indexZ) const = 0;
122 
130  virtual double binHeightX(int index) const = 0;
131 
139  virtual double binHeightY(int index) const = 0;
140 
148  virtual double binHeightZ(int index) const = 0;
149 
158  virtual double binError(int indexX, int indexY, int indexZ) const = 0;
159 
165  virtual double meanX() const = 0;
166 
172  virtual double meanY() const = 0;
173 
179  virtual double meanZ() const = 0;
180 
186  virtual double rmsX() const = 0;
187 
193  virtual double rmsY() const = 0;
194 
200  virtual double rmsZ() const = 0;
201 
207  virtual const IAxis & xAxis() const = 0;
208 
214  virtual const IAxis & yAxis() const = 0;
215 
221  virtual const IAxis & zAxis() const = 0;
222 
231  virtual int coordToIndexX(double coord) const = 0;
232 
241  virtual int coordToIndexY(double coord) const = 0;
242 
251  virtual int coordToIndexZ(double coord) const = 0;
252 
259  virtual bool add(const IHistogram3D & hist) = 0;
260 }; // class
261 } // namespace AIDA
262 #endif /* ifndef AIDA_IHISTOGRAM3D_H */
virtual bool fill(double x, double y, double z, double weight=1.)=0
Fill the IHistogram3D with a triplet of values and the corresponding weight.
virtual int binEntriesY(int index) const =0
Sum of all the entries of the bins along a given y bin.
virtual const IAxis & xAxis() const =0
Get the x axis of the IHistogram3D.
virtual double meanX() const =0
The mean of the IHistogram3D along the x axis.
virtual int binEntries(int indexX, int indexY, int indexZ) const =0
Number of entries in the corresponding bin (ie the number of times fill was called for this bin)...
virtual bool add(const IHistogram3D &hist)=0
Add to this IHistogram3D the contents of another IHistogram3D.
virtual double binHeightX(int index) const =0
Sum of all the heights of the bins along a given x bin.
virtual double binHeightZ(int index) const =0
Sum of all the heights of the bins along a given z bin.
User level interface to 3D Histogram.
Definition: IHistogram3D.h:28
virtual double binMeanX(int indexX, int indexY, int indexZ) const =0
The weighted mean along the x axis of a given bin.
An IAxis represents a binned histogram axis.
Definition: IAxis.h:26
virtual const IAxis & yAxis() const =0
Get the y axis of the IHistogram3D.
virtual double rmsZ() const =0
The RMS of the IHistogram3D along the z axis.
virtual int coordToIndexX(double coord) const =0
Get the bin number corresponding to a given coordinate along the x axis.
virtual double binMeanY(int indexX, int indexY, int indexZ) const =0
The weighted mean the y axis of a given bin.
virtual double binMeanZ(int indexX, int indexY, int indexZ) const =0
The weighted mean the z axis of a given bin.
virtual double meanZ() const =0
The mean of the IHistogram3D along the z axis.
virtual int binEntriesZ(int index) const =0
Sum of all the entries of the bins along a given z bin.
virtual int coordToIndexY(double coord) const =0
Get the bin number corresponding to a given coordinate along the y axis.
virtual int coordToIndexZ(double coord) const =0
Get the bin number corresponding to a given coordinate along the z axis.
virtual double binHeightY(int index) const =0
Sum of all the heights of the bins along a given y bin.
virtual ~IHistogram3D()
Destructor.
Definition: IHistogram3D.h:32
virtual double rmsX() const =0
The RMS of the IHistogram3D along the x axis.
virtual double rmsY() const =0
The RMS of the IHistogram3D along the y axis.
virtual int binEntriesX(int index) const =0
Sum of all the entries of the bins along a given x bin.
virtual const IAxis & zAxis() const =0
Get the z axis of the IHistogram3D.
User level interface to Histogram.
Definition: IHistogram.h:26
virtual double binHeight(int indexX, int indexY, int indexZ) const =0
Total height of a give bin (ie the sum of the weights in this bin).
virtual double binError(int indexX, int indexY, int indexZ) const =0
The error of a given bin.
virtual double meanY() const =0
The mean of the IHistogram3D along the y axis.