RAIDA  1.9.0
IHistogram2D.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_IHISTOGRAM2D_H
8 #define AIDA_IHISTOGRAM2D_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 IHistogram2D : virtual public IHistogram {
29 
30 public:
32  virtual ~IHistogram2D() { /* nop */; }
33 
43  virtual bool fill(double x, double y, double weight = 1.) = 0;
44 
52  virtual double binMeanX(int indexX, int indexY) const = 0;
53 
61  virtual double binMeanY(int indexX, int indexY) const = 0;
62 
70  virtual int binEntries(int indexX, int indexY) const = 0;
71 
79  virtual int binEntriesX(int index) const = 0;
80 
88  virtual int binEntriesY(int index) const = 0;
89 
97  virtual double binHeight(int indexX, int indexY) const = 0;
98 
106  virtual double binHeightX(int index) const = 0;
107 
115  virtual double binHeightY(int index) const = 0;
116 
124  virtual double binError(int indexX, int indexY) const = 0;
125 
131  virtual double meanX() const = 0;
132 
138  virtual double meanY() const = 0;
139 
145  virtual double rmsX() const = 0;
146 
152  virtual double rmsY() const = 0;
153 
159  virtual const IAxis & xAxis() const = 0;
160 
166  virtual const IAxis & yAxis() const = 0;
167 
176  virtual int coordToIndexX(double coord) const = 0;
177 
186  virtual int coordToIndexY(double coord) const = 0;
187 
194  virtual bool add(const IHistogram2D & hist) = 0;
195 }; // class
196 } // namespace AIDA
197 #endif /* ifndef AIDA_IHISTOGRAM2D_H */
virtual bool fill(double x, double y, double weight=1.)=0
Fill the IHistogram2D with a couple of values and the corresponding weight.
virtual ~IHistogram2D()
Destructor.
Definition: IHistogram2D.h:32
virtual double rmsX() const =0
The RMS of the IHistogram2D along the x axis.
virtual int coordToIndexY(double coord) const =0
Get the bin number corresponding to a given coordinate along the y axis.
virtual double rmsY() const =0
The RMS of the IHistogram2D along the y axis.
virtual double binHeight(int indexX, int indexY) const =0
Total height of a give bin (ie the sum of the weights in this bin).
virtual double binError(int indexX, int indexY) const =0
The error of a given bin.
virtual int binEntriesX(int index) const =0
Sum of all the entries of the bins along a given x bin.
virtual double binHeightY(int index) const =0
Sum of all the heights of the bins along a given y bin.
An IAxis represents a binned histogram axis.
Definition: IAxis.h:26
virtual double meanY() const =0
The mean of the IHistogram2D along the y axis.
virtual int binEntries(int indexX, int indexY) const =0
Number of entries in the corresponding bin (ie the number of times fill was called for this bin)...
virtual double binMeanX(int indexX, int indexY) const =0
The weighted mean along the x axis of a given bin.
virtual double meanX() const =0
The mean of the IHistogram2D along the x axis.
User level interface to 2D Histogram.
Definition: IHistogram2D.h:28
virtual bool add(const IHistogram2D &hist)=0
Add to this IHistogram2D the contents of another IHistogram2D.
virtual int coordToIndexX(double coord) const =0
Get the bin number corresponding to a given coordinate along the x axis.
virtual int binEntriesY(int index) const =0
Sum of all the entries of the bins along a given y bin.
virtual const IAxis & yAxis() const =0
Get the y axis of the IHistogram2D.
virtual double binHeightX(int index) const =0
Sum of all the heights of the bins along a given x bin.
virtual double binMeanY(int indexX, int indexY) const =0
The weighted mean along the y axis of a given bin.
virtual const IAxis & xAxis() const =0
Get the x axis of the IHistogram2D.
User level interface to Histogram.
Definition: IHistogram.h:26