Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::AIDA_HBook::AIDAHist1DVar Class Reference

#include <AIDAHist1DVar.h>

List of all members.

Public Methods

 AIDAHist1DVar (const char *name, const AIDA_STD::vector< float > &binEdges, const IAnnotation *=0, const IHistogramFactory *f=0)
 AIDAHist1DVar (const CHBookHisto *, const IHistogramFactory *=0)
virtual ~AIDAHist1DVar (void)
virtual AIDA_STD::string title (void) const
virtual void setTitle (const AIDA_STD::string &value)
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 weight=1)
 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 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 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 *file_name) const
 Write (ASCII) the histogram table into a file.

const CHBookHisto * 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
CHBookHisto * histo
bool ownsHist


Constructor & Destructor Documentation

AIDAHist1DVar::AIDAHist1DVar const char *    name,
const AIDA_STD::vector< float > &    binEdges,
const IAnnotation *    = 0,
const IHistogramFactory *    f = 0
 

Definition at line 42 of file AIDAHist1DVar.cpp.

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

AIDAHist1DVar::AIDAHist1DVar const CHBookHisto *   ,
const IHistogramFactory *    = 0
 

Definition at line 71 of file AIDAHist1DVar.cpp.

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

AIDAHist1DVar::~AIDAHist1DVar void    [virtual]
 

Definition at line 97 of file AIDAHist1DVar.cpp.

References ann, axis, and histo.


Member Function Documentation

int AIDAHist1DVar::allEntries void    const [virtual]
 

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

Definition at line 170 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

Referenced by entries().

IAnnotation * AIDAHist1DVar::annotation void   
 

Definition at line 134 of file AIDAHist1DVar.cpp.

References ann, crisisMessage(), and histo.

int AIDAHist1DVar::binEntries int    index const [virtual]
 

Definition at line 234 of file AIDAHist1DVar.cpp.

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

double AIDAHist1DVar::binError int    index const [virtual]
 

Definition at line 257 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

double AIDAHist1DVar::binHeight int    index const [virtual]
 

Definition at line 243 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

Referenced by binEntries(), and sumExtraBinHeights().

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

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

Definition at line 384 of file AIDAHist1DVar.cpp.

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

int AIDAHist1DVar::coordToIndex double    coord const [virtual]
 

Definition at line 332 of file AIDAHist1DVar.cpp.

References xAxis().

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

Definition at line 424 of file AIDAHist1DVar.cpp.

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

int AIDAHist1DVar::dimensions void    const [virtual]
 

Definition at line 143 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

int AIDAHist1DVar::entries void    const [virtual]
 

Definition at line 161 of file AIDAHist1DVar.cpp.

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

double AIDAHist1DVar::equivalentBinEntries void    const [virtual]
 

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

Definition at line 187 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

int AIDAHist1DVar::extraEntries void    const [virtual]
 

Definition at line 179 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

Referenced by entries().

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

Definition at line 224 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

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

Definition at line 394 of file AIDAHist1DVar.cpp.

Referenced by AIDAHist1DVar().

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

Definition at line 414 of file AIDAHist1DVar.cpp.

Referenced by AIDAHist1DVar().

int AIDAHist1DVar::maxBin void    const [virtual]
 

Definition at line 315 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

double AIDAHist1DVar::maxBinHeight void    const [virtual]
 

Definition at line 306 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

double AIDAHist1DVar::mean void    const [virtual]
 

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

Definition at line 271 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

int AIDAHist1DVar::minBin void    const [virtual]
 

Definition at line 297 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

double AIDAHist1DVar::minBinHeight void    const [virtual]
 

Definition at line 289 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

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

Definition at line 340 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

const CHBookHisto * AIDAHist1DVar::representation void    const
 

Definition at line 370 of file AIDAHist1DVar.cpp.

References histo.

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

void AIDAHist1DVar::reset void    [virtual]
 

Definition at line 152 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

double AIDAHist1DVar::rms void    const [virtual]
 

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

Definition at line 280 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

void AIDAHist1DVar::setTitle const AIDA_STD::string &    value [virtual]
 

Definition at line 125 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

double AIDAHist1DVar::sumAllBinHeights void    const [virtual]
 

Definition at line 205 of file AIDAHist1DVar.cpp.

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

double AIDAHist1DVar::sumBinHeights void    const [virtual]
 

Definition at line 196 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

Referenced by sumAllBinHeights().

double AIDAHist1DVar::sumExtraBinHeights void    const [virtual]
 

Definition at line 214 of file AIDAHist1DVar.cpp.

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

Referenced by sumAllBinHeights().

AIDA_STD::string AIDAHist1DVar::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 116 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

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

Definition at line 360 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

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

Definition at line 350 of file AIDAHist1DVar.cpp.

References crisisMessage(), and histo.

IAxis * AIDAHist1DVar::xAxis void    const [virtual]
 

Definition at line 324 of file AIDAHist1DVar.cpp.

References axis.

Referenced by coordToIndex().


Member Data Documentation

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

Definition at line 129 of file AIDAHist1DVar.h.

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

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

Definition at line 128 of file AIDAHist1DVar.h.

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

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

Definition at line 130 of file AIDAHist1DVar.h.

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

Definition at line 131 of file AIDAHist1DVar.h.

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

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

Definition at line 132 of file AIDAHist1DVar.h.


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

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