RAIDA  1.9.0
ICloud3D.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_ICLOUD3D_H
8 #define AIDA_ICLOUD3D_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 <vector>
16 
17 #include "AIDA/ICloud.h"
18 
19 namespace AIDA {
20 
21 class IHistogram3D;
22 
30 class ICloud3D : virtual public ICloud {
31 
32 public:
34  virtual ~ICloud3D() { /* nop */; }
35 
46  virtual bool fill(double x, double y, double z, double weight = 1.) = 0;
47 
53  virtual double lowerEdgeX() const = 0;
54 
60  virtual double lowerEdgeY() const = 0;
61 
67  virtual double lowerEdgeZ() const = 0;
68 
74  virtual double upperEdgeX() const = 0;
75 
81  virtual double upperEdgeY() const = 0;
82 
88  virtual double upperEdgeZ() const = 0;
89 
107  virtual double valueX(int index) const = 0;
108 
126  virtual double valueY(int index) const = 0;
127 
145  virtual double valueZ(int index) const = 0;
146 
164  virtual double weight(int index) const = 0;
165 
171  virtual double meanX() const = 0;
172 
178  virtual double meanY() const = 0;
179 
185  virtual double meanZ() const = 0;
186 
192  virtual double rmsX() const = 0;
193 
199  virtual double rmsY() const = 0;
200 
206  virtual double rmsZ() const = 0;
207 
223  virtual bool convert(int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ) = 0;
224 
234 
242  virtual const IHistogram3D & histogram() const = 0;
243 
250  virtual bool fillHistogram(IHistogram3D & hist) const = 0;
251 }; // class
252 } // namespace AIDA
253 #endif /* ifndef AIDA_ICLOUD3D_H */
virtual double meanY() const =0
Get the mean of the ICloud3D along the y axis.
virtual double upperEdgeZ() const =0
Get the upper edge of the ICloud3D along the z axis.
virtual double meanX() const =0
Get the mean of the ICloud3D along the x axis.
virtual double upperEdgeY() const =0
Get the upper edge of the ICloud3D along the y axis.
virtual double weight(int index) const =0
Get the weight corresponding to a given entry.
User level interface to 3D Histogram.
Definition: IHistogram3D.h:28
virtual double valueX(int index) const =0
Get the x value corresponding to a given entry.
User level interface to a Cloud.
Definition: ICloud.h:30
virtual bool convert(int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)=0
Convert internally the ICloud3D to an IHistogram3D with given number of bins, upper edge and lower ed...
virtual double rmsZ() const =0
Get the RMS of the ICloud3D along the z axis.
virtual double upperEdgeX() const =0
Get the upper edge of the ICloud3D along the x axis.
virtual double valueZ(int index) const =0
Get the z value corresponding to a given entry.
virtual bool fillHistogram(IHistogram3D &hist) const =0
Project the ICloud3D on an IHistogram3D.
virtual double valueY(int index) const =0
Get the y value corresponding to a given entry.
virtual double lowerEdgeX() const =0
Get the lower edge of the ICloud3D along the x axis.
virtual double rmsY() const =0
Get the RMS of the ICloud3D along the y axis.
virtual bool fill(double x, double y, double z, double weight=1.)=0
Fill the ICloud3D with a triplet of values and a corresponding weight.
virtual double lowerEdgeZ() const =0
Get the lower edge of the ICloud3D along the z axis.
virtual double lowerEdgeY() const =0
Get the lower edge of the ICloud3D along the y axis.
virtual double rmsX() const =0
Get the RMS of the ICloud3D along the x axis.
virtual const IHistogram3D & histogram() const =0
Convert internally the ICloud3D to an IHistogram3D with given bin edges.
virtual double meanZ() const =0
Get the mean of the ICloud3D along the z axis.
virtual ~ICloud3D()
Destructor.
Definition: ICloud3D.h:34
User level interface to a 3D Cloud.
Definition: ICloud3D.h:30