yoda is hosted by Hepforge, IPPP Durham
YODA - Yet more Objects for Data Analysis  1.7.2
YODA::Bin2D< DBN > Class Template Reference

A generic 2D bin type. More...

#include <Bin2D.h>

Inheritance diagram for YODA::Bin2D< DBN >:
YODA::Bin

Public Member Functions

size_t dim ()
 Dimension of the fill space. More...
 
Constructors
 Bin2D (const std::pair< double, double > &xedges, const std::pair< double, double > &yedges)
 Make a new, empty bin with two pairs of edges. More...
 
 Bin2D (const std::pair< double, double > &xedges, const std::pair< double, double > &yedges, const DBN &dbn)
 Make a bin with all the components of a fill history. More...
 
 Bin2D (const Bin2D< DBN > &b)
 Copy constructor. More...
 
Bin2D< DBN > & operator= (const Bin2D< DBN > &b)
 Copy assignment. More...
 
Modifiers
virtual void reset ()
 Reset this bin. More...
 
void scaleW (double scalefactor)
 
void scaleXY (double scaleX, double scaleY)
 
X-axis info
std::pair< double, double > xEdges () const
 Get the {low,high} edges as an STL pair. More...
 
double xMin () const
 Lower x limit of the bin (inclusive). More...
 
double xMax () const
 Upper x limit of the bin (exclusive). More...
 
std::pair< double, double > yEdges () const
 Get the {low,high} edges as an STL pair. More...
 
double yMin () const
 Lower y limit of the bin (inclusive). More...
 
double yMax () const
 Upper y limit of the bin (exclusive). More...
 
double xMid () const
 Middle of the bin in x. More...
 
double yMid () const
 Middle of the bin in y. More...
 
std::pair< double, double > xyMid () const
 The geometric centre of the bin. More...
 
double xWidth () const
 Width of the bin in x. More...
 
double yWidth () const
 Width of the bin in y. More...
 
std::pair< double, double > xyWidths () const
 Widths of the bin in x and y. More...
 
double area () const
 Area of the bin in x-y. More...
 
double xFocus () const
 The mean x position in the bin, or the x midpoint if that is not available. More...
 
double yFocus () const
 The mean y position in the bin, or the y midpoint if that is not available. More...
 
std::pair< double, double > xyFocus () const
 The mean position in the bin, or the midpoint if that is not available. More...
 
Distribution statistics
double xMean () const
 Mean value of x-values in the bin. More...
 
double yMean () const
 Mean value of y-values in the bin. More...
 
double xVariance () const
 The variance of x-values in the bin. More...
 
double yVariance () const
 The variance of y-values in the bin. More...
 
double xStdDev () const
 The standard deviation (spread) of x-values in the bin. More...
 
double yStdDev () const
 The standard deviation (spread) of y-values in the bin. More...
 
double xStdErr () const
 The standard error on the bin x focus. More...
 
double yStdErr () const
 The standard error on the bin y focus. More...
 
double xRMS () const
 The x RMS in the bin. More...
 
double yRMS () const
 The y RMS in the bin. More...
 
Raw distribution statistics
DBN & dbn ()
 Statistical distribution in this bin (non-const) More...
 
const DBN & dbn () const
 Statistical distribution in this bin (const) More...
 
double numEntries () const
 The number of entries. More...
 
double effNumEntries () const
 The effective number of entries. More...
 
double sumW () const
 The sum of weights. More...
 
double sumW2 () const
 The sum of weights squared. More...
 
double sumWX () const
 The sum of x*weight. More...
 
double sumWY () const
 The sum of y*weight. More...
 
double sumWXY () const
 The sum of x*y*weight. More...
 
double sumWX2 () const
 The sum of x^2 * weight. More...
 
double sumWY2 () const
 The sum of y^2 * weight. More...
 
Operators
Bin2D< DBN > & operator+= (const Bin2D< DBN > &b)
 Add two bins. More...
 
