RAIDA  1.9.0
IProfile2D.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_IPROFILE2D_H
8 #define AIDA_IPROFILE2D_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/IProfile.h"
16 
17 namespace AIDA {
18 
19 class IAxis;
20 
28 class IProfile2D : virtual public IProfile {
29 
30 public:
32  virtual ~IProfile2D() { /* nop */; }
33 
38  virtual bool fill(double x, double y, double z, double weight = 1) = 0;
39 
47  virtual double binMeanX(int indexX, int indexY) const = 0;
48 
56  virtual double binMeanY(int indexX, int indexY) const = 0;
57 
64  virtual int binEntries(int indexX, int indexY) const = 0;
65 
70  virtual int binEntriesX(int indexX) const = 0;
71 
76  virtual int binEntriesY(int indexY) const = 0;
77 
84  virtual double binHeight(int indexX, int indexY) const = 0;
85 
90  virtual double binHeightX(int indexX) const = 0;
91 
96  virtual double binHeightY(int indexY) const = 0;
97 
104  virtual double binError(int indexX, int indexY) const = 0;
105 
112  virtual double binRms(int indexX, int indexY) const = 0;
113 
118  virtual double meanX() const = 0;
119 
124  virtual double meanY() const = 0;
125 
130  virtual double rmsX() const = 0;
131 
136  virtual double rmsY() const = 0;
137 
142  virtual const IAxis & xAxis() const = 0;
143 
148  virtual const IAxis & yAxis() const = 0;
149 
155  virtual int coordToIndexX(double coordX) const = 0;
156 
162  virtual int coordToIndexY(double coordY) const = 0;
163 
171 }; // class
173 } // namespace AIDA
174 #endif /* ifndef AIDA_IPROFILE2D_H */
virtual const IAxis & xAxis() const =0
Return the X axis.
virtual double rmsY() const =0
Returns the rms of the profile as calculated on filling-time projected on the Y axis.
virtual int binEntries(int indexX, int indexY) const =0
The number of entries (ie the number of times fill was called for this bin).
virtual double binMeanY(int indexX, int indexY) const =0
The weighted mean along y of a given bin.
virtual double binHeightX(int indexX) const =0
Equivalent to projectionX().binHeight(indexX).
virtual int coordToIndexY(double coordY) const =0
Convenience method, equivalent to yAxis().coordToIndex(coord).
virtual double binHeightY(int indexY) const =0
Equivalent to projectionY().binHeight(indexY).
virtual double binHeight(int indexX, int indexY) const =0
Total height of the corresponding bin (ie the sum of the weights in this bin).
virtual double binError(int indexX, int indexY) const =0
The error on this bin.
virtual double meanY() const =0
Returns the mean of the profile, as calculated on filling-time projected on the Y axis...
virtual double binMeanX(int indexX, int indexY) const =0
The weighted mean along x of a given bin.
User level interface to a Profile histogram.
Definition: IProfile.h:26
virtual bool fill(double x, double y, double z, double weight=1)=0
Fill the IProfile2D.
virtual double meanX() const =0
Returns the mean of the profile, as calculated on filling-time projected on the X axis...
An IAxis represents a binned histogram axis.
Definition: IAxis.h:26
virtual int coordToIndexX(double coordX) const =0
Convenience method, equivalent to xAxis().coordToIndex(coord).
virtual double binRms(int indexX, int indexY) const =0
The spread (RMS) of this bin.
virtual int binEntriesX(int indexX) const =0
Equivalent to projectionX().binEntries(indexX).
User level interface to a 2-dimensional profile histogram.
Definition: IProfile2D.h:28
virtual int binEntriesY(int indexY) const =0
Equivalent to projectionY().binEntries(indexY).
virtual double rmsX() const =0
Returns the rms of the profile as calculated on filling-time projected on the X axis.
virtual ~IProfile2D()
Destructor.
Definition: IProfile2D.h:32
virtual const IAxis & yAxis() const =0
Return the Y axis.