Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::AIDA_HBook::AIDAHistogram2D Class Reference

#include <AIDAHistogram2D.h>

List of all members.

Public Methods

 AIDAHistogram2D (const char *name="", const int &nBinsX=2, const double &lowX=0.0, const double &highX=1.0, const int &nBinsY=2, const double &lowY=0.0, const double &highY=1.0, const Anaphe::IAnnotation *=0, const Anaphe::IHistogramFactory *=0)
 AIDAHistogram2D (const CHBookHisto2 *, const Anaphe::IHistogramFactory *=0)
 AIDAHistogram2D (const HistoParameters2D &hp, const Anaphe::IAnnotation *=0, const Anaphe::IHistogramFactory *=0)
virtual ~AIDAHistogram2D ()
virtual AIDA_STD::string title () const
virtual void setTitle (const AIDA_STD::string &value)
virtual 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 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 void fill (double x, double y, double weight=1)
 Fill histogram.

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

virtual int binEntriesX (int indexX) const
virtual int binEntriesY (int indexY) const
virtual double binHeight (int indexX, int indexY) const
 Height of a specific in-range bin (height respects weights of entries).

virtual double binHeightX (int indexX) const
virtual double binHeightY (int indexY) const
virtual double binError (int indexX, int indexY) const
 Bin contents error.

virtual double meanX () const
virtual double meanY () const
virtual double rmsX () const
virtual double rmsY () const
virtual double minBinHeight () const
 Min height of in-range bins in the whole histogram.

virtual int minBinX () const
 IndexX of the in-range bin containing the minBinHeight().

virtual int minBinY () const
 IndexY of the in-range bin containing the minBinHeight().

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

virtual int maxBinX () const
 IndexX of the in-range bin containing the maxBinHeight().

virtual int maxBinY () const
 IndexY of the in-range bin containing the maxBinHeight().

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

virtual Anaphe::IAxis * yAxis () const
 Get the Y axis.

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

virtual int coordToIndexY (double coordY) const
 Equivalent to yAxis().coordToIndex( coordY );.

virtual Anaphe::IHistogram1D * projectionX () const
virtual Anaphe::IHistogram1D * projectionY () const
virtual Anaphe::IHistogram1D * sliceX (int indexY) const
virtual Anaphe::IHistogram1D * sliceY (int indexX) const
virtual Anaphe::IHistogram1D * sliceX (int, int) const
 Slice parallel with the axis X, between indexY1 and indexY2.

virtual Anaphe::IHistogram1D * sliceY (int, int) const
 Slice parallel with the axis Y, between indexX1 and indexX2.

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 CHBookHisto2 * representation () const
 ========================================================================== access to internal histogram (not in Abstract Interface !)


Private Methods

virtual int calcIndex (double coord, int part) const
 Calculate the index from a given coordinate in a given partition.

virtual int checkIndexX (int indexX) const
virtual int checkIndexY (int indexY) const
virtual int getIntFromString (const AIDA_STD::string &) const
virtual AIDA_STD::string getStringFromInt (const int &) const
virtual Anaphe::IHistogram1D * slice (const int &low, const int &hi, const int &axis) const
virtual bool goodIndices (const int &i, const int &j, const int &axis) const
virtual AIDA_STD::string binname (const int &) const
void notYetMessage (const AIDA_STD::string &featureName) const
void crisisMessage (const AIDA_STD::string &featureName) const

Private Attributes

Anaphe::IAxis * xaxis
Anaphe::IAxis * yaxis
Anaphe::IAnnotation * ann
Anaphe::IHistogramFactory * factory
CHBookHisto2 * rep
bool ownsRep


Constructor & Destructor Documentation

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

-------------------------------------------------------------------------- Constructors for 2D histogram with fixed binning --------------------------------------------------------------------------

Definition at line 78 of file AIDAHistogram2D.cpp.

References ann, getIntFromString(), getStringFromInt(), rep, xaxis, and yaxis.

AIDAHistogram2D::AIDAHistogram2D const CHBookHisto2 *   ,
const Anaphe::IHistogramFactory *    = 0
 

