Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::AIDA_HBook::AIDADynHist1D Class Reference

#include <AIDADynHist1D.h>

List of all members.

Public Methods

 AIDADynHist1D (const char *name="", const int &nBinsX=100, IAnnotation *ann=0, IHistogramFactory *f=0)
virtual ~AIDADynHist1D (void)
virtual AIDA_STD::string title (void) const
 Get title (temporary, to be superseded by annotation).

virtual void setTitle (const AIDA_STD::string &newTitle)
 Set title (temporary, to be superseded by annotation).

IAnnotation * annotation (void)
 Annotation of the histogram.

virtual int dimensions (void) const
 Number of dimensions (1 for 1D histogram, 2 for 2D histogram, etc.).

virtual int entries (void) const
 Number of in-range entries in the whole histogram.

virtual int allEntries (void) const
virtual int extraEntries (void) const
 Number of extra entries in the whole histogram.

virtual double equivalentBinEntries (void) const
 Number of equivalent entries SUM[ weight ] ^ 2 / SUM[ weight^2 ].

virtual double sumBinHeights (void) const
 Sum of in-range bin heights in the whole histogram.

virtual double sumAllBinHeights (void) const
 Sum of all (both in-range and extra) bin heights in the whole histogram.

virtual double sumExtraBinHeights (void) const
 Sum of extra bin heights in the whole histogram.

virtual int binEntries (int index) const
 Number of entries in a specific in-range bin (number of fills).

virtual double binHeight (int index) const
 Height of a specific in-range bin (height respects weights of entries).

virtual double binError (int index) const
 Bin contents error.

virtual double mean (void) const
virtual double rms (void) const
virtual double minBinHeight (void) const
 Min height of in-range bins in the whole histogram.

virtual int minBin (void) const
 Index of the in-range bin containing the minBinHeight().

virtual double maxBinHeight (void) const
 Max height of in-range bins in the whole histogram.

virtual int maxBin (void) const
 Index of the in-range bin containing the maxBinHeight().

virtual IAxis * xAxis (void) const
 Get the X axis.

virtual int coordToIndex (double coord) const
 Equivalent to xAxis().coordToIndex(coord);.

virtual void reset (void)
 Reset contents.

virtual void fill (double x, double weight=1.0)
virtual AIDA_STD::ostream & print (AIDA_STD::ostream &s) const
 Print (ASCII) the histogram into the output stream.

virtual AIDA_STD::ostream & write (AIDA_STD::ostream &s) const
 Write (ASCII) the histogram table into the output stream.

virtual int write (const char *filename) const
 Write (ASCII) the histogram table into a file.

virtual const CHBookHisto * representation (void) const
virtual int cacheSize (void) const
virtual bool setCacheSize (int)

Private Types

typedef AIDA_STD::vector<
double > 
UwCache
typedef AIDA_STD::vector<
AIDA_STD::pair< double, double > > 
WCache
typedef UwCache::const_iterator UwcIt
typedef WCache::const_iterator WcIt

Private Methods

virtual int checkIndex (int index) const
bool sync (void) const
void freeze (void) const
AIDA_STD::pair< double, double > chooseLimits (void) const
void notYetMessage (const AIDA_STD::string &) const
void frozenMessage (void) const
int myID (void) const
int getIntFromString (const AIDA_STD::string &str) const

Private Attributes

CHBookHisto * histo
AIDAAxisaxis
IAnnotation * ann
int maxCacheSize
int nbins
AIDA_STD::string name
IHistogramFactory * factory
UwCache unweightedCache
WCache weightedCache
UwcIt uwcIt
WcIt wcIt
bool frozen
bool synchronised
bool needsRebook
double loVal
double hiVal

Static Private Attributes

const int DEFAULT_MAX_CACHE_SIZE = 100000
const int CACHE_SAFETY_LIMIT = 10000000
const double BIG_DOUBLE = 1e30


Member Typedef Documentation

typedef AIDA_STD::vector<double> Anaphe::AIDA_HBook::AIDADynHist1D::UwCache [private]
 

Definition at line 100 of file AIDADynHist1D.h.

typedef UwCache::const_iterator Anaphe::AIDA_HBook::AIDADynHist1D::UwcIt [private]
 

Definition at line 102 of file AIDADynHist1D.h.

Referenced by sync().

