TProfile3D

*-*-*-*-*-*Default constructor for Profile3D histograms*-*-*-*-*-*-*-*-*
*-*        ============================================

*-*-*-*-*-*Default destructor for Profile3D histograms*-*-*-*-*-*-*-*-*
*-*        ===========================================

*-*-*-*-*-*Normal Constructor for Profile histograms*-*-*-*-*-*-*-*-*-*
*-*        ==========================================

  The first eleven parameters are similar to TH3D::TH3D.
  All values of t are accepted at filling time.
  To fill a profile3D histogram, one must use TProfile3D::Fill function.

  Note that when filling the profile histogram the function Fill
  checks if the variable t is betyween fTmin and fTmax.
  If a minimum or maximum value is set for the T scale before filling,
  then all values below tmin or above tmax will be discarded.
  Setting the minimum or maximum value for the T scale before filling
  has the same effect as calling the special TProfile3D constructor below
  where tmin and tmax are specified.

  H(I,J,K) is printed as the cell contents. The errors computed are s(I,J,K) if CHOPT='S'
  (spread option), or e(I,J,K) if CHOPT=' ' (error on mean).

        See TProfile3D::BuildOptions for explanation of parameters

   see other constructors below with all possible combinations of
   fix and variable bin size like in TH3D.

  Create a 3-D Profile with variable bins in X , Y and Z

*-*-*-*-*-*-*Set Profile3D histogram structure and options*-*-*-*-*-*-*-*-*
*-*          =============================================

    If a cell has N data points all with the same value T (especially
    possible when dealing with integers), the spread in T for that cell
    is zero, and the uncertainty assigned is also zero, and the cell is
    ignored in making subsequent fits. If SQRT(T) was the correct error
    in the case above, then SQRT(T)/SQRT(N) would be the correct error here.
    In fact, any cell with non-zero number of entries N but with zero spread
    should have an uncertainty SQRT(T)/SQRT(N).

    Now, is SQRT(T)/SQRT(N) really the correct uncertainty?
    that it is only in the case where the T variable is some sort
    of counting statistics, following a Poisson distribution. This should
    probably be set as the default case. However, T can be any variable
    from an original NTUPLE, not necessarily distributed "Poissonly".
    The computation of errors is based on the parameter option:
    option:
     ' '  (Default) Errors are Spread/SQRT(N) for Spread.ne.0. ,
                      "     "  SQRT(T)/SQRT(N) for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0
     's'            Errors are Spread  for Spread.ne.0. ,
                      "     "  SQRT(T)  for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0
     'i'            Errors are Spread/SQRT(N) for Spread.ne.0. ,
                      "     "  1./SQRT(12.*N) for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0

    The third case above corresponds to Integer T values for which the
    uncertainty is +-0.5, with the assumption that the probability that T
    takes any value between T-0.5 and T+0.5 is uniform (the same argument
    goes for T uniformly distributed between T and T+1); this would be
    useful if T is an ADC measurement, for example. Other, fancier options
    would be possible, at the cost of adding one more parameter to the PROFILE2D
    For example, if all T variables are distributed according to some
    known Gaussian of standard deviation Sigma, then:
     'G'            Errors are Spread/SQRT(N) for Spread.ne.0. ,
                      "     "  Sigma/SQRT(N) for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0
    For example, this would be useful when all T's are experimental quantities
    measured with the same instrument with precision Sigma.

copy constructor

 Performs the operation: this = this + c1*f1

 Performs the operation: this = this + c1*h1

*-*-*-*-*Replace contents of this profile3D by the addition of h1 and h2*-*-*
*-*      ===============================================================

   this = c1*h1 + c2*h2

     static function
 set the fgApproximate flag. When the flag is true, the function GetBinError
 will approximate the bin error with the average profile error on all bins
 in the following situation only
  - the number of bins in the profile3D is less than 10404 (eg 100x100x100)
  - the bin number of entries is small ( <5)
  - the estimated bin error is extremely small compared to the bin content
  (see TProfile3D::GetBinError)

 Fill histogram with all entries in the buffer.
 action = -1 histogram is reset and refilled from the buffer (called by THistPainter::Paint)
 action =  0 histogram is filled from the buffer
 action =  1 histogram is filled and buffer is deleted
             The buffer is automatically deleted when the number of entries
             in the buffer is greater than the number of entries in the histogram

 accumulate arguments in buffer. When buffer is full, empty the buffer
 fBuffer[0] = number of entries in buffer
 fBuffer[1] = w of first entry
 fBuffer[2] = x of first entry
 fBuffer[3] = y of first entry
 fBuffer[4] = z of first entry
 fBuffer[5] = t of first entry

*-*-*-*-*-*-*-*Copy a Profile3D histogram to a new profile2D histogram*-*-*-*
*-*            =======================================================

 Performs the operation: this = this/(c1*f1)

*-*-*-*-*-*-*-*-*-*-*Divide this profile2D by h1*-*-*-*-*-*-*-*-*-*-*-*-*
*-*                  ===========================

   this = this/h1

*-*-*-*-*Replace contents of this profile2D by the division of h1 by h2*-*-*
*-*      ==============================================================

   this = c1*h1/(c2*h2)

*-*-*-*-*-*-*-*Draw a copy of this profile3D histogram*-*-*-*-*-*-*-*-*-*-*
*-*            =======================================

*-*-*-*-*-*-*-*-*-*-*Fill a Profile3D histogram (no weights)*-*-*-*-*-*-*-*
*-*                  =======================================

*-*-*-*-*-*-*-*-*-*-*Fill a Profile3D histogram with weights*-*-*-*-*-*-*-*
*-*                  =======================================

*-*-*-*-*-*-*Return bin content of a Profile3D histogram*-*-*-*-*-*-*-*-*
*-*          ===========================================

*-*-*-*-*-*-*Return bin entries of a Profile3D histogram*-*-*-*-*-*-*-*-*
*-*          ===========================================

*-*-*-*-*-*-*Return bin error of a Profile3D histogram*-*-*-*-*-*-*-*-*

 Computing errors: A moving field
 =================================
 The computation of errors for a TProfile3D has evolved with the versions
 of ROOT. The difficulty is in computing errors for bins with low statistics.
 - prior to version 3.10, we had no special treatment of low statistic bins.
   As a result, these bins had huge errors. The reason is that the
   expression eprim2 is very close to 0 (rounding problems) or 0.
 - The algorithm is modified/protected for the case
   when a TProfile3D is projected (ProjectionX). The previous algorithm
   generated a N^2 problem when projecting a TProfile3D with a large number of
   bins (eg 100000).
 - in version 3.10/02, a new static function TProfile::Approximate
   is introduced to enable or disable (default) the approximation.
   (see also comments in TProfile::GetBinError)

*-*-*-*-*-*-*-*-*-*Return option to compute profile2D errors*-*-*-*-*-*-*-*
*-*                =========================================

 fill the array stats from the contents of this profile
 The array stats must be correctly dimensionned in the calling program.
 stats[0] = sumw
 stats[1] = sumw2
 stats[2] = sumwx
 stats[3] = sumwx2
 stats[4] = sumwy
 stats[5] = sumwy2
 stats[6] = sumwxy
 stats[7] = sumwz
 stats[8] = sumwz2
 stats[9] = sumwxz
 stats[10]= sumwyz
 stats[11]= sumwt
 stats[12]= sumwt2

 If no axis-subrange is specified (via TAxis::SetRange), the array stats
 is simply a copy of the statistics quantities computed at filling time.
 If a sub-range is specified, the function recomputes these quantities
 from the bin contents in the current axis range.

Merge all histograms in the collection in this histogram.
This function computes the min/max for the axes,
compute a new number of bins, if necessary,
add bin contents, errors and statistics.
If overflows are present and limits are different the function will fail.
The function returns the total number of entries in the result histogram
if the merge is successfull, -1 otherwise.

IMPORTANT remark. The 2 axis x and y may have different number
of bins and different limits, BUT the largest bin width must be
a multiple of the smallest bin width and the upper limit must also
be a multiple of the bin width.

 Performs the operation: this = this*c1*f1

*-*-*-*-*-*-*-*-*-*-*Multiply this profile2D by h1*-*-*-*-*-*-*-*-*-*-*-*
*-*                  =============================

   this = this*h1

*-*-*-*-*Replace contents of this profile2D by multiplication of h1 by h2*-*
*-*      ================================================================

   this = (c1*h1)*(c2*h2)

*-*-*-*-*Project this profile3D into a 3-D histogram along X,Y,Z*-*-*-*-*-*-*
*-*      =====================================================

   The projection is always of the type TH3D.

   if option "E" is specified, the errors are computed. (default)
   if option "B" is specified, the content of bin of the returned histogram
      will be equal to the GetBinEntries(bin) of the profile,
   if option "C=E" the bin contents of the projection are set to the
       bin errors of the profile

 Replace current statistics with the values in array stats

*-*-*-*-*-*-*-*-*-*Reset contents of a Profile3D histogram*-*-*-*-*-*-*-*
*-*                =======================================

 Profile histogram is resized along ax such that x is in the axis range.
 The new axis limits are recomputed by doubling iteratively
 the current axis range until the specified value x is within the limits.
 The algorithm makes a copy of the histogram, then loops on all bins
 of the old histogram to fill the rebinned histogram.
 Takes into account errors (Sumw2) if any.
 The bit kCanRebin must be set before invoking this function.
  Ex:  h->SetBit(TH1::kCanRebin);

 Save primitive as a C++ statement(s) on output stream out

*-*-*-*-*Multiply this profile2D by a constant c1*-*-*-*-*-*-*-*-*
*-*      ========================================

   this = c1*this

 This function uses the services of TProfile3D::Add

*-*-*-*-*-*-*-*-*Set the number of entries in bin*-*-*-*-*-*-*-*-*-*-*-*
*-*              ================================

*-*-*-*-*-*-*-*-*Redefine  x axis parameters*-*-*-*-*-*-*-*-*-*-*-*
*-*              ===========================

 set the buffer size in units of 8 bytes (double)

*-*-*-*-*-*-*-*-*-*Set option to compute profile2D errors*-*-*-*-*-*-*-*
*-*                =======================================

    The computation of errors is based on the parameter option:
    option:
     ' '  (Default) Errors are Spread/SQRT(N) for Spread.ne.0. ,
                      "     "  SQRT(T)/SQRT(N) for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0
     's'            Errors are Spread  for Spread.ne.0. ,
                      "     "  SQRT(T)  for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0
     'i'            Errors are Spread/SQRT(N) for Spread.ne.0. ,
                      "     "  1./SQRT(12.*N) for Spread.eq.0,N.gt.0 ,
                      "     "  0.  for N.eq.0
   See TProfile3D::BuildOptions for explanation of all options