include/AIDA/IProfile.h

0001 // -*- C++ -*-
0002 // AID-GENERATED
0003 // =========================================================================
0004 // This class was generated by AID - Abstract Interface Definition
0005 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
0006 // =========================================================================
0007 #ifndef AIDA_IPROFILE_H
0008 #define AIDA_IPROFILE_H 1
0009
0010 //  This file is part of the AIDA library
0011 //  Copyright (C) 2002 by the AIDA team.  All rights reserved.
0012 //  This library is free software and under the terms of the
0013 //  GNU Library General Public License described in the LGPL.txt
0014
0015 #include "AIDA/IBaseHistogram.h"
0016
0017 namespace AIDA {
0018
0019 /**
0020  * User level interface to a Profile histogram
0021  *
0022  * @author The AIDA team (http://aida.freehep.org/)
0023  *
0024  */
0025
0026 class IProfile : virtual public IBaseHistogram {
0027
0028 public:
0029     /// Destructor.
0030     virtual ~IProfile() { /* nop */; }
0031
0032     /**
0033      * Get the number or all the entries, both in range and
0034      * underflow/overflow bins of the IProfile.
0035      * @return The sum of all the entries.
0036      *
0037      */
0038     virtual int allEntries() const = 0;
0039
0040     /**
0041      * Get the number of entries in the underflow and overflow bins.
0042      * @return The numer of entries in the out-of-range bins.
0043      *
0044      */
0045     virtual int extraEntries() const = 0;
0046
0047     /**
0048      * Get the sum of in range bin heights in the IProfile.
0049      * @return The sum of all the in-range bins heights.
0050      *
0051      */
0052     virtual double sumBinHeights() const = 0;
0053
0054     /**
0055      * Get the sum of all the bins heights (including underflow and overflow bin).
0056      * @return The sum of all the bins heights.
0057      *
0058      */
0059     virtual double sumAllBinHeights() const = 0;
0060
0061     /**
0062      * Get the sum of the underflow and overflow bin height.
0063      * @return The sum of the out-of-range bins heights.
0064      *
0065      */
0066     virtual double sumExtraBinHeights() const = 0;
0067
0068     /**
0069      * Get the minimum height of the in-range bins.
0070      * @return The minimum height among the in-range bins.
0071      *
0072      */
0073     virtual double minBinHeight() const = 0;
0074
0075     /**
0076      * Get the maximum height of the in-range bins.
0077      * @return The maximum height among the in-range bins.
0078      *
0079      */
0080     virtual double maxBinHeight() const = 0;
0081 }; // class
0082 } // namespace AIDA
0083 #endif /* ifndef AIDA_IPROFILE_H */