TFCSEnergyAndHitGANV2.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_FASTCALOSIMEVENT_TFCSEnergyAndHitGANV2_h
#define ISF_FASTCALOSIMEVENT_TFCSEnergyAndHitGANV2_h
 
#include "ISF_FastCaloSimEvent/TFCSParametrizationBinnedChain.h"
#include "ISF_FastCaloSimEvent/TFCSSimulationState.h"
#include "ISF_FastCaloSimEvent/TFCSGANXMLParameters.h"
#include "ISF_FastCaloSimEvent/TFCSGANEtaSlice.h"
#include <string>
#include <mutex>
 
 
// forward declare lwtnn dependencies
namespace lwt {
class LightweightGraph;
}
 
class TFCSEnergyAndHitGANV2 : public TFCSParametrizationBinnedChain {
public:
  TFCSEnergyAndHitGANV2(const char *name = nullptr,
                        const char *title = nullptr);
  virtual ~TFCSEnergyAndHitGANV2();
 
  virtual bool is_match_Ekin_bin(int /*Ekin_bin*/) const override {
    return true;
  };
  virtual bool is_match_calosample(int calosample) const override;
  virtual bool is_match_all_Ekin_bin() const override { return true; };
  virtual bool is_match_all_calosample() const override { return false; };

  enum FCSGANfreemem {
    kGANfreemem = BIT(17) 
  };
 
  bool GANfreemem() const { return TestBit(kGANfreemem); };
  void set_GANfreemem() { SetBit(kGANfreemem); };
  void reset_GANfreemem() { ResetBit(kGANfreemem); };

  enum FCSEnergyInitializationStatusBits {
    kOnlyScaleEnergy =
        BIT(18) 
  };
 
  bool OnlyScaleEnergy() const { return TestBit(kOnlyScaleEnergy); };
  void set_OnlyScaleEnergy() { SetBit(kOnlyScaleEnergy); };
  void reset_OnlyScaleEnergy() { ResetBit(kOnlyScaleEnergy); };

  virtual int get_bin(TFCSSimulationState &simulstate, const TFCSTruthState *,
                      const TFCSExtrapolationState *) const override {
    return simulstate.getAuxInfo<int>("GANlayer"_FCShash);
  };
  virtual const std::string
  get_variable_text(TFCSSimulationState &simulstate, const TFCSTruthState *,
                    const TFCSExtrapolationState *) const override;
 
  unsigned int get_nr_of_init(unsigned int bin) const;
  void set_nr_of_init(unsigned int bin, unsigned int ninit);
 
  const TFCSGANXMLParameters::Binning& get_Binning() const {
    return m_param.GetBinning();
  };
  const TFCSGANEtaSlice::ExtrapolatorWeights get_ExtrapolationWeights() const {
    return m_slice->GetExtrapolatorWeights();
  };
 
  bool initializeNetwork(int const &pid, int const &etaMin,
                         const std::string &FastCaloGANInputFolderName);
 
  bool fillEnergy(TFCSSimulationState &simulstate, const TFCSTruthState *truth,
                  const TFCSExtrapolationState *extrapol) const;
  virtual FCSReturnCode
  simulate(TFCSSimulationState &simulstate, const TFCSTruthState *truth,
           const TFCSExtrapolationState *extrapol) const override;
 
  virtual void Print(Option_t *option = "") const override;
 
  static void test_path(const std::string& path,
                        TFCSSimulationState *simulstate = nullptr,
                        const TFCSTruthState *truth = nullptr,
                        const TFCSExtrapolationState *extrapol = nullptr,
                        const std::string& outputname = "unnamed", int pid = 211);
 
  static void unit_test(TFCSSimulationState *simulstate = nullptr,
                        const TFCSTruthState *truth = nullptr,
                        const TFCSExtrapolationState *extrapol = nullptr);
 
protected:
  void SetRegionAndSliceFromXML(int pid, int etaMax,
                                std::string FastCaloGANInputFolderName);
 
private:
  static int GetBinsInFours(double const bins);
  int GetAlphaBinsForRBin(const TAxis *x, int ix, int yBinNum) const;
 
  std::vector<int> m_bin_ninit;
 
  // Persistify configuration in string m_input. A custom Streamer(...) builds
  // m_graph on the fly when reading from file. Inside Athena, if GANfreemem()
  // is true, the content of m_input is deleted after reading in order to free
  // memory
 
  TFCSGANEtaSlice *m_slice = nullptr;
  TFCSGANXMLParameters m_param;
  mutable std::mutex m_mutex; 
 
  ClassDefOverride(TFCSEnergyAndHitGANV2, 2) // TFCSEnergyAndHitGANV2
};
 
#endif