Definition at line 114 of file AIDAHistogram2D.cpp.

References ann, getStringFromInt(), rep, xaxis, and yaxis.

AIDAHistogram2D::AIDAHistogram2D const HistoParameters2D &    hp,
const Anaphe::IAnnotation *    = 0,
const Anaphe::IHistogramFactory *    = 0
 

Definition at line 47 of file AIDAHistogram2D.cpp.

References ann, Anaphe::AIDA_HBook::Builder::buildFrom(), getIntFromString(), getStringFromInt(), Anaphe::AIDA_HBook::Builder::noWarnings(), rep, xaxis, and yaxis.

AIDAHistogram2D::~AIDAHistogram2D   [virtual]
 

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

Definition at line 144 of file AIDAHistogram2D.cpp.

References ann, rep, xaxis, and yaxis.


Member Function Documentation

int AIDAHistogram2D::allEntries   const [virtual]
 

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

Definition at line 226 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Referenced by entries().

Anaphe::IAnnotation * AIDAHistogram2D::annotation   [virtual]
 

Definition at line 187 of file AIDAHistogram2D.cpp.

References ann.

int AIDAHistogram2D::binEntries int    indexX,
int    indexY
const [virtual]
 

-------------------------------------------------------------------------- Entries

The indexX accepts UNDERFLOW_BIN, values from 0 to Nx-1, or OVERFLOW_BIN The indexY accepts UNDERFLOW_BIN, values from 0 to Ny-1, or OVERFLOW_BIN

NW | N | NE ---------------------------- W | in-range bins | E -------------------------- SW | S | SE

--------------------------------------------------------------------------

Definition at line 304 of file AIDAHistogram2D.cpp.

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

int AIDAHistogram2D::binEntriesX int    indexX const [virtual]
 

Total number of entries in the projected slice to the axis X Equivalent to projectionX().binEntries( indexX );

Definition at line 315 of file AIDAHistogram2D.cpp.

References projectionX().

int AIDAHistogram2D::binEntriesY int    indexY const [virtual]
 

Total number of entries in the projected slice to the axis Y Equivalent to projectionY().binEntries( indexY );

Definition at line 329 of file AIDAHistogram2D.cpp.

References projectionY().

double AIDAHistogram2D::binError int    indexX,
int    indexY
const [virtual]
 

Definition at line 387 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

double AIDAHistogram2D::binHeight int    indexX,
int    indexY
const [virtual]
 

Definition at line 342 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Referenced by binEntries(), and slice().

double AIDAHistogram2D::binHeightX int    indexX const [virtual]
 

Total number of bin heights in the projected slice to to axis X Equivalent to projectionX().binHeight( indexX );

Definition at line 360 of file AIDAHistogram2D.cpp.

References projectionX().

double AIDAHistogram2D::binHeightY int    indexY const [virtual]
 

Total number of bin heights in the projected slice to to axis Y Equivalent to projectionY().binHeight( indexY );

Definition at line 374 of file AIDAHistogram2D.cpp.

References projectionY().

AIDA_STD::string AIDAHistogram2D::binname const int &    const [private, virtual]
 

Definition at line 803 of file AIDAHistogram2D.cpp.

References getStringFromInt().

Referenced by slice().

int AIDAHistogram2D::calcIndex double    coord,
int    part
const [private, virtual]
 

Definition at line 681 of file AIDAHistogram2D.cpp.

int AIDAHistogram2D::checkIndexX int    indexX const [private, virtual]
 

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

Definition at line 693 of file AIDAHistogram2D.cpp.

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

int AIDAHistogram2D::checkIndexY int    indexY const [private, virtual]
 

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

Definition at line 705 of file AIDAHistogram2D.cpp.

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

int AIDAHistogram2D::coordToIndexX double    coordX const [virtual]
 

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

Definition at line 558 of file AIDAHistogram2D.cpp.

References xAxis().

int AIDAHistogram2D::coordToIndexY double    coordY const [virtual]
 

Definition at line 567 of file AIDAHistogram2D.cpp.

References yAxis().

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

Definition at line 854 of file AIDAHistogram2D.cpp.

Referenced by allEntries(), binEntries(), binError(), binHeight(), entries(), extraEntries(), fill(), maxBinHeight(), maxBinX(), maxBinY(), minBinHeight(), minBinX(), minBinY(), print(), reset(), setTitle(), sumAllBinHeights(), sumBinHeights(), and sumExtraBinHeights().

int AIDAHistogram2D::dimensions   const [virtual]
 

Definition at line 196 of file AIDAHistogram2D.cpp.

int AIDAHistogram2D::entries   const [virtual]
 

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

Definition at line 215 of file AIDAHistogram2D.cpp.

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

double AIDAHistogram2D::equivalentBinEntries   const [virtual]
 

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

Definition at line 247 of file AIDAHistogram2D.cpp.

References notYetMessage().

int AIDAHistogram2D::extraEntries   const [virtual]
 

Definition at line 236 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Referenced by entries().

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

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

Definition at line 288 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

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

Definition at line 813 of file AIDAHistogram2D.cpp.

Referenced by AIDAHistogram2D().

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

Definition at line 833 of file AIDAHistogram2D.cpp.

Referenced by AIDAHistogram2D(), and binname().

bool AIDAHistogram2D::goodIndices const int &    i,
const int &    j,
const int &    axis
const [private, virtual]
 

Definition at line 782 of file AIDAHistogram2D.cpp.

References xAxis(), and yAxis().

Referenced by slice().

double AIDAHistogram2D::maxBinHeight   const [virtual]
 

Definition at line 500 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

int AIDAHistogram2D::maxBinX   const [virtual]
 

Definition at line 510 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

int AIDAHistogram2D::maxBinY   const [virtual]
 

Definition at line 525 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

double AIDAHistogram2D::meanX   const [virtual]
 

meanX() returns the mean of the whole histogram as calculated on filling-time projected on the axis X

Definition at line 405 of file AIDAHistogram2D.cpp.

References projectionX().

double AIDAHistogram2D::meanY   const [virtual]
 

meanY() returns the mean of the whole histogram as calculated on filling-time projected on the axis Y

Definition at line 419 of file AIDAHistogram2D.cpp.

References projectionY().

double AIDAHistogram2D::minBinHeight   const [virtual]
 

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

Definition at line 460 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

int AIDAHistogram2D::minBinX   const [virtual]
 

Definition at line 470 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

int AIDAHistogram2D::minBinY   const [virtual]
 

Definition at line 485 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

void AIDAHistogram2D::notYetMessage const AIDA_STD::string &    featureName const [private]
 

Definition at line 843 of file AIDAHistogram2D.cpp.

Referenced by equivalentBinEntries(), and write().

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

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

Definition at line 634 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Anaphe::IHistogram1D * AIDAHistogram2D::projectionX   const [virtual]
 

Projection on axis X Equivalent to sliceX( UNDERFLOW_BIN, OVERFLOW_BIN );

Definition at line 577 of file AIDAHistogram2D.cpp.

References sliceX().

Referenced by binEntriesX(), binHeightX(), meanX(), and rmsX().

Anaphe::IHistogram1D * AIDAHistogram2D::projectionY   const [virtual]
 

Projection on axis Y Equivalent to sliceY( UNDERFLOW_BIN, OVERFLOW_BIN );

Definition at line 587 of file AIDAHistogram2D.cpp.

References sliceY().

Referenced by binEntriesY(), binHeightY(), meanY(), and rmsY().

const CHBookHisto2 * AIDAHistogram2D::representation   const
 

Definition at line 666 of file AIDAHistogram2D.cpp.

References rep.

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

void AIDAHistogram2D::reset   [virtual]
 

Definition at line 205 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

double AIDAHistogram2D::rmsX   const [virtual]
 

rmsX() returns the rms of the whole histogram as calculated on filling-time projected on the axis X

Definition at line 433 of file AIDAHistogram2D.cpp.

References projectionX().

double AIDAHistogram2D::rmsY   const [virtual]
 

rmsY() returns the rms of the whole histogram as calculated on filling-time projected on the axis Y

Definition at line 447 of file AIDAHistogram2D.cpp.

References projectionY().

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

Definition at line 177 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Anaphe::IHistogram1D * AIDAHistogram2D::slice const int &    low,
const int &    hi,
const int &    axis
const [private, virtual]
 

Definition at line 715 of file AIDAHistogram2D.cpp.

References binHeight(), binname(), Anaphe::AIDA_HBook::AIDAHistogram1D::fill(), goodIndices(), title(), xAxis(), and yAxis().

Referenced by sliceX(), and sliceY().

Anaphe::IHistogram1D * AIDAHistogram2D::sliceX int   ,
int   
const [virtual]
 

Definition at line 616 of file AIDAHistogram2D.cpp.

References slice().

Anaphe::IHistogram1D * AIDAHistogram2D::sliceX int    indexY const [virtual]
 

Slice parallel with the axis X, identified by bin indexY Equivalent to sliceX( indexY, indexY );

Definition at line 597 of file AIDAHistogram2D.cpp.

Referenced by projectionX().

Anaphe::IHistogram1D * AIDAHistogram2D::sliceY int   ,
int   
const [virtual]
 

Definition at line 625 of file AIDAHistogram2D.cpp.

References slice().

Anaphe::IHistogram1D * AIDAHistogram2D::sliceY int    indexX const [virtual]
 

Slice parallel with the axis Y, identified by bin indexX Equivalent to sliceY( indexX, indexX );

Definition at line 607 of file AIDAHistogram2D.cpp.

Referenced by projectionY().

double AIDAHistogram2D::sumAllBinHeights   const [virtual]
 

Definition at line 268 of file AIDAHistogram2D.cpp.

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

double AIDAHistogram2D::sumBinHeights   const [virtual]
 

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

Definition at line 258 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Referenced by sumAllBinHeights().

double AIDAHistogram2D::sumExtraBinHeights   const [virtual]
 

Definition at line 278 of file AIDAHistogram2D.cpp.

References crisisMessage(), and rep.

Referenced by sumAllBinHeights().

AIDA_STD::string AIDAHistogram2D::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 168 of file AIDAHistogram2D.cpp.

Referenced by slice().

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

Definition at line 656 of file AIDAHistogram2D.cpp.

References notYetMessage().

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

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

Definition at line 645 of file AIDAHistogram2D.cpp.

References notYetMessage().

IAxis * AIDAHistogram2D::xAxis   const [virtual]
 

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

Definition at line 540 of file AIDAHistogram2D.cpp.

References xaxis.

Referenced by coordToIndexX(), goodIndices(), and slice().

IAxis * AIDAHistogram2D::yAxis   const [virtual]
 

Definition at line 549 of file AIDAHistogram2D.cpp.

References yaxis.

Referenced by coordToIndexY(), goodIndices(), and slice().


Member Data Documentation

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

Definition at line 366 of file AIDAHistogram2D.h.

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

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

Definition at line 367 of file AIDAHistogram2D.h.

bool Anaphe::AIDA_HBook::AIDAHistogram2D::ownsRep [private]
 

Definition at line 369 of file AIDAHistogram2D.h.

CHBookHisto2* Anaphe::AIDA_HBook::AIDAHistogram2D::rep [private]
 

Definition at line 368 of file AIDAHistogram2D.h.

Referenced by AIDAHistogram2D(), allEntries(), binEntries(), binError(), binHeight(), entries(), extraEntries(), fill(), maxBinHeight(), maxBinX(), maxBinY(), minBinHeight(), minBinX(), minBinY(), print(), representation(), reset(), setTitle(), sumAllBinHeights(), sumBinHeights(), sumExtraBinHeights(), and ~AIDAHistogram2D().

Anaphe::IAxis* Anaphe::AIDA_HBook::AIDAHistogram2D::xaxis [private]
 

Definition at line 364 of file AIDAHistogram2D.h.

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

Anaphe::IAxis* Anaphe::AIDA_HBook::AIDAHistogram2D::yaxis [private]
 

Definition at line 365 of file AIDAHistogram2D.h.

Referenced by AIDAHistogram2D(), yAxis(), and ~AIDAHistogram2D().


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

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