Bin2D< DBN > & operator-= (const Bin2D< DBN > &b)
 Subtract one bin from another. More...
 
Named operators
Bin2D< DBN > & add (const Bin2D< DBN > &b)
 Merge two adjacent bins. More...
 
Bin2D< DBN > & subtract (const Bin2D< DBN > &b)
 
bool fitsInside (std::pair< double, double > xrange, std::pair< double, double > yrange) const
 Test whether this bin would fit inside the given area. More...
 
bool bounds (double x, double y) const
 Test whether a point lies within the current bin. More...
 
int adjacentTo (const Bin2D< DBN > &b) const
 Test whether two bins are adjacent and, if so, return how as an integer. More...
 
- Public Member Functions inherited from YODA::Bin
virtual ~Bin ()
 Virtual destructor for inheritance. More...
 

Detailed Description

template<class DBN>
class YODA::Bin2D< DBN >

A generic 2D bin type.

This is a generic 2D bin type which supplies the accessors for the two "x" and "y" axis directions in which it is defined. Bin2D is not intended to be directly instantiated: it is inherited from to make specific histogram and profile bin types as HistoBin2D and ProfileBin2D. The lower bin edges in x and y are inclusive. This base class provides no fill method, since the signatures for standard and profile histos differ.

Definition at line 25 of file Bin2D.h.

Constructor & Destructor Documentation

◆ Bin2D() [1/3]

template<class DBN>
YODA::Bin2D< DBN >::Bin2D ( const std::pair< double, double > &  xedges,
const std::pair< double, double > &  yedges 
)
inline

Make a new, empty bin with two pairs of edges.

Definition at line 46 of file Bin2D.h.

47  : _xedges(xedges), _yedges(yedges)
48  {
49  if (_xedges.second < _xedges.first) {
50  throw RangeError("The bin x-edges are wrongly defined!");
51  }
52  if (_yedges.second < _yedges.first) {
53  throw RangeError("The bin y-edges are wrongly defined!");
54  }
55  }

◆ Bin2D() [2/3]

template<class DBN>
YODA::Bin2D< DBN >::Bin2D ( const std::pair< double, double > &  xedges,
const std::pair< double, double > &  yedges,
const DBN &  dbn 
)
inline

Make a bin with all the components of a fill history.

Mainly intended for internal persistency use.

Definition at line 61 of file Bin2D.h.

63  : _xedges(xedges), _yedges(yedges), _dbn(dbn)
64  {
65  if (_xedges.second < _xedges.first) {
66  throw RangeError("The bin x-edges are wrongly defined!");
67  }
68  if (_yedges.second < _yedges.first) {
69  throw RangeError("The bin y-edges are wrongly defined!");
70  }
71  }
DBN & dbn()
Statistical distribution in this bin (non-const)
Definition: Bin2D.h:288

◆ Bin2D() [3/3]

template<class DBN>
YODA::Bin2D< DBN >::Bin2D ( const Bin2D< DBN > &  b)
inline

Copy constructor.

Definition at line 75 of file Bin2D.h.

76  : _xedges(b._xedges),
77  _yedges(b._yedges),
78  _dbn(b._dbn)
79  { }

Member Function Documentation

◆ add()

template<class DBN>
Bin2D<DBN>& YODA::Bin2D< DBN >::add ( const Bin2D< DBN > &  b)
inline

Merge two adjacent bins.

Add two bins (internal, explicitly named version)

This operator is defined for adding two bins with equivalent binning. It cannot be used to merge two bins into one larger bin.

Definition at line 389 of file Bin2D.h.

Referenced by YODA::ProfileBin2D::add(), and YODA::Bin2D< Dbn3D >::operator+=().

389  {
390  if (_xedges != b._xedges || _yedges != b._yedges) {
391  throw LogicError("Attempted to add two bins with different edges");
392  }
393  _dbn += b._dbn;
394  return *this;
395  }

