TFCSParametrizationBase.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "ISF_FastCaloSimEvent/TFCSParametrizationBase.h"
#include "TClass.h"
#ifdef USE_GPU
// for purpose of copying all parameterization files to GPU in initialization
#include "ISF_FastCaloSimEvent/TFCSHitCellMappingWiggle.h"
#include "ISF_FastCaloSimEvent/TFCSHistoLateralShapeParametrization.h"
#include "ISF_FastCaloSimEvent/TFCSHistoLateralShapeGausLogWeight.h"
#include "ISF_FastCaloSimEvent/TFCSLateralShapeParametrizationHitChain.h"
#include "TString.h"
#endif
 
//=============================================
//======= TFCSParametrizationBase =========
//=============================================
 
TFCSParametrizationBase::TFCSParametrizationBase(const char *name,
                                                 const char *title)
    : TNamed(name, title) {}
 
void TFCSParametrizationBase::set_geometry(ICaloGeometry *geo) {
  for (unsigned int i = 0; i < size(); ++i)
    (*this)[i]->set_geometry(geo);
}
 
FCSReturnCode TFCSParametrizationBase::simulate(
    TFCSSimulationState & /*simulstate*/, const TFCSTruthState * /*truth*/,
    const TFCSExtrapolationState * /*extrapol*/) const {
  ATH_MSG_ERROR("now in TFCSParametrizationBase::simulate(). This should "
                "normally not happen");
  // Force one retry to issue a printout from the chain causing the call to this
  // method
  return (FCSReturnCode)(FCSRetry + 1);
}
 
bool TFCSParametrizationBase::compare(
    const TFCSParametrizationBase &ref) const {
  if (this == &ref) {
    ATH_MSG_DEBUG("compare(): identical instances " << this << " == " << &ref);
    return true;
  }
  return false;
}
 
void TFCSParametrizationBase::Print(Option_t *option) const {
  TString opt(option);
  bool shortprint = opt.Index("short") >= 0;
  bool longprint = msgLvl(MSG::DEBUG) || (msgLvl(MSG::INFO) && !shortprint);
  TString optprint = opt;
  optprint.ReplaceAll("short", "");
 
  if (longprint) {
    ATH_MSG_INFO(optprint << GetTitle() << " " << IsA()->GetName() );
    ATH_MSG(INFO) << optprint << "  PDGID: ";
    if (is_match_all_pdgid()) {
      ATH_MSG(INFO) << "all";
    } else {
      for (std::set<int>::iterator it = pdgid().begin(); it != pdgid().end();
           ++it) {
        if (it != pdgid().begin())
          ATH_MSG(INFO) << ", ";
        ATH_MSG(INFO) << *it;
      }
    }
    if (is_match_all_Ekin()) {
      ATH_MSG(INFO) << " ; Ekin=all";
    } else {
      ATH_MSG(INFO) << " ; Ekin=" << Ekin_nominal() << " [" << Ekin_min()
                    << " , " << Ekin_max() << ") MeV";
    }
    if (is_match_all_eta()) {
      ATH_MSG(INFO) << " ; eta=all";
    } else {
      ATH_MSG(INFO) << " ; eta=" << eta_nominal() << " [" << eta_min() << " , "
                    << eta_max() << ")";
    }
    ATH_MSG(INFO) << END_MSG(INFO);
  } else {
    ATH_MSG_INFO(optprint << GetTitle());
  }
}
 
void TFCSParametrizationBase::FindDuplicates(
    FindDuplicateClasses_t &dupclasses) {
 
  for (unsigned int i = 0; i < size(); ++i)
    if ((*this)[i]) {
      TFCSParametrizationBase *param = (*this)[i];
      FindDuplicates_t &dup = dupclasses[param->GetName()];
      // If param is already in the duplication list, skip over
      auto checkexist = dup.find(param);
      if (checkexist != dup.end()) {
        ATH_MSG_WARNING(" [TFCSParametrizationBase::FindDuplicates] "
                        "DUPLICATE POINTER DETECTED");
 
        ATH_MSG_WARNING(" - Pointer           : " << param);
        ATH_MSG_WARNING(" - Name              : " << param->GetName());
        ATH_MSG_WARNING(" - Class             : " << param->ClassName());
        ATH_MSG_WARNING(" - Occurs in parent  : " << this
                          << " (" << this->ClassName() << ")"
                          << " index=" << i);
 
        if (checkexist->second.replace) {
          TFCSParametrizationBase *refparam = checkexist->second.replace;
          ATH_MSG_DEBUG("Found duplicate pointer: "
                        << refparam << "=" << refparam->GetName()
                        << ", duplicate is " << param << "=" << param->GetName()
                        << " index " << i << " of " << this);
          dup[refparam].mother.push_back(this);
          dup[refparam].index.push_back(i);
        }
        continue;
      }
      // Add param to duplication list
      dup[param] = Duplicate_t();
      for (auto &ref : dup) {
        TFCSParametrizationBase *refparam = ref.first;
        // skip itself, as this just added above
        if (param == refparam)
          continue;
        // skip nullptr reference
        if (refparam == nullptr)
          continue;
        // skip reference that is itself going to get replaced
        if (ref.second.replace)
          continue;
        // Check for objects with identical content
        if (*param == *refparam) {
          ATH_MSG_DEBUG("Found duplicate: "
                       << refparam << "=" << refparam->GetName()
                        << ", duplicate is " << param << "=" << param->GetName()
                        << " index " << i << " of " << this);
 
          dup[param].replace = refparam;
          dup[refparam].mother.push_back(this);
          dup[refparam].index.push_back(i);
          break;
        }
      }
      // Continue for child objects in param
      param->FindDuplicates(dupclasses);
    }
}
 
