npstat is hosted by Hepforge, IPPP Durham
NPStat  5.10.0
volumeDensityFromBinnedRadial.hh
Go to the documentation of this file.
1 #ifndef NPSTAT_VOLUMEDENSITYFROMBINNEDRADIAL_HH_
2 #define NPSTAT_VOLUMEDENSITYFROMBINNEDRADIAL_HH_
3 
4 /*!
5 // \file volumeDensityFromBinnedRadial.hh
6 //
7 // \brief Convert spherically symmetric radial densities modeled by
8 // BinnedDensity1D into densities per unit area, volume, etc
9 //
10 // Author: I. Volobouev
11 //
12 // February 2016
13 */
14 
15 namespace npstat {
16  /**
17  // The function arguments are as follows:
18  //
19  // dim -- Dimensionality of the space.
20  //
21  // binWidth -- The width of the bins used originally to construct
22  // the density estimate. Typically, the value of r
23  // would be histogrammed and then smoothed. This
24  // argument must be non-negative.
25  //
26  // r -- The distance from the origin. This argument must
27  // be non-negative. In addition, "binWidth" and "r"
28  // can not simultaneously be 0s.
29  //
30  // radialDensity -- The value of density in r, i.e., (d Prob)/(d r).
31  // If the default value of 1.0 is used, the function
32  // returns the density conversion factor.
33  */
34  double volumeDensityFromBinnedRadial(unsigned dim, double binWidth,
35  double r, double radialDensity=1.0);
36 }
37 
38 #endif // NPSTAT_VOLUMEDENSITYFROMBINNEDRADIAL_HH_
Definition: AbsArrayProjector.hh:14
double volumeDensityFromBinnedRadial(unsigned dim, double binWidth, double r, double radialDensity=1.0)