◆ adjacentTo()

template<class DBN>
int YODA::Bin2D< DBN >::adjacentTo ( const Bin2D< DBN > &  b) const
inline

Test whether two bins are adjacent and, if so, return how as an integer.

Definition at line 426 of file Bin2D.h.

426  {
427  for (int i = 0; i < 4; i++) {
428  if (_edges_equal(b, i, (i+2) % 4))
429  return i;
430  }
431  return -1;
432  }

◆ area()

template<class DBN>
double YODA::Bin2D< DBN >::area ( ) const
inline

Area of the bin in x-y.

Definition at line 201 of file Bin2D.h.

201  {
202  return xWidth() * yWidth();
203  }
double xWidth() const
Width of the bin in x.
Definition: Bin2D.h:185
double yWidth() const
Width of the bin in y.
Definition: Bin2D.h:190

◆ bounds()

template<class DBN>
bool YODA::Bin2D< DBN >::bounds ( double  x,
double  y 
) const
inline

Test whether a point lies within the current bin.

Definition at line 420 of file Bin2D.h.

420  {
421  return (x >= xMin() && x < xMax() && y >= yMin() && y < yMax());
422  }
double yMax() const
Upper y limit of the bin (exclusive).
Definition: Bin2D.h:163
double xMin() const
Lower x limit of the bin (inclusive).
Definition: Bin2D.h:142
double yMin() const
Lower y limit of the bin (inclusive).
Definition: Bin2D.h:158
double xMax() const
Upper x limit of the bin (exclusive).
Definition: Bin2D.h:147

◆ dbn() [1/2]

template<class DBN>
DBN& YODA::Bin2D< DBN >::dbn ( )
inline

Statistical distribution in this bin (non-const)

Definition at line 288 of file Bin2D.h.

288  {
289  return _dbn;
290  }

◆ dbn() [2/2]

template<class DBN>
const DBN& YODA::Bin2D< DBN >::dbn ( ) const
inline

Statistical distribution in this bin (const)

Definition at line 293 of file Bin2D.h.

293  {
294  return _dbn;
295  }

◆ dim()

template<class DBN>
size_t YODA::Bin2D< DBN >::dim ( )
inlinevirtual

Dimension of the fill space.

Implements YODA::Bin.

Definition at line 95 of file Bin2D.h.

95 { return 2; }

◆ effNumEntries()

template<class DBN>
double YODA::Bin2D< DBN >::effNumEntries ( ) const
inlinevirtual

The effective number of entries.

Implements YODA::Bin.

Definition at line 303 of file Bin2D.h.

303  {
304  return _dbn.effNumEntries();
305  }

◆ fitsInside()

template<class DBN>
bool YODA::Bin2D< DBN >::fitsInside ( std::pair< double, double >  xrange,
std::pair< double, double >  yrange 
) const
inline

Test whether this bin would fit inside the given area.

Definition at line 411 of file Bin2D.h.

412  {
413  return (xMin() >= xrange.first &&
414  yMin() >= yrange.first &&
415  xMax() < xrange.second &&
416  yMax() < yrange.second);
417  }
double yMax() const
Upper y limit of the bin (exclusive).
Definition: Bin2D.h:163
double xMin() const
Lower x limit of the bin (inclusive).
Definition: Bin2D.h:142
double yMin() const
Lower y limit of the bin (inclusive).
Definition: Bin2D.h:158
double xMax() const
Upper x limit of the bin (exclusive).
Definition: Bin2D.h:147

◆ numEntries()

template<class DBN>
double YODA::Bin2D< DBN >::numEntries ( ) const
inlinevirtual

The number of entries.

Implements YODA::Bin.

Definition at line 298 of file Bin2D.h.

Referenced by YODA::efficiency().

298  {
299  return _dbn.numEntries();
300  }

◆ operator+=()