typedef AIDA_STD::vector<AIDA_STD::pair<double,double> > Anaphe::AIDA_HBook::AIDADynHist1D::WCache [private]
 

Definition at line 101 of file AIDADynHist1D.h.

typedef WCache::const_iterator Anaphe::AIDA_HBook::AIDADynHist1D::WcIt [private]
 

Definition at line 103 of file AIDADynHist1D.h.

Referenced by sync().


Constructor & Destructor Documentation

AIDADynHist1D::AIDADynHist1D const char *    name = "",
const int &    nBinsX = 100,
IAnnotation *    ann = 0,
IHistogramFactory *    f = 0
 

Definition at line 49 of file AIDADynHist1D.cpp.

References ann, and reset().

AIDADynHist1D::~AIDADynHist1D void    [virtual]
 

Definition at line 74 of file AIDADynHist1D.cpp.

References ann, axis, and histo.


Member Function Documentation

int AIDADynHist1D::allEntries void    const [virtual]
 

Number of all entries in all (both in-range and extra) bins in the whole histogram

Definition at line 159 of file AIDADynHist1D.cpp.

References histo, unweightedCache, and weightedCache.

Referenced by entries().

IAnnotation * AIDADynHist1D::annotation void   
 

Definition at line 113 of file AIDADynHist1D.cpp.

References ann.

int AIDADynHist1D::binEntries int    index const [virtual]
 

Definition at line 218 of file AIDADynHist1D.cpp.

References binHeight().

double AIDADynHist1D::binError int    index const [virtual]
 

Definition at line 240 of file AIDADynHist1D.cpp.

References histo, and sync().

double AIDADynHist1D::binHeight int    index const [virtual]
 

Definition at line 227 of file AIDADynHist1D.cpp.

References histo, and sync().

Referenced by binEntries().

int AIDADynHist1D::cacheSize void    const [virtual]
 

Definition at line 439 of file AIDADynHist1D.cpp.

References maxCacheSize.

int AIDADynHist1D::checkIndex int    index const [private, virtual]
 

Checks validity of the index, assuming bin indices from "0" to "number of bins - 1"

Definition at line 369 of file AIDADynHist1D.cpp.

References axis, Anaphe::AIDA_HBook::AIDAAxis::checkIndex(), and sync().

AIDA_STD::pair< double, double > AIDADynHist1D::chooseLimits void    const [private]
 

Definition at line 477 of file AIDADynHist1D.cpp.

References BIG_DOUBLE, hiVal, and loVal.

Referenced by sync().

int AIDADynHist1D::coordToIndex double    coord const [virtual]
 

Definition at line 325 of file AIDADynHist1D.cpp.

References sync(), and xAxis().

int AIDADynHist1D::dimensions void    const [virtual]
 

Definition at line 122 of file AIDADynHist1D.cpp.

int AIDADynHist1D::entries void    const [virtual]
 

Definition at line 148 of file AIDADynHist1D.cpp.

References allEntries(), extraEntries(), unweightedCache, and weightedCache.

double AIDADynHist1D::equivalentBinEntries void    const [virtual]
 

Definition at line 179 of file AIDADynHist1D.cpp.

References histo, and sync().

int AIDADynHist1D::extraEntries void    const [virtual]
 

Definition at line 169 of file AIDADynHist1D.cpp.

References histo.

Referenced by entries().

void AIDADynHist1D::fill double    x,
double    weight = 1.0
[virtual]
 

Definition at line 378 of file AIDADynHist1D.cpp.

References freeze(), frozenMessage(), histo, hiVal, loVal, maxCacheSize, needsRebook, synchronised, unweightedCache, and weightedCache.

void AIDADynHist1D::freeze void    const [private]
 

Definition at line 465 of file AIDADynHist1D.cpp.

References frozen, needsRebook, sync(), unweightedCache, and weightedCache.

Referenced by fill().

void AIDADynHist1D::frozenMessage void    const [private]
 

Definition at line 519 of file AIDADynHist1D.cpp.

References maxCacheSize.

Referenced by fill().

int AIDADynHist1D::getIntFromString const AIDA_STD::string &    str const [private]
 

Definition at line 530 of file AIDADynHist1D.cpp.

Referenced by myID().

int AIDADynHist1D::maxBin void    const [virtual]
 

Definition at line 305 of file AIDADynHist1D.cpp.

References histo, and sync().