void TFCSParametrizationBase::RemoveDuplicates() {
  FindDuplicateClasses_t dupclasses;
  FindDuplicates(dupclasses);
 
  std::set<TFCSParametrizationBase *> dellist;
  for (auto &dupiter : dupclasses) {
    FindDuplicates_t &dup = dupiter.second;
    for (auto onedup : dup) {
      if (onedup.second.mother.empty())
        continue;
      TFCSParametrizationBase *ref = onedup.first;
      ATH_MSG_DEBUG("Main object " << ref << "=" << ref->GetName());
      for (unsigned int i = 0; i < onedup.second.mother.size(); ++i) {
        int index = onedup.second.index[i];
        TFCSParametrizationBase *mother = onedup.second.mother[i];
        TFCSParametrizationBase *delparam = mother->operator[](index);
        unsigned int delcount = dup[delparam].mother.size();
        if (delcount == 0) {
          ATH_MSG_DEBUG("  - Delete object "
                        << delparam << "=" << delparam->GetName() << " index "
                        << index << " of " << mother << ", has " << delcount
                        << " other replacements attached. Deleting");
          mother->set_daughter(index, ref);
          dellist.insert(delparam);
        } else {
          ATH_MSG_WARNING("  - Delete object "
                          << delparam << "=" << delparam->GetName() << " index "
                          << index << " of " << mother << ", has " << delcount
                          << " other replacements attached. Skipping");
        }
      }
    }
  }
 
  ATH_MSG_INFO("RERUNNING DUPLICATE FINDING");
  FindDuplicateClasses_t dupclasses2;
  FindDuplicates(dupclasses2);
 
  std::map<std::string, int> ndel;
  for (auto *delparam : dellist) {
    FindDuplicates_t &dup2 = dupclasses2[delparam->GetName()];
    bool present = dup2.find(delparam) != dup2.end();
    if (present) {
      ATH_MSG_WARNING("- Delete object " << delparam << "="
                                         << delparam->GetName()
                                         << " still referenced somewhere!");
    } else {
      ATH_MSG_DEBUG("- Delete object " << delparam << "="
                                       << delparam->GetName());
      ++ndel[delparam->ClassName()];
      delete delparam;
    }
  }
  for (auto &del : ndel)
    ATH_MSG_INFO("Deleted " << del.second << " duplicate objects of class "
                            << del.first);
}
 
void TFCSParametrizationBase::RemoveNameTitle() {
  for (unsigned int i = 0; i < size(); ++i)
    if ((*this)[i]) {
      TFCSParametrizationBase *param = (*this)[i];
      param->SetName("");
      param->SetTitle("");
 
      // Continue for child objects in param
      param->RemoveNameTitle();
    }
}
 
#ifdef USE_GPU
void TFCSParametrizationBase::Copy2GPU() {
  for (unsigned int i = 0; i < size(); ++i) {
    if (!((*this)[i]))
      continue;
    TFCSParametrizationBase *param = (*this)[i];
    TString name = param->ClassName();
    if (name.EqualTo("TFCSLateralShapeParametrizationHitChain")) {
      auto size = (static_cast<TFCSLateralShapeParametrizationHitChain *>(param))->size();
      for (size_t ichain = 0; ichain < size; ++ichain) {
        TFCSParametrizationBase *hitsim =
            *(static_cast<TFCSLateralShapeParametrizationHitChain *>(param))[ichain];
        TString hitsimname = hitsim->ClassName();
        if (hitsimname.EqualTo("TFCSHistoLateralShapeParametrization")) {
          (static_cast<TFCSHistoLateralShapeParametrization *>(hitsim))->LoadHistFuncs();
        } else if (hitsimname.EqualTo("TFCSHitCellMappingWiggle")) {
          (static_cast<TFCSHitCellMappingWiggle *>(hitsim))->LoadHistFuncs();
        } else if (hitsimname.EqualTo("TFCSHistoLateralShapeGausLogWeight")) {
          (static_cast<TFCSHistoLateralShapeGausLogWeight *>(hitsim))->LoadHist();
        }
      }
    }
    param->Copy2GPU();
  }
}
#endif