RAIDA  1.9.0
IProfile1D.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_IPROFILE1D_H
8 #define AIDA_IPROFILE1D_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 IProfile1D : virtual public IProfile {
29 
30 public:
32  virtual ~IProfile1D() { /* nop */; }
33 
38  virtual bool fill(double x, double y, double weight = 1) = 0;
39 
46  virtual double binMean(int index) const = 0;
47 
52  virtual int binEntries(int index) const = 0;
53 
58  virtual double binHeight(int index) const = 0;
59 
64  virtual double binError(int index) const = 0;
65 
71  virtual double binRms(int index) const = 0;
72 
76  virtual double mean() const = 0;
77 
81  virtual double rms() const = 0;
82 
86  virtual const IAxis & axis() const = 0;
87 
92  virtual int coordToIndex(double coord) const = 0;
93 
100 }; // class
102 } // namespace AIDA
103 #endif /* ifndef AIDA_IPROFILE1D_H */
virtual double binMean(int index) const =0
The weighted mean of the corresponding bin.
User level interface to a 1-dimensional profile histogram.
Definition: IProfile1D.h:28
virtual double binHeight(int index) const =0
Total height of the corresponding bin (ie the sum of the weights in this bin).
virtual int binEntries(int index) const =0
Number of entries in the corresponding bin (ie the number of times fill was called for this bin)...
User level interface to a Profile histogram.
Definition: IProfile.h:26
virtual double rms() const =0
Returns the rms of the whole profile as calculated on filling-time.
An IAxis represents a binned histogram axis.
Definition: IAxis.h:26
virtual double mean() const =0
Returns the mean of the whole profile as calculated on filling-time.
virtual double binError(int index) const =0
The error on this bin.
virtual int coordToIndex(double coord) const =0
Convenience method, equivalent to axis().coordToIndex(coord).
virtual double binRms(int index) const =0
The spread (RMS) of a bin.
virtual ~IProfile1D()
Destructor.
Definition: IProfile1D.h:32
virtual const IAxis & axis() const =0
Returns the X axis.
virtual bool fill(double x, double y, double weight=1)=0
Fill the IProfile1D.