HistogramAccumulator.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef HISTOGRAMACCUMULATOR_H
#define HISTOGRAMACCUMULATOR_H
 
#include <string>
 
#include "Rtypes.h" // for classdef
 
class TH1;
 
class HistogramAccumulator
{
public:
  HistogramAccumulator();
  
  HistogramAccumulator(TH1* baseHistogram,
                       const std::string& resultHistNameIn,
                       const std::string& resultHistTitleIn);
  
  HistogramAccumulator(TH1*               baseHistogram,
                       int                nDimensionsIn,
                       const std::string& resultHistName,
                       const std::string& resultHistTitle);
 
  virtual ~HistogramAccumulator();
 
  virtual void Accumulate(TH1* newValue);
 
  virtual TH1* Terminate();
 
  inline TH1* Result() const {return result;}
 
  inline void AddNEmptyEntries(unsigned long i){n += i;}
  
  inline unsigned long N() const {return n;}
 
protected:
  virtual void AccumulateSingleValue(double        oldMean,
                                     double        oldVari,
                                     double        x,
                                     double        xVari,
                                     unsigned long nEntriesAccumulated,
                                     unsigned long nEntriesToAccumulate,
                                     double&       newMean,
                                     double&       newVari) const;
 
  int               nDimensions;     
  unsigned long     n;               
  bool              terminated;      
  const std::string resultHistName;  
  const std::string resultHistTitle; 
  TH1*              mean;
  TH1*              variance;
  TH1*              result;
 
  ClassDef(HistogramAccumulator,1);
};
 
#endif