double AIDADynHist1D::maxBinHeight void    const [virtual]
 

Definition at line 295 of file AIDADynHist1D.cpp.

References histo, and sync().

double AIDADynHist1D::mean void    const [virtual]
 

mean() returns the mean of the whole histogram as calculated on filling-time

Definition at line 254 of file AIDADynHist1D.cpp.

References histo, and sync().

int AIDADynHist1D::minBin void    const [virtual]
 

Definition at line 285 of file AIDADynHist1D.cpp.

References histo, and sync().

double AIDADynHist1D::minBinHeight void    const [virtual]
 

Definition at line 275 of file AIDADynHist1D.cpp.

References histo, and sync().

int AIDADynHist1D::myID void    const [private]
 

Definition at line 550 of file AIDADynHist1D.cpp.

References ann, and getIntFromString().

Referenced by sync().

void AIDADynHist1D::notYetMessage const AIDA_STD::string &    const [private]
 

Definition at line 509 of file AIDADynHist1D.cpp.

Referenced by write().

AIDA_STD::ostream & AIDADynHist1D::print AIDA_STD::ostream &    s const [virtual]
 

Definition at line 335 of file AIDADynHist1D.cpp.

References histo, and sync().

const CHBookHisto * AIDADynHist1D::representation void    const [virtual]
 

Definition at line 430 of file AIDADynHist1D.cpp.

References histo, and sync().

Referenced by Anaphe::AIDA_HBook::AIDAHistoFactory::store1D().

void AIDADynHist1D::reset void    [virtual]
 

Definition at line 131 of file AIDADynHist1D.cpp.

References axis, BIG_DOUBLE, frozen, histo, hiVal, loVal, needsRebook, synchronised, unweightedCache, and weightedCache.

Referenced by AIDADynHist1D().

double AIDADynHist1D::rms void    const [virtual]
 

rms() returns the rms of the whole histogram as calculated on filling-time

Definition at line 265 of file AIDADynHist1D.cpp.

References histo, and sync().

bool AIDADynHist1D::setCacheSize int    [virtual]
 

Definition at line 447 of file AIDADynHist1D.cpp.

References CACHE_SAFETY_LIMIT, frozen, maxCacheSize, unweightedCache, and weightedCache.

void AIDADynHist1D::setTitle const AIDA_STD::string &    newTitle [virtual]
 

Definition at line 103 of file AIDADynHist1D.cpp.

References histo, and name.

double AIDADynHist1D::sumAllBinHeights void    const [virtual]
 

Definition at line 199 of file AIDADynHist1D.cpp.

References sumBinHeights(), and sumExtraBinHeights().

double AIDADynHist1D::sumBinHeights void    const [virtual]
 

Definition at line 189 of file AIDADynHist1D.cpp.

References histo, and sync().

Referenced by sumAllBinHeights().

double AIDADynHist1D::sumExtraBinHeights void    const [virtual]
 

Definition at line 208 of file AIDADynHist1D.cpp.

References histo, and sync().

Referenced by sumAllBinHeights().

bool AIDADynHist1D::sync void    const [private]
 

Definition at line 399 of file AIDADynHist1D.cpp.

References axis, chooseLimits(), histo, myID(), name, nbins, needsRebook, synchronised, unweightedCache, UwcIt, uwcIt, WcIt, wcIt, and weightedCache.

Referenced by binError(), binHeight(), checkIndex(), coordToIndex(), equivalentBinEntries(), freeze(), maxBin(), maxBinHeight(), mean(), minBin(), minBinHeight(), print(), representation(), rms(), sumBinHeights(), sumExtraBinHeights(), and xAxis().

AIDA_STD::string AIDADynHist1D::title void    const [virtual]
 

Definition at line 95 of file AIDADynHist1D.cpp.

int AIDADynHist1D::write const char *    filename const [virtual]
 

Definition at line 357 of file AIDADynHist1D.cpp.

References notYetMessage().

AIDA_STD::ostream & AIDADynHist1D::write AIDA_STD::ostream &    s const [virtual]
 

Definition at line 346 of file AIDADynHist1D.cpp.

References notYetMessage().

IAxis * AIDADynHist1D::xAxis void    const [virtual]
 

Definition at line 315 of file AIDADynHist1D.cpp.

References axis, and sync().

Referenced by coordToIndex().


Member Data Documentation

