/usr/include/ThePEG/Analysis/LWH/AIHistogram2D.h is in libthepeg-dev 1.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | // -*- C++ -*-
//
// AIHistogram2D.h is a part of ThePEG - Toolkit for HEP Event Generation
// Copyright (C) 1999-2011 Leif Lonnblad
//
// ThePEG is licenced under version 2 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef LWH_AIHistogram2D_H
#define LWH_AIHistogram2D_H
#ifndef LWH_USING_AIDA
/** @cond DONT_DOCUMENT_STRIPPED_DOWN_AIDA_INTERFACES */
#include "AIHistogram1D.h"
namespace AIDA {
class IAxis;
class IHistogram2D : virtual public IHistogram {
public:
virtual ~IHistogram2D() { /* nop */; }
/**
* Fill the IHistogram2D with a couple of values and the
* corresponding weight.
* @param x The x value to be filled in.
* @param y The y value to be filled in.
* @param weight The corresponding weight (by default 1).
* @return false If the weight is <0 or >1 (?).
*
*/
virtual bool fill(double x, double y, double weight = 1.) = 0;
/**
* The weighted mean along the x axis of a given bin.
* @param indexX The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @param indexY The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The mean of the corresponding bin along the x axis.
*
*/
virtual double binMeanX(int indexX, int indexY) const = 0;
/**
* The weighted mean along the y axis of a given bin.
* @param indexX The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @param indexY The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The mean of the corresponding bin along the y axis.
*
*/
virtual double binMeanY(int indexX, int indexY) const = 0;
/**
* Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
* @param indexX The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @param indexY The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The number of entries in the corresponding bin.
*
*/
virtual int binEntries(int indexX, int indexY) const = 0;
/**
* Sum of all the entries of the bins along a given x bin.
* This is equivalent to <tt>projectionX().binEntries(index)</tt>.
* @param index The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The number of entries in the corresponding set of bins.
*
*/
virtual int binEntriesX(int index) const = 0;
/**
* Sum of all the entries of the bins along a given y bin.
* This is equivalent to <tt>projectionY().binEntries(index)</tt>.
* @param index The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The number of entries in the corresponding set of bins.
*
*/
virtual int binEntriesY(int index) const = 0;
/**
* Total height of a give bin (ie the sum of the weights in this bin).
* @param indexX The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @param indexY The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The height of the corresponding bin.
*
*/
virtual double binHeight(int indexX, int indexY) const = 0;
/**
* Sum of all the heights of the bins along a given x bin.
* This is equivalent to <tt>projectionX().binHeight(index)</tt>.
* @param index The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The sum of the heights in the corresponding set of bins.
*
*/
virtual double binHeightX(int index) const = 0;
/**
* Sum of all the heights of the bins along a given y bin.
* This is equivalent to <tt>projectionY().binHeight(index)</tt>.
* @param index The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The sum of the heights in the corresponding set of bins.
*
*/
virtual double binHeightY(int index) const = 0;
/**
* The error of a given bin.
* @param indexX The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @param indexY The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
* @return The error on the corresponding bin.
*
*/
virtual double binError(int indexX, int indexY) const = 0;
/**
* The mean of the IHistogram2D along the x axis.
* @return The mean of the IHistogram2D along the x axis.
*
*/
virtual double meanX() const = 0;
/**
* The mean of the IHistogram2D along the y axis.
* @return The mean of the IHistogram2D along the y axis.
*
*/
virtual double meanY() const = 0;
/**
* The RMS of the IHistogram2D along the x axis.
* @return The RMS if the IHistogram2D along the x axis.
*
*/
virtual double rmsX() const = 0;
/**
* The RMS of the IHistogram2D along the y axis.
* @return The RMS if the IHistogram2D along the y axis.
*
*/
virtual double rmsY() const = 0;
/**
* Get the x axis of the IHistogram2D.
* @return The x coordinate IAxis.
*
*/
virtual const IAxis & xAxis() const = 0;
/**
* Get the y axis of the IHistogram2D.
* @return The y coordinate IAxis.
*
*/
virtual const IAxis & yAxis() const = 0;
/**
* Get the bin number corresponding to a given coordinate along the x axis.
* This is a convenience method, equivalent to <tt>xAxis().coordToIndex(coord)</tt>.
* @see IAxis#coordToIndex(double)
* @param coord The coordinalte along the x axis.
* @return The corresponding bin number.
*
*/
virtual int coordToIndexX(double coord) const = 0;
/**
* Get the bin number corresponding to a given coordinate along the y axis.
* This is a convenience method, equivalent to <tt>yAxis().coordToIndex(coord)</tt>.
* @see IAxis#coordToIndex(double)
* @param coord The coordinalte along the y axis.
* @return The corresponding bin number.
*
*/
virtual int coordToIndexY(double coord) const = 0;
/**
* Add to this IHistogram2D the contents of another IHistogram2D.
* @param hist The IHistogram2D to be added to this IHistogram2D.
* @return false If the IHistogram2Ds binnings are incompatible.
*
*/
virtual bool add(const IHistogram2D & hist) = 0;
virtual bool scale(double scaleFactor) = 0;
}; // class
} // namespace AIDA
/** @endcond */
#else
#include "AIDA/IHistogram2D.h"
#endif
#endif /* LWH_AIHistogram2D_H */
|