sventon subversion web client - http://www.sventon.org
[show recent changes]
 
  Help
HEAD
Rev: 10093 - svn://svn.freehep.org/svn / freehep / cvs / aidainclude / tags / AIDA-33-BRANCH-pre-merge-1 / AIDA / IProfile.h
Show File - IProfile.h  [show properties]
Search for Help
spinner
// -*- C++ -*-
// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
// =========================================================================
#ifndef AIDA_IPROFILE_H
#define AIDA_IPROFILE_H 1
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/IBaseHistogram.h"
16 
17  namespace AIDA {
18 
19  /**
20   * User level interface to a Profile histogram
21   *
22   * @author The AIDA team (http://aida.freehep.org/)
23   *
24   */
25 
26  class IProfile : virtual public IBaseHistogram {
27 
28  public:
29      /// Destructor.
30      virtual ~IProfile() { /* nop */; }
31 
32      /**
33       * Get the number or all the entries, both in range and
34       * underflow/overflow bins of the IProfile.
35       * @return The sum of all the entries.
36       *
37       */
38      virtual int allEntries() const = 0;
39 
40      /**
41       * Get the number of entries in the underflow and overflow bins.
42       * @return The numer of entries in the out-of-range bins.
43       *
44       */
45      virtual int extraEntries() const = 0;
46 
47      /**
48       * Get the sum of in range bin heights in the IProfile.
49       * @return The sum of all the in-range bins heights.
50       *
51       */
52      virtual double sumBinHeights() const = 0;
53 
54      /**
55       * Get the sum of all the bins heights (including underflow and overflow bin).
56       * @return The sum of all the bins heights.
57       *
58       */
59      virtual double sumAllBinHeights() const = 0;
60 
61      /**
62       * Get the sum of the underflow and overflow bin height.
63       * @return The sum of the out-of-range bins heights.
64       *
65       */
66      virtual double sumExtraBinHeights() const = 0;
67 
68      /**
69       * Get the minimum height of the in-range bins.
70       * @return The minimum height among the in-range bins.
71       *
72       */
73      virtual double minBinHeight() const = 0;
74 
75      /**
76       * Get the maximum height of the in-range bins.
77       * @return The maximum height among the in-range bins.
78       *
79       */
80      virtual double maxBinHeight() const = 0;
81  }; // class
82  } // namespace AIDA
83  #endif /* ifndef AIDA_IPROFILE_H */


feed icon

sventon 2.5.1