Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::AIDA_HBook::AIDAProfileHist Class Reference

#include <AIDAProfileHist.h>

List of all members.

Public Methods

 AIDAProfileHist (const char *name="", const int &nBinsX=2, const double &lowX=0.0, const double &highX=1.0, const double &lowY=0.0, const double &highY=1.0, const IAnnotation *=0, const IHistogramFactory *=0)
 AIDAProfileHist (const CHBookProfile *, const IHistogramFactory *=0)
virtual ~AIDAProfileHist (void)
virtual AIDA_STD::string title (void) const
virtual void setTitle (const AIDA_STD::string &)
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 void reset (void)
 Reset contents.

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
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 void fill (double x, double y, double weight=1.0)
 Fill 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 binSpread (int index) const
 Bin contents spread.

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(void).

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(void).

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

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

virtual AIDA_STD::ostream & print (AIDA_STD::ostream &=AIDA_STD::cout) const
 Print (ASCII) the histogram into the output stream.

virtual AIDA_STD::ostream & write (AIDA_STD::ostream &=AIDA_STD::cout) 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.

const CHBookProfile * representation (void) const
 access to internal histogram (not in Abstract Interface !)


Private Methods

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

Private Attributes

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


Constructor & Destructor Documentation

AIDAProfileHist::AIDAProfileHist const char *    name = "",
const int &    nBinsX = 2,
const double &    lowX = 0.0,
const double &    highX = 1.0,
const double &    lowY = 0.0,
const double &    highY = 1.0,
const IAnnotation *    = 0,
const IHistogramFactory *    = 0
 

Definition at line 40 of file AIDAProfileHist.cpp.

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

AIDAProfileHist::AIDAProfileHist const CHBookProfile *   ,
const IHistogramFactory *    = 0
 

Definition at line 73 of file AIDAProfileHist.cpp.

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

AIDAProfileHist::~AIDAProfileHist void    [virtual]
 

Definition at line 98 of file AIDAProfileHist.cpp.

References ann, axis, and histo.


Member Function Documentation

int AIDAProfileHist::allEntries void    const [virtual]
 

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

Definition at line 173 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

Referenced by entries().

IAnnotation * AIDAProfileHist::annotation void   
 

Definition at line 139 of file AIDAProfileHist.cpp.

References ann, crisisMessage(), and histo.

int AIDAProfileHist::binEntries int    index const [virtual]
 

Definition at line 235 of file AIDAProfileHist.cpp.

References binHeight().

double AIDAProfileHist::binError int    index const [virtual]
 

Definition at line 257 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

Referenced by binSpread().

double AIDAProfileHist::binHeight int    index const [virtual]
 

Definition at line 243 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

Referenced by binEntries(), and sumExtraBinHeights().

double AIDAProfileHist::binSpread int    index const [virtual]
 

Definition at line 271 of file AIDAProfileHist.cpp.

References binError(), crisisMessage(), and histo.

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

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

Definition at line 393 of file AIDAProfileHist.cpp.

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

int AIDAProfileHist::coordToIndex double    coord const [virtual]
 

Definition at line 341 of file AIDAProfileHist.cpp.

References xAxis().

void AIDAProfileHist::crisisMessage const AIDA_STD::string &    featureName const [private]
 

Definition at line 433 of file AIDAProfileHist.cpp.

Referenced by allEntries(), annotation(), binError(), binHeight(), binSpread(), dimensions(), entries(), equivalentBinEntries(), extraEntries(), fill(), maxBin(), maxBinHeight(), mean(), minBin(), minBinHeight(), print(), reset(), rms(), setTitle(), sumBinHeights(), title(), and write().

int AIDAProfileHist::dimensions void    const [virtual]
 

Definition at line 148 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

int AIDAProfileHist::entries void    const [virtual]
 

Definition at line 166 of file AIDAProfileHist.cpp.

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

double AIDAProfileHist::equivalentBinEntries void    const [virtual]
 

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

Definition at line 190 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

int AIDAProfileHist::extraEntries void    const [virtual]
 

Definition at line 182 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

Referenced by entries().

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

Definition at line 225 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

int AIDAProfileHist::getIntFromString const AIDA_STD::string &    const [private, virtual]
 

Definition at line 403 of file AIDAProfileHist.cpp.

Referenced by AIDAProfileHist().

AIDA_STD::string AIDAProfileHist::getStringFromInt const int &    const [private, virtual]
 

Definition at line 423 of file AIDAProfileHist.cpp.

Referenced by AIDAProfileHist().

int AIDAProfileHist::maxBin void    const [virtual]
 

Definition at line 324 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

double AIDAProfileHist::maxBinHeight void    const [virtual]
 

Definition at line 315 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

double AIDAProfileHist::mean void    const [virtual]
 

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

Definition at line 280 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

int AIDAProfileHist::minBin void    const [virtual]
 

Definition at line 306 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

double AIDAProfileHist::minBinHeight void    const [virtual]
 

Definition at line 298 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

AIDA_STD::ostream & AIDAProfileHist::print AIDA_STD::ostream &    = AIDA_STD::cout const [virtual]
 

Definition at line 349 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

const CHBookProfile * AIDAProfileHist::representation void    const
 

Definition at line 379 of file AIDAProfileHist.cpp.

References histo.

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

void AIDAProfileHist::reset void    [virtual]
 

Definition at line 157 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

double AIDAProfileHist::rms void    const [virtual]
 

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

Definition at line 289 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

void AIDAProfileHist::setTitle const AIDA_STD::string &    [virtual]
 

Definition at line 130 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

double AIDAProfileHist::sumAllBinHeights void    const [virtual]
 

Definition at line 208 of file AIDAProfileHist.cpp.

References sumBinHeights(), and sumExtraBinHeights().

double AIDAProfileHist::sumBinHeights void    const [virtual]
 

Definition at line 199 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

Referenced by sumAllBinHeights().

double AIDAProfileHist::sumExtraBinHeights void    const [virtual]
 

Definition at line 216 of file AIDAProfileHist.cpp.

References binHeight().

Referenced by sumAllBinHeights().

AIDA_STD::string AIDAProfileHist::title void    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 121 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

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

Definition at line 369 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

AIDA_STD::ostream & AIDAProfileHist::write AIDA_STD::ostream &    = AIDA_STD::cout const [virtual]
 

Definition at line 359 of file AIDAProfileHist.cpp.

References crisisMessage(), and histo.

IAxis * AIDAProfileHist::xAxis void    const [virtual]
 

Definition at line 333 of file AIDAProfileHist.cpp.

References axis.

Referenced by coordToIndex().


Member Data Documentation

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

Definition at line 129 of file AIDAProfileHist.h.

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

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

Definition at line 128 of file AIDAProfileHist.h.

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

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

Definition at line 130 of file AIDAProfileHist.h.

CHBookProfile* Anaphe::AIDA_HBook::AIDAProfileHist::histo [private]
 

Definition at line 131 of file AIDAProfileHist.h.

Referenced by AIDAProfileHist(), allEntries(), annotation(), binError(), binHeight(), binSpread(), dimensions(), entries(), equivalentBinEntries(), extraEntries(), fill(), maxBin(), maxBinHeight(), mean(), minBin(), minBinHeight(), print(), representation(), reset(), rms(), setTitle(), sumBinHeights(), title(), write(), and ~AIDAProfileHist().

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

Definition at line 132 of file AIDAProfileHist.h.


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

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