Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::AIDA_HBook::AIDAHistogram1D Class Reference

#include <AIDAHistogram1D.h>

List of all members.

Public Methods

 AIDAHistogram1D (const char *name, const int &nBinsX, const double &xMin, const double &xMax, const Anaphe::IAnnotation *ann=0, const Anaphe::IHistogramFactory *f=0)
 AIDAHistogram1D (const CHBookHisto *, const Anaphe::IHistogramFactory *=0)
 AIDAHistogram1D (const HistoParameters1D &hp, const Anaphe::IAnnotation *ann=0, const Anaphe::IHistogramFactory *=0)
virtual ~AIDAHistogram1D ()
virtual std::string title () const
virtual void setTitle (const std::string &value)
Anaphe::IAnnotation * annotation ()
 Annotation of the histogram.

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

virtual void reset ()
 Reset contents.

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

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

virtual void fill (double x, double weight=1)
 Fill histogram.

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

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

virtual double sumExtraBinHeights () 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 () const
virtual double rms () const
virtual double minBinHeight () const
 Min height of in-range bins in the whole histogram.

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

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

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

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

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

virtual std::ostream & print (std::ostream &s) const
 Print (ASCII) the histogram into the output stream.

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

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

const CHBookHisto * representation (void) const
 Return pointer to CHBookHisto implementation (not in interface).


Private Methods

virtual int checkIndex (int index) const
virtual int getIntFromString (const std::string &) const
virtual std::string getStringFromInt (const int &) const
void notYetMessage (const std::string &featureName) const
void crisisMessage (const std::string &featureName) const

Private Attributes

AIDAAxisaxis
IAnnotation * ann
IHistogramFactory * factory
CHBookHisto * histo
bool ownsHist


Constructor & Destructor Documentation

AIDAHistogram1D::AIDAHistogram1D const char *    name,
const int &    nBinsX,
const double &    xMin,
const double &    xMax,
const Anaphe::IAnnotation *    ann = 0,
const Anaphe::IHistogramFactory *    f = 0
 

-------------------------------------------------------------------------- Constructors for 1D histogram --------------------------------------------------------------------------

Definition at line 46 of file AIDAHistogram1D.cpp.

References ann, axis, getIntFromString(), getStringFromInt(), and histo.

AIDAHistogram1D::AIDAHistogram1D const CHBookHisto *   ,
const Anaphe::IHistogramFactory *    = 0
 

Definition at line 113 of file AIDAHistogram1D.cpp.

References ann, axis, getStringFromInt(), and histo.

AIDAHistogram1D::AIDAHistogram1D const HistoParameters1D &    hp,
const Anaphe::IAnnotation *    ann = 0,
const Anaphe::IHistogramFactory *    = 0
 

Definition at line 76 of file AIDAHistogram1D.cpp.

References ann, axis, Anaphe::AIDA_HBook::Builder::buildFrom(), getIntFromString(), getStringFromInt(), histo, and Anaphe::AIDA_HBook::Builder::noWarnings().

AIDAHistogram1D::~AIDAHistogram1D   [virtual]
 

-------------------------------------------------------------------------- Destructor --------------------------------------------------------------------------

Definition at line 138 of file AIDAHistogram1D.cpp.

References ann, axis, and histo.


Member Function Documentation

int AIDAHistogram1D::allEntries   const [virtual]
 

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

Definition at line 227 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

Referenced by entries().

Anaphe::IAnnotation * AIDAHistogram1D::annotation  
 

Definition at line 184 of file AIDAHistogram1D.cpp.

References ann.

int AIDAHistogram1D::binEntries int    index const [virtual]
 

-------------------------------------------------------------------------- Entries The index accepts UNDERFLOW_BIN, values from 0 to N-1, or OVERFLOW_BIN --------------------------------------------------------------------------

Definition at line 290 of file AIDAHistogram1D.cpp.

References binHeight().

double AIDAHistogram1D::binError int    index const [virtual]
 

Definition at line 314 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

double AIDAHistogram1D::binHeight int    index const [virtual]
 

Definition at line 299 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

Referenced by binEntries().

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

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

Definition at line 470 of file AIDAHistogram1D.cpp.

References Anaphe::AIDA_HBook::AIDAAxis::checkIndex().

int AIDAHistogram1D::coordToIndex double    coord const [virtual]
 

-------------------------------------------------------------------------- Conversions between coordinates and bin indices --------------------------------------------------------------------------

Definition at line 399 of file AIDAHistogram1D.cpp.

References xAxis().

void AIDAHistogram1D::crisisMessage const std::string &    featureName const [private]
 

Definition at line 524 of file AIDAHistogram1D.cpp.

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

int AIDAHistogram1D::dimensions   const [virtual]
 

Definition at line 193 of file AIDAHistogram1D.cpp.

int AIDAHistogram1D::entries   const [virtual]
 

-------------------------------------------------------------------------- Total number of entries in the whole histogram (number of fills) --------------------------------------------------------------------------

Definition at line 212 of file AIDAHistogram1D.cpp.

References allEntries(), crisisMessage(), extraEntries(), and histo.

double AIDAHistogram1D::equivalentBinEntries   const [virtual]
 

Number of equivalent entries SUM[ weight ] ^ 2 / SUM[ weight^2 ]

Definition at line 250 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

int AIDAHistogram1D::extraEntries   const [virtual]
 

Definition at line 237 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

Referenced by entries().

void AIDAHistogram1D::fill double    x,
double    weight = 1
[virtual]
 

-------------------------------------------------------------------------- Histogram characteristics --------------------------------------------------------------------------

Definition at line 448 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

Referenced by Anaphe::AIDA_HBook::AIDAHistogram2D::slice().

int AIDAHistogram1D::getIntFromString const std::string &    const [private, virtual]
 

Definition at line 480 of file AIDAHistogram1D.cpp.

Referenced by AIDAHistogram1D().

std::string AIDAHistogram1D::getStringFromInt const int &    const [private, virtual]
 

Definition at line 500 of file AIDAHistogram1D.cpp.

Referenced by AIDAHistogram1D().

int AIDAHistogram1D::maxBin   const [virtual]
 

Definition at line 381 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

double AIDAHistogram1D::maxBinHeight   const [virtual]
 

Definition at line 371 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

double AIDAHistogram1D::mean   const [virtual]
 

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

Definition at line 330 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

int AIDAHistogram1D::minBin   const [virtual]
 

Definition at line 361 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

double AIDAHistogram1D::minBinHeight   const [virtual]
 

-------------------------------------------------------------------------- Minimum and maximum heights and bins --------------------------------------------------------------------------

Definition at line 351 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

void AIDAHistogram1D::notYetMessage const std::string &    featureName const [private]
 

Definition at line 510 of file AIDAHistogram1D.cpp.

Referenced by write().

std::ostream & AIDAHistogram1D::print std::ostream &    s const [virtual]
 

-------------------------------------------------------------------------- Print functions (ASCII graphical representation)

Definition at line 416 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

const CHBookHisto * AIDAHistogram1D::representation void    const
 

Definition at line 408 of file AIDAHistogram1D.cpp.

References histo.

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

void AIDAHistogram1D::reset   [virtual]
 

Definition at line 202 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

double AIDAHistogram1D::rms   const [virtual]
 

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

Definition at line 341 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

void AIDAHistogram1D::setTitle const std::string &    value [virtual]
 

Definition at line 174 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

double AIDAHistogram1D::sumAllBinHeights   const [virtual]
 

Definition at line 270 of file AIDAHistogram1D.cpp.

References crisisMessage(), histo, sumBinHeights(), and sumExtraBinHeights().

double AIDAHistogram1D::sumBinHeights   const [virtual]
 

-------------------------------------------------------------------------- Sums of bin heights (height respects weights of entries) --------------------------------------------------------------------------

Definition at line 260 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

Referenced by sumAllBinHeights().

double AIDAHistogram1D::sumExtraBinHeights   const [virtual]
 

Definition at line 280 of file AIDAHistogram1D.cpp.

References crisisMessage(), and histo.

Referenced by sumAllBinHeights().

std::string AIDAHistogram1D::title   const [virtual]
 

Title of the histogram (temporary functions, as the title will be part od the annotation, and there will be general accessors for any pair stored there)

Definition at line 165 of file AIDAHistogram1D.cpp.

int AIDAHistogram1D::write const char *    file_name const [virtual]
 

Definition at line 438 of file AIDAHistogram1D.cpp.

References notYetMessage().

std::ostream & AIDAHistogram1D::write std::ostream &    s const [virtual]
 

-------------------------------------------------------------------------- Print functions (ASCII table containing numbers e.g. bin height)

Definition at line 427 of file AIDAHistogram1D.cpp.

References notYetMessage().

IAxis * AIDAHistogram1D::xAxis   const [virtual]
 

-------------------------------------------------------------------------- Axis --------------------------------------------------------------------------

Definition at line 391 of file AIDAHistogram1D.cpp.

References axis.

Referenced by coordToIndex().


Member Data Documentation

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

Definition at line 237 of file AIDAHistogram1D.h.

Referenced by AIDAHistogram1D(), annotation(), and ~AIDAHistogram1D().

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

Definition at line 236 of file AIDAHistogram1D.h.

Referenced by AIDAHistogram1D(), xAxis(), and ~AIDAHistogram1D().

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

Definition at line 238 of file AIDAHistogram1D.h.

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

Definition at line 239 of file AIDAHistogram1D.h.

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

bool Anaphe::AIDA_HBook::AIDAHistogram1D::ownsHist [private]
 

Definition at line 240 of file AIDAHistogram1D.h.


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

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