IAnnotation* Anaphe::AIDA_HBook::AIDADynHist1D::ann [private]
 

Definition at line 109 of file AIDADynHist1D.h.

Referenced by AIDADynHist1D(), annotation(), myID(), and ~AIDADynHist1D().

AIDAAxis* Anaphe::AIDA_HBook::AIDADynHist1D::axis [private]
 

Definition at line 108 of file AIDADynHist1D.h.

Referenced by checkIndex(), reset(), sync(), xAxis(), and ~AIDADynHist1D().

const double AIDADynHist1D::BIG_DOUBLE = 1e30 [static, private]
 

Definition at line 36 of file AIDADynHist1D.cpp.

Referenced by chooseLimits(), and reset().

const int AIDADynHist1D::CACHE_SAFETY_LIMIT = 10000000 [static, private]
 

Definition at line 38 of file AIDADynHist1D.cpp.

Referenced by setCacheSize().

const int AIDADynHist1D::DEFAULT_MAX_CACHE_SIZE = 100000 [static, private]
 

Definition at line 37 of file AIDADynHist1D.cpp.

IHistogramFactory* Anaphe::AIDA_HBook::AIDADynHist1D::factory [private]
 

Definition at line 113 of file AIDADynHist1D.h.

bool Anaphe::AIDA_HBook::AIDADynHist1D::frozen [private]
 

Definition at line 118 of file AIDADynHist1D.h.

Referenced by freeze(), reset(), and setCacheSize().

CHBookHisto* Anaphe::AIDA_HBook::AIDADynHist1D::histo [private]
 

Definition at line 107 of file AIDADynHist1D.h.

Referenced by allEntries(), binError(), binHeight(), equivalentBinEntries(), extraEntries(), fill(), maxBin(), maxBinHeight(), mean(), minBin(), minBinHeight(), print(), representation(), reset(), rms(), setTitle(), sumBinHeights(), sumExtraBinHeights(), sync(), and ~AIDADynHist1D().

double Anaphe::AIDA_HBook::AIDADynHist1D::hiVal [private]
 

Definition at line 122 of file AIDADynHist1D.h.

Referenced by chooseLimits(), fill(), and reset().

double Anaphe::AIDA_HBook::AIDADynHist1D::loVal [private]
 

Definition at line 121 of file AIDADynHist1D.h.

Referenced by chooseLimits(), fill(), and reset().

int Anaphe::AIDA_HBook::AIDADynHist1D::maxCacheSize [private]
 

Definition at line 110 of file AIDADynHist1D.h.

Referenced by cacheSize(), fill(), frozenMessage(), and setCacheSize().

AIDA_STD::string Anaphe::AIDA_HBook::AIDADynHist1D::name [private]
 

Definition at line 112 of file AIDADynHist1D.h.

Referenced by setTitle(), and sync().

int Anaphe::AIDA_HBook::AIDADynHist1D::nbins [private]
 

Definition at line 111 of file AIDADynHist1D.h.

Referenced by sync().

bool Anaphe::AIDA_HBook::AIDADynHist1D::needsRebook [private]
 

Definition at line 120 of file AIDADynHist1D.h.

Referenced by fill(), freeze(), reset(), and sync().

bool Anaphe::AIDA_HBook::AIDADynHist1D::synchronised [private]
 

Definition at line 119 of file AIDADynHist1D.h.

Referenced by fill(), reset(), and sync().

UwCache Anaphe::AIDA_HBook::AIDADynHist1D::unweightedCache [private]
 

Definition at line 114 of file AIDADynHist1D.h.

Referenced by allEntries(), entries(), fill(), freeze(), reset(), setCacheSize(), and sync().

UwcIt Anaphe::AIDA_HBook::AIDADynHist1D::uwcIt [private]
 

Definition at line 116 of file AIDADynHist1D.h.

Referenced by sync().

WcIt Anaphe::AIDA_HBook::AIDADynHist1D::wcIt [private]
 

Definition at line 117 of file AIDADynHist1D.h.

Referenced by sync().

WCache Anaphe::AIDA_HBook::AIDADynHist1D::weightedCache [private]
 

Definition at line 115 of file AIDADynHist1D.h.

Referenced by allEntries(), entries(), fill(), freeze(), reset(), setCacheSize(), and sync().


The documentation for this class was generated from the following files:

Anaphe documentation generated by Doxygen (www.doxygen.org)