Gabriele Cosmo
89 lines
3.4 KiB
C++
89 lines
3.4 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_ICLOUD_H
|
|
#define AIDA_ICLOUD_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 a Cloud.
|
|
* A Cloud is an unbinned collection of points. It can be used to
|
|
* represent scatter plots or dynamically rebinnable histograms.
|
|
* If they number of entries in the cloud exceeds some threshold
|
|
* they may be automatically converted to a binned histogram.
|
|
*
|
|
* @author The AIDA team (http://aida.freehep.org/)
|
|
*
|
|
*/
|
|
|
|
class ICloud : virtual public IBaseHistogram {
|
|
|
|
public:
|
|
/// Destructor.
|
|
virtual ~ICloud() { /* nop */; }
|
|
|
|
/**
|
|
* Get the sum of weights of all the entries.
|
|
* @return The sum of the weights of all the entries.
|
|
*
|
|
*/
|
|
virtual double sumOfWeights() const = 0;
|
|
|
|
/**
|
|
* Convert the ICloud to an IHistogram using the default number of bins.
|
|
* @return false If the ICloud has already been converted.
|
|
*
|
|
*/
|
|
virtual bool convertToHistogram() = 0;
|
|
|
|
/**
|
|
* Check if the ICloud has been converted to an IHistogram.
|
|
* @return <code>true</code> if it has been converted.
|
|
*
|
|
*/
|
|
virtual bool isConverted() const = 0;
|
|
|
|
/**
|
|
* Scale the weights by a given factor.
|
|
* @param scaleFactor The scale factor.
|
|
* @return false If a non-positive scale factor is provided.
|
|
*
|
|
*/
|
|
virtual bool scale(double scaleFactor) = 0;
|
|
}; // class
|
|
}; // namespace AIDA
|
|
#endif /* ifndef AIDA_ICLOUD_H */
|