template<class DBN>
Bin2D<DBN>& YODA::Bin2D< DBN >::operator+= ( const Bin2D< DBN > &  b)
inline

Add two bins.

Definition at line 351 of file Bin2D.h.

351  {
352  return add(b);
353  }
Bin2D< DBN > & add(const Bin2D< DBN > &b)
Merge two adjacent bins.
Definition: Bin2D.h:389

◆ operator-=()

template<class DBN>
Bin2D<DBN>& YODA::Bin2D< DBN >::operator-= ( const Bin2D< DBN > &  b)
inline

Subtract one bin from another.

Definition at line 356 of file Bin2D.h.

356  {
357  return subtract(b);
358  }
Bin2D< DBN > & subtract(const Bin2D< DBN > &b)
Definition: Bin2D.h:402

◆ operator=()

template<class DBN>
Bin2D<DBN>& YODA::Bin2D< DBN >::operator= ( const Bin2D< DBN > &  b)
inline

Copy assignment.

Definition at line 83 of file Bin2D.h.

Referenced by YODA::HistoBin2D::operator=(), and YODA::ProfileBin2D::operator=().

83  {
84  _xedges = b._xedges;
85  _yedges = b._yedges;
86  _dbn = b._dbn;
87  return *this;
88  }

◆ reset()

template<class DBN>
virtual void YODA::Bin2D< DBN >::reset ( )
inlinevirtual

Reset this bin.

Implements YODA::Bin.

Reimplemented in YODA::ProfileBin2D, and YODA::HistoBin2D.

Definition at line 103 of file Bin2D.h.

Referenced by YODA::HistoBin2D::reset(), and YODA::ProfileBin2D::reset().

103  {
104  _dbn.reset();
105  }

◆ scaleW()

template<class DBN>
void YODA::Bin2D< DBN >::scaleW ( double  scalefactor)
inline

Rescale as if all fill weights had been different by factor scalefactor

Note
This should not be used, since it breaks histogram consistency. It will be removed in a future version.

Definition at line 110 of file Bin2D.h.

110  {
111  _dbn.scaleW(scalefactor);
112  }

◆ scaleXY()

template<class DBN>
void YODA::Bin2D< DBN >::scaleXY ( double  scaleX,
double  scaleY 
)
inline

Scale the x and y coordinates and distributions.

Note
This should not be used, since it breaks histogram consistency. It will be removed in a future version.

Definition at line 117 of file Bin2D.h.

117  {
118  _xedges.first *= scaleX;
119  _xedges.second *= scaleX;
120 
121  _yedges.first *= scaleY;
122  _yedges.second *= scaleY;
123 
124  _dbn.scaleX(scaleX);
125  _dbn.scaleY(scaleY);
126  }

◆ subtract()

template<class DBN>
Bin2D<DBN>& YODA::Bin2D< DBN >::subtract ( const Bin2D< DBN > &  b)
inline

Subtract one bin from another (internal, explicitly named version)

This operator is defined for subtracting two bins with equivalent binning. It cannot be used to merge two bins into one larger bin.

Definition at line 402 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::operator-=(), and YODA::ProfileBin2D::subtract().

402  {
403  if (_xedges != b._xedges || _yedges != b._yedges) {
404  throw LogicError("Attempted to subtract two bins with different edges");
405  }
406  _dbn -= b._dbn;
407  return *this;
408  }

◆ sumW()

template<class DBN>
double YODA::Bin2D< DBN >::sumW ( ) const
inlinevirtual

The sum of weights.

Implements YODA::Bin.

Definition at line 308 of file Bin2D.h.

Referenced by YODA::toTH2D(), YODA::Bin2D< Dbn3D >::xFocus(), and YODA::Bin2D< Dbn3D >::yFocus().

308  {
309  return _dbn.sumW();
310  }

◆ sumW2()

template<class DBN>
double YODA::Bin2D< DBN >::sumW2 ( ) const
inlinevirtual

The sum of weights squared.

Implements YODA::Bin.

Definition at line 313 of file Bin2D.h.

Referenced by YODA::toTH2D().

313  {
314  return _dbn.sumW2();
315  }

◆ sumWX()

template<class DBN>
double YODA::Bin2D< DBN >::sumWX ( ) const
inline

The sum of x*weight.

Definition at line 318 of file Bin2D.h.

318  {
319  return _dbn.sumWX();
320  }

◆ sumWX2()

template<class DBN>
double YODA::Bin2D< DBN >::sumWX2 ( ) const
inline

The sum of x^2 * weight.

Definition at line 333 of file Bin2D.h.

333  {
334  return _dbn.sumWX2();
335  }

◆ sumWXY()

template<class DBN>
double YODA::Bin2D< DBN >::sumWXY ( ) const
inline

The sum of x*y*weight.

Definition at line 328 of file Bin2D.h.

328  {
329  return _dbn.sumWXY();
330  }

◆ sumWY()

template<class DBN>
double YODA::Bin2D< DBN >::sumWY ( ) const
inline

The sum of y*weight.

Definition at line 323 of file Bin2D.h.

323  {
324  return _dbn.sumWY();
325  }

◆ sumWY2()

template<class DBN>
double YODA::Bin2D< DBN >::sumWY2 ( ) const
inline

The sum of y^2 * weight.

Definition at line 338 of file Bin2D.h.

338  {
339  return _dbn.sumWY2();
340  }

◆ xEdges()

template<class DBN>
std::pair<double,double> YODA::Bin2D< DBN >::xEdges ( ) const
inline

Get the {low,high} edges as an STL pair.

Definition at line 137 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::adjacentTo().

137  {
138  return _xedges;
139  }

◆ xFocus()

template<class DBN>
double YODA::Bin2D< DBN >::xFocus ( ) const
inline

The mean x position in the bin, or the x midpoint if that is not available.

Definition at line 207 of file Bin2D.h.

Referenced by YODA::mkScatter(), and YODA::Bin2D< Dbn3D >::xyFocus().

207  {
208  return (!isZero(sumW())) ? xMean() : xMid();
209  }
bool isZero(double val, double tolerance=1E-8)
Definition: MathUtils.h:55
double xMean() const
Mean value of x-values in the bin.
Definition: Bin2D.h:230
double xMid() const
Middle of the bin in x.
Definition: Bin2D.h:169
double sumW() const
The sum of weights.
Definition: Bin2D.h:308

◆ xMax()

template<class DBN>
double YODA::Bin2D< DBN >::xMax ( ) const
inline

Upper x limit of the bin (exclusive).

Definition at line 147 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::adjacentTo(), YODA::Bin2D< Dbn3D >::bounds(), YODA::divide(), YODA::Bin2D< Dbn3D >::fitsInside(), YODA::mkScatter(), YODA::toTH2D(), YODA::Bin2D< Dbn3D >::xMid(), and YODA::Bin2D< Dbn3D >::xWidth().

147  {
148  return _xedges.second;
149  }

◆ xMean()

template<class DBN>
double YODA::Bin2D< DBN >::xMean ( ) const
inline

Mean value of x-values in the bin.

Definition at line 230 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::xFocus().

230  {
231  return _dbn.xMean();
232  }

◆ xMid()

template<class DBN>
double YODA::Bin2D< DBN >::xMid ( ) const
inline

Middle of the bin in x.

Definition at line 169 of file Bin2D.h.

Referenced by YODA::divide(), YODA::mkScatter(), YODA::Bin2D< Dbn3D >::xFocus(), and YODA::Bin2D< Dbn3D >::xyMid().

169  {
170  return (xMax() + xMin())/2.0;
171  }
double xMin() const
Lower x limit of the bin (inclusive).
Definition: Bin2D.h:142
double xMax() const
Upper x limit of the bin (exclusive).
Definition: Bin2D.h:147

◆ xMin()

template<class DBN>
double YODA::Bin2D< DBN >::xMin ( ) const
inline

◆ xRMS()

template<class DBN>
double YODA::Bin2D< DBN >::xRMS ( ) const
inline

The x RMS in the bin.

Definition at line 270 of file Bin2D.h.

270  {
271  return _dbn.xRMS();
272  }

◆ xStdDev()

template<class DBN>
double YODA::Bin2D< DBN >::xStdDev ( ) const
inline

The standard deviation (spread) of x-values in the bin.

Definition at line 250 of file Bin2D.h.

250  {
251  return _dbn.xStdDev();
252  }

◆ xStdErr()

template<class DBN>
double YODA::Bin2D< DBN >::xStdErr ( ) const
inline

The standard error on the bin x focus.

Definition at line 260 of file Bin2D.h.

260  {
261  return _dbn.xStdErr();
262  }

◆ xVariance()

template<class DBN>
double YODA::Bin2D< DBN >::xVariance ( ) const
inline

The variance of x-values in the bin.

Definition at line 240 of file Bin2D.h.

240  {
241  return _dbn.xVariance();
242  }

◆ xWidth()

template<class DBN>
double YODA::Bin2D< DBN >::xWidth ( ) const
inline

Width of the bin in x.

Definition at line 185 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::area(), and YODA::Bin2D< Dbn3D >::xyWidths().

185  {
186  return xMax() - xMin();
187  }
double xMin() const
Lower x limit of the bin (inclusive).
Definition: Bin2D.h:142
double xMax() const
Upper x limit of the bin (exclusive).
Definition: Bin2D.h:147

◆ xyFocus()

template<class DBN>
std::pair<double, double> YODA::Bin2D< DBN >::xyFocus ( ) const
inline

The mean position in the bin, or the midpoint if that is not available.

Definition at line 217 of file Bin2D.h.

217  {
218  return std::make_pair(xFocus(), yFocus());
219  }
double yFocus() const
The mean y position in the bin, or the y midpoint if that is not available.
Definition: Bin2D.h:212
double xFocus() const
The mean x position in the bin, or the x midpoint if that is not available.
Definition: Bin2D.h:207

◆ xyMid()

template<class DBN>
std::pair<double, double> YODA::Bin2D< DBN >::xyMid ( ) const
inline

The geometric centre of the bin.

Definition at line 179 of file Bin2D.h.

Referenced by YODA::Histo2D::fillBin().

179  {
180  return std::make_pair(xMid(), yMid());
181  }
double xMid() const
Middle of the bin in x.
Definition: Bin2D.h:169
double yMid() const
Middle of the bin in y.
Definition: Bin2D.h:174

◆ xyWidths()

template<class DBN>
std::pair<double, double> YODA::Bin2D< DBN >::xyWidths ( ) const
inline

Widths of the bin in x and y.

Definition at line 195 of file Bin2D.h.

195  {
196  return std::make_pair(xWidth(), yWidth());
197  }
double xWidth() const
Width of the bin in x.
Definition: Bin2D.h:185
double yWidth() const
Width of the bin in y.
Definition: Bin2D.h:190

◆ yEdges()

template<class DBN>
std::pair<double,double> YODA::Bin2D< DBN >::yEdges ( ) const
inline

Get the {low,high} edges as an STL pair.

Definition at line 153 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::adjacentTo().

153  {
154  return _yedges;
155  }

◆ yFocus()

template<class DBN>
double YODA::Bin2D< DBN >::yFocus ( ) const
inline

The mean y position in the bin, or the y midpoint if that is not available.

Definition at line 212 of file Bin2D.h.

Referenced by YODA::mkScatter(), and YODA::Bin2D< Dbn3D >::xyFocus().

212  {
213  return (!isZero(sumW())) ? yMean() : yMid();
214  }
bool isZero(double val, double tolerance=1E-8)
Definition: MathUtils.h:55
double sumW() const
The sum of weights.
Definition: Bin2D.h:308
double yMid() const
Middle of the bin in y.
Definition: Bin2D.h:174
double yMean() const
Mean value of y-values in the bin.
Definition: Bin2D.h:235

◆ yMax()

template<class DBN>
double YODA::Bin2D< DBN >::yMax ( ) const
inline

Upper y limit of the bin (exclusive).

Definition at line 163 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::adjacentTo(), YODA::Bin2D< Dbn3D >::bounds(), YODA::divide(), YODA::Bin2D< Dbn3D >::fitsInside(), YODA::mkScatter(), YODA::toTH2D(), YODA::Bin2D< Dbn3D >::yMid(), and YODA::Bin2D< Dbn3D >::yWidth().

163  {
164  return _yedges.second;
165  }

◆ yMean()

template<class DBN>
double YODA::Bin2D< DBN >::yMean ( ) const
inline

Mean value of y-values in the bin.

Definition at line 235 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::yFocus().

235  {
236  return _dbn.yMean();
237  }

◆ yMid()

template<class DBN>
double YODA::Bin2D< DBN >::yMid ( ) const
inline

Middle of the bin in y.

Definition at line 174 of file Bin2D.h.

Referenced by YODA::divide(), YODA::mkScatter(), YODA::Bin2D< Dbn3D >::xyMid(), and YODA::Bin2D< Dbn3D >::yFocus().

174  {
175  return (yMax() + yMin())/2.0;
176  }
double yMax() const
Upper y limit of the bin (exclusive).
Definition: Bin2D.h:163
double yMin() const
Lower y limit of the bin (inclusive).
Definition: Bin2D.h:158

◆ yMin()

template<class DBN>
double YODA::Bin2D< DBN >::yMin ( ) const
inline

Lower y limit of the bin (inclusive).

Definition at line 158 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::adjacentTo(), YODA::Bin2D< Dbn3D >::bounds(), YODA::divide(), YODA::Bin2D< Dbn3D >::fitsInside(), YODA::mkScatter(), YODA::toTH2D(), YODA::Bin2D< Dbn3D >::yMid(), and YODA::Bin2D< Dbn3D >::yWidth().

158  {
159  return _yedges.first;
160  }

◆ yRMS()

template<class DBN>
double YODA::Bin2D< DBN >::yRMS ( ) const
inline

The y RMS in the bin.

Definition at line 275 of file Bin2D.h.

275  {
276  return _dbn.yRMS();
277  }

◆ yStdDev()

template<class DBN>
double YODA::Bin2D< DBN >::yStdDev ( ) const
inline

The standard deviation (spread) of y-values in the bin.

Definition at line 255 of file Bin2D.h.

255  {
256  return _dbn.yStdDev();
257  }

◆ yStdErr()

template<class DBN>
double YODA::Bin2D< DBN >::yStdErr ( ) const
inline

The standard error on the bin y focus.

Definition at line 265 of file Bin2D.h.

265  {
266  return _dbn.yStdErr();
267  }

◆ yVariance()

template<class DBN>
double YODA::Bin2D< DBN >::yVariance ( ) const
inline

The variance of y-values in the bin.

Definition at line 245 of file Bin2D.h.

245  {
246  return _dbn.yVariance();
247  }

◆ yWidth()

template<class DBN>
double YODA::Bin2D< DBN >::yWidth ( ) const
inline

Width of the bin in y.

Definition at line 190 of file Bin2D.h.

Referenced by YODA::Bin2D< Dbn3D >::area(), and YODA::Bin2D< Dbn3D >::xyWidths().

190  {
191  return yMax() - yMin();
192  }
double yMax() const
Upper y limit of the bin (exclusive).
Definition: Bin2D.h:163
double yMin() const
Lower y limit of the bin (inclusive).
Definition: Bin2D.h:158

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