Gabriele Cosmo
128 lines
4.5 KiB
C++
128 lines
4.5 KiB
C++
//
|
|
// ********************************************************************
|
|
// * DISCLAIMER *
|
|
// * *
|
|
// * The following disclaimer summarizes all the specific disclaimers *
|
|
// * of contributors to this software. The specific disclaimers,which *
|
|
// * govern, are listed with their locations in: *
|
|
// * http://cern.ch/geant4/license *
|
|
// * *
|
|
// * Neither the authors of this software system, nor their employing *
|
|
// * institutes,nor the agencies providing financial support for this *
|
|
// * work make any representation or warranty, express or implied, *
|
|
// * regarding this software system or assume any liability for its *
|
|
// * use. *
|
|
// * *
|
|
// * This code implementation is the intellectual property of the *
|
|
// * GEANT4 collaboration. *
|
|
// * By copying, distributing or modifying the Program (or any work *
|
|
// * based on the Program) you indicate your acceptance of this *
|
|
// * statement, and all its terms. *
|
|
// ********************************************************************
|
|
//
|
|
// -*- 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_IHISTOGRAM_H
|
|
#define AIDA_IHISTOGRAM_H 1
|
|
|
|
// This file is part of the AIDA library
|
|
// Copyright (C) 2002 by the AIDA team. All rights reserved.
|
|
// This library is free software and under the terms of the
|
|
// GNU Library General Public License described in the LGPL.txt
|
|
|
|
#include "AIDA/IBaseHistogram.h"
|
|
|
|
namespace AIDA {
|
|
|
|
/**
|
|
* User level interface to Histogram.
|
|
*
|
|
* @author The AIDA team (http://aida.freehep.org/)
|
|
*
|
|
*/
|
|
|
|
class IHistogram : virtual public IBaseHistogram {
|
|
|
|
public:
|
|
/// Destructor.
|
|
virtual ~IHistogram() { /* nop */; }
|
|
|
|
/**
|
|
* Sum of the entries in all the IHistogram's bins,
|
|
* i.e in-range bins, UNDERFLOW and OVERFLOW.
|
|
* This is equivalent to the number of times the
|
|
* method fill was invoked.
|
|
* @return The sum of all the entries.
|
|
*
|
|
*/
|
|
virtual int allEntries() const = 0;
|
|
|
|
/**
|
|
* Number of entries in the UNDERFLOW and OVERFLOW bins.
|
|
* @return The number of entries outside the range of the IHistogram.
|
|
*
|
|
*/
|
|
virtual int extraEntries() const = 0;
|
|
|
|
/**
|
|
* Number of equivalent entries, i.e. <tt>SUM[ weight ] ^ 2 / SUM[ weight^2 ]</tt>
|
|
* @return The number of equivalent entries.
|
|
*
|
|
*/
|
|
virtual double equivalentBinEntries() const = 0;
|
|
|
|
/**
|
|
* Sum of in-range bin heights in the IHistogram,
|
|
* UNDERFLOW and OVERFLOW bins are excluded.
|
|
* @return The sum of the in-range bins heights.
|
|
*
|
|
*/
|
|
virtual double sumBinHeights() const = 0;
|
|
|
|
/**
|
|
* Sum of the heights of all the IHistogram's bins,
|
|
* i.e in-range bins, UNDERFLOW and OVERFLOW.
|
|
* @return The sum of all the bins heights.
|
|
*
|
|
*/
|
|
virtual double sumAllBinHeights() const = 0;
|
|
|
|
/**
|
|
* Sum of heights in the UNDERFLOW and OVERFLOW bins.
|
|
* @return The sum of the heights of the out-of-range bins.
|
|
*
|
|
*/
|
|
virtual double sumExtraBinHeights() const = 0;
|
|
|
|
/**
|
|
* Minimum height of the in-range bins,
|
|
* i.e. not considering the UNDERFLOW and OVERFLOW bins.
|
|
* @return The minimum height among the in-range bins.
|
|
*
|
|
*/
|
|
virtual double minBinHeight() const = 0;
|
|
|
|
/**
|
|
* Maximum height of the in-range bins,
|
|
* i.e. not considering the UNDERFLOW and OVERFLOW bins.
|
|
* @return The maximum height among the in-range bins.
|
|
*
|
|
*/
|
|
virtual double maxBinHeight() const = 0;
|
|
|
|
/**
|
|
* Scale the weights and the errors of all the IHistogram's bins
|
|
* (in-range and out-of-range ones) by a given scale factor.
|
|
* @param scaleFactor The scale factor.
|
|
* @return false If the scale factor is negative.
|
|
*
|
|
*/
|
|
virtual bool scale(double scaleFactor) = 0;
|
|
}; // class
|
|
}; // namespace AIDA
|
|
#endif /* ifndef AIDA_IHISTOGRAM_H */
|