PerEntryHistogramSet.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
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 PERENTRYHISTOGRAMSET_H
#define PERENTRYHISTOGRAMSET_H
#include "HistogramDefSet.hh"
#include "PerEntryHistogram.hh"
#include "SpectraParticles.hh"
 
#include "BDSOutputROOTEventSampler.hh"
 
#include <map>
#include <set>
#include <string>
#include <vector>
 
class Event;
class HistogramDef;
class TChain;
class TDirectory;
class TH1;
 
namespace BDS
{
  template<typename A, typename B>
  std::pair<B, A> flip_pair(const std::pair<A, B> &p)
  {return std::pair<B, A>(p.second, p.first);}
 
  template<typename A, typename B>
  std::multimap<B, A> flip_map(const std::map<A, B> &src)
  {
    std::multimap<B, A> dst;
    std::transform(src.begin(), src.end(), std::inserter(dst, dst.begin()), flip_pair<A, B>);
    return dst;
  }
}
 
class PerEntryHistogramSet: public PerEntryHistogram
{
public:
  PerEntryHistogramSet(const HistogramDefSet* definitionIn,
                       Event*                 eventIn,
                       TChain*                chainIn);  
  virtual ~PerEntryHistogramSet();
 
  virtual void AccumulateCurrentEntry(long int entryNumber);
  virtual void Terminate();
  virtual void Write(TDirectory* dir = nullptr);
  
  virtual void CheckSampler() = 0;
 
protected:
  virtual void GetPDGIDSetFromSampler(std::set<long long int>& setIn) const = 0;
  
  inline bool IsIon(long long int pdgID) const {return pdgID > 100000000;}
 
  void CreatePerEntryHistogram(long long int pdgID);
 
  std::vector<long long int> TopUtility(const std::set<long long int>& s,
                                     size_t n) const;
 
  std::vector<long long int> TopNNonIons(int n) const;
  std::vector<long long int> TopNIons(int n) const;
  std::vector<long long int> TopN(int n) const;
  
  HistogramDef* baseDefinition;
  Event*        event;
  TChain*       chain;
  std::string   branchName;
  bool          dynamicallyStoreParticles;
  bool          dynamicallyStoreIons;
  long long int nEntries;
  HistogramDefSet::writewhat what;
  int           topN;
 
#ifdef __ROOTDOUBLE__
  BDSOutputROOTEventSampler<double>* sampler;
#else
  BDSOutputROOTEventSampler<float>*  sampler;
#endif
 
  std::set<long long int>                     allPDGIDs;
  std::set<long long int>                     ions;
  std::set<long long int>                     nonIons;
  std::map<ParticleSpec, PerEntryHistogram*>  histograms;
  std::map<long long int, PerEntryHistogram*> histogramsByPDGID;
  std::vector<PerEntryHistogram*>             allPerEntryHistograms;
 
  //ClassDef(PerEntryHistogramSet, 1);
};
 
#endif