SectorMapBootstrapModule.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <iostream>
 
#include <tracking/trackFindingVXD/filterMap/map/FiltersContainer.h>
#include "tracking/trackFindingVXD/environment/VXDTFFilters.h"
#include "tracking/modules/vxdtfRedesign/SectorMapBootstrapModule.h"
//#include "tracking/dataobjects/VXDTFSecMap.h"
#include "tracking/dataobjects/SectorMapConfig.h"
#include <tracking/spacePointCreation/SpacePoint.h>
 
// needed for complicated parameter types to not get an undefined reference error
#include <framework/core/ModuleParam.templateDetails.h>
 
#include <vxd/geometry/GeoCache.h>
#include <vxd/geometry/SensorInfoBase.h>
 
#include <TString.h>
#include <TFile.h>
#include <TTree.h>
 
#include <algorithm>
#include <fstream>
 
 
using namespace Belle2;
 
REG_MODULE(SectorMapBootstrap);
 
SectorMapBootstrapModule::SectorMapBootstrapModule() : Module()
{
 
  setPropertyFlags(c_ParallelProcessingCertified);
 
  setDescription("Create the VXDTF SectorMap for the following modules."
                );
 
  addParam("SectorMapsInputFile", m_sectorMapsInputFile,
           "File from which the SectorMaps will be retrieved if\
 ReadSectorMap is set to true", m_sectorMapsInputFile);
 
  addParam("SectorMapsOutputFile", m_sectorMapsOutputFile,
           "File into which the SectorMaps will be written if\
 WriteSectorMap is set to true", m_sectorMapsOutputFile);
 
  addParam("ReadSectorMap", m_readSectorMap, "If set to true \
retrieve the SectorMaps from SectorMapsInputFile during initialize.", m_readSectorMap);
 
  addParam("WriteSectorMap", m_writeSectorMap, "If set to true \
at endRun write the SectorMaps to SectorMapsOutputFile.", m_writeSectorMap);
 
  addParam("SetupToRead", m_setupToRead, "If non empty only the setup with the given name will be read"
           " from the from the root file. All other will be ignored. If empty \"\" (default) all setups are read. Will "
           "only used if sectormap is retrieved from root file. Case will be ignored!",
           std::string(""));
 
  addParam("ReadSecMapFromDB", m_readSecMapFromDB, "If set to true the sector map will be read from the Data Base. NOTE: this will "
           "override the parameter ReadSectorMap (reading sector map from file)!!!", m_readSecMapFromDB);
 
 
  // dummy vector needed to get the current structure of the filter
  std::vector< std::pair<char, void*> > dummyVector = {};
 
  VXDTFFilters<SpacePoint>::twoHitFilter_t empty2HitFilter;
  // the structure is the same for all specializations of the template
  std::string structure2HitFilter = empty2HitFilter.getNameAndReference(&dummyVector);
  dummyVector.clear();
  addParam("twoHitFilterAdjustFunctions", m_twoHitFilterAdjustFunctions,
           "Vector of vectors containing expressions used to "
           "alter the 2-hit filters. The inner vector should contain exactly two strings. The first entry is interpreted as index (integer). "
           "The second entry is interpreted as function used to create a TF1. The variable to be altered will be assumed to be called \"x\" "
           "and in addition one can use \"[0]\" can be used which will be interpreted as FullSecID of the static sector the filter is attached to. "
           "No other parameter is allowed. The structure of the 2-hit filter is as follows:       " + structure2HitFilter +
           "    Example: [(1, \"12\"), (3, \"sin(x)\"), (4, \"x + [0]\")]    PS: use this feature only if you know what you are doing!",
           m_twoHitFilterAdjustFunctions);
 
  VXDTFFilters<SpacePoint>::threeHitFilter_t empty3HitFilter;
  // the structure is the same for all specializations of the template
  std::string structure3HitFilter = empty3HitFilter.getNameAndReference(&dummyVector);
  dummyVector.clear();
  addParam("threeHitFilterAdjustFunctions", m_threeHitFilterAdjustFunctions,
           "Vector of vectors containing expressions used to "
           "alter the 3-hit filters. The inner vector should contain exactly two strings. The first entry is interpreted as index (integer). "
           "The second entry is interpreted as function used to create a TF1. The variable to be altered will be assumed to be called \"x\" "
           "and in addition \"[0]\" can be used which will be interpreted as FullSecID of the static sector the filter is attached to. No other "
           "parameter is allowed. The structure of the 2-hit filter is as follows:     " + structure3HitFilter +
           "    Example: [(1, \"12\"), (3, \"sin(x)\"), (4, \"x + [0]\")]    PS: use this feature only if you know what you are doing!",
           m_threeHitFilterAdjustFunctions);
}
 
void
SectorMapBootstrapModule::initialize()
{
 
  // in case sector map is read from the DB one needs to set the DB pointer
  if (m_readSecMapFromDB) {
    B2DEBUG(29, "SectorMapBootstrapModule: Retrieving sectormap from DB. Filename: " << m_sectorMapsInputFile);
    m_ptrDBObjPtr = new DBObjPtr<PayloadFile>(m_sectorMapsInputFile);
    if (m_ptrDBObjPtr == nullptr) B2FATAL("SectorMapBootstrapModule: the DBObjPtr is not initialized");
    // add a callback function so that the sectormap is updated each time the DBObj changes
    m_ptrDBObjPtr->addCallback(this,  &SectorMapBootstrapModule::retrieveSectorMap);
  }
  // retrieve the SectorMap or create an empty one
  if (m_readSectorMap || m_readSecMapFromDB)
    retrieveSectorMap();
  else
    bootstrapSectorMap();
 
  // security measurement: test if output file exists so that existing sector maps are not overwritten
  if (m_writeSectorMap) {
    if (std::ifstream(m_sectorMapsOutputFile.c_str())) {
      B2FATAL("Detected existing output file! Please delete or move before proceeding! File name: " << m_sectorMapsOutputFile);
    } else {
      B2DEBUG(29, "Checked that output file does not exist!");
    }
  }
 
 
 
}
 
void
SectorMapBootstrapModule::beginRun()
{
}
 
 
void
SectorMapBootstrapModule::event()
{
}
 
void
SectorMapBootstrapModule::bootstrapSectorMap(void)
{
 
 
  // TODO: Most of the information is not used at all.
  //        It seems to me (EP) that only the SectorDividers are used.
 
  // TODO: find a better way to put the configs into the framework
 
  // WARNING: chose the names of the configs in that way that they are not contained in each other!
  //       E.g. having two configs with names "BobTheGreat" and "Bob" is not allowed as it will cause problems in some modules!
 
 
  // for now declare this as default config for SVD only tracking!
  SectorMapConfig config1;
//   config1.pTmin = 0.02;
//   config1.pTmax = 0.08;
  config1.pTmin = 0.02; // minimal relevant version
  config1.pTmax = 6.0; // minimal relevant version // Feb18-onePass-Test
  config1.pTSmear = 0.;
  config1.allowedLayers = {0, 3, 4, 5, 6};
//   config1.uSectorDivider = { .15, .5, .85, 1.};
//   config1.vSectorDivider = { .1, .3, .5, .7, .9, 1.};
  config1.uSectorDivider = {.25, .5, .75, 1.}; // standard relevant version
  config1.vSectorDivider = {.25, .5, .75, 1.}; // standard relevant version
//   config1.uSectorDivider = { .5, 1.}; // small relevant version
//   config1.vSectorDivider = { .5, 1.}; // small relevant version
//   config1.uSectorDivider = { 1.}; // minimal relevant version
//   config1.vSectorDivider = { 1.}; // minimal relevant version
  config1.pdgCodesAllowed = {};
  config1.seedMaxDist2IPXY = 23.5;
  config1.seedMaxDist2IPZ = 23.5;
  config1.nHitsMin = 3;
  config1.vIP = B2Vector3D(0, 0, 0);
  config1.secMapName = "SVDOnlyDefault"; // has been: "lowTestRedesign";
  config1.mField = 1.5;
  config1.rarenessThreshold = 0.; //0.001;
  config1.quantiles = {0., 1.};  //{0.005, 1. - 0.005};
  // TODO: still missing: minimal sample-size, quantiles for smaller samplesizes, threshshold small <-> big sampleSize.
  bootstrapSectorMap(config1);
 
 
  // 11th Oct. 2023: removed to prevent that corresponding training samples are generated. Still want to keep it to not forget how it is done.
  /*
  // same as config1 but allows the PXD layers
  // default for VXD tracking (SVD+PXD)
  SectorMapConfig config1point1;
  config1point1.pTmin = 0.02; // minimal relevant version
  config1point1.pTmax = 6.0; // minimal relevant version // Feb18-onePass-Test
  config1point1.pTSmear = 0.;
  config1point1.allowedLayers = {0, 1, 2, 3, 4, 5, 6};
  config1point1.uSectorDivider = { .3, .7, 1.}; // standard relevant version
  config1point1.vSectorDivider = { .3, .7, 1.}; // standard relevant version
  config1point1.pdgCodesAllowed = {};
  config1point1.seedMaxDist2IPXY = 23.5;
  config1point1.seedMaxDist2IPZ = 23.5;
  config1point1.nHitsMin = 3;
  config1point1.vIP = B2Vector3D(0, 0, 0);
  config1point1.secMapName = "SVDPXDDefault"; // has been: "lowTestSVDPXD";
  config1point1.mField = 1.5;
  config1point1.rarenessThreshold = 0.; //0.001;
  config1point1.quantiles = {0., 1.};  //{0.005, 1. - 0.005};
  bootstrapSectorMap(config1point1);
  */
}
 
void
SectorMapBootstrapModule::endRun()
{
  if (m_writeSectorMap)
    persistSectorMap();
}
 
void
SectorMapBootstrapModule::bootstrapSectorMap(const SectorMapConfig& config)
{
 
  // TODO: change naming! This is poor naming as these include also Triplet filters!
  VXDTFFilters<SpacePoint>* segmentFilters = new VXDTFFilters<SpacePoint>();
  segmentFilters->setConfig(config);
 
  // TO DO: The whole information must be retrieved from the geometry
  CompactSecIDs compactSecIds;
 
  std::vector< double > uDividersMinusLastOne = config.uSectorDivider;
  uDividersMinusLastOne.pop_back();
  std::vector< double > vDividersMinusLastOne = config.vSectorDivider;
  vDividersMinusLastOne.pop_back();
 
 
  std::vector< std::vector< FullSecID > > sectors;
 
  sectors.resize(config.uSectorDivider.size());
  unsigned nSectorsInU = config.uSectorDivider.size(),
           nSectorsInV = config.vSectorDivider.size();
 
  // retrieve the full list of sensors from the geometry
  const VXD::GeoCache& geometry = VXD::GeoCache::getInstance();
  std::vector<VxdID> listOfSensors = geometry.getListOfSensors();
  for (VxdID aSensorId : listOfSensors) {
 
    // filter only those sensors on layers which are specified in the config
    if (std::find(config.allowedLayers.begin(), config.allowedLayers.end(),
                  aSensorId.getLayerNumber()) == config.allowedLayers.end()) continue;
 
    // for testbeams there might be other sensors in the geometry so filter for SVD and PXD only, as the CompactSecID dont like those!
    VXD::SensorInfoBase::SensorType type = geometry.getSensorInfo(aSensorId).getType();
    if (type != VXD::SensorInfoBase::SVD && type != VXD::SensorInfoBase::PXD) {
      B2WARNING("Found sensor which is not PXD or SVD with VxdID: " << aSensorId << " ! Will skip that sensor ");
      continue;
    }
 
    int counter = 0;
    for (unsigned int i = 0; i < nSectorsInU; i++) {
      sectors.at(i).resize(nSectorsInV);
      for (unsigned int j = 0; j < nSectorsInV ; j++) {
        sectors.at(i).at(j) = FullSecID(aSensorId, false, counter);
        counter ++;
      }
    }
    segmentFilters->addSectorsOnSensor(uDividersMinusLastOne,
                                       vDividersMinusLastOne,
                                       sectors) ;
  }//end loop over sensors
 
 
  // if layer 0 is specified in the config then the virtual IP is added
  if (std::find(config.allowedLayers.begin(), config.allowedLayers.end(), 0) != config.allowedLayers.end()) {
    std::vector<double> uCuts4vIP = {}, vCuts4vIP = {};
    sectors.clear();
    sectors = {{ FullSecID(0) }};
    segmentFilters->addSectorsOnSensor(uCuts4vIP, vCuts4vIP, sectors);
  }
 
  // put config into the container
  FiltersContainer<SpacePoint>::getInstance().assignFilters(config.secMapName, segmentFilters);
 
}
 
 
void
SectorMapBootstrapModule::persistSectorMap(void)
{
 
  // the "CREATE" option results in the root file not being opened if it already exists (to prevent overwriting existing sectormaps)
  TFile rootFile(m_sectorMapsOutputFile.c_str(), "CREATE");
  if (!rootFile.IsOpen()) B2FATAL("Unable to open rootfile! This could be caused by an already existing file of the same name: "
                                    << m_sectorMapsOutputFile.c_str());
 
  TTree* tree = new TTree(c_setupKeyNameTTreeName.c_str(),
                          c_setupKeyNameTTreeName.c_str());
 
  TString setupKeyName;
 
  tree->Branch(c_setupKeyNameBranchName.c_str(),
               & setupKeyName);
 
  auto allSetupsFilters = FiltersContainer<SpacePoint>::getInstance().getAllSetups();
  for (auto singleSetupFilters : allSetupsFilters) {
 
    setupKeyName = TString(singleSetupFilters.first.c_str());
 
    tree->Fill();
 
    rootFile.mkdir(setupKeyName, setupKeyName);
    rootFile.cd(setupKeyName);
 
    singleSetupFilters.second->persistOnRootFile();
 
    rootFile.cd("..");
 
  }
 
  rootFile.Write();
  rootFile.Close();
 
 
}
 
 
void
SectorMapBootstrapModule::retrieveSectorMap(void)
{
 
  std::string rootFileName = m_sectorMapsInputFile;
  // if reading from the DB get the root file name from the DB object ptr
  if (m_readSecMapFromDB) {
    if (m_ptrDBObjPtr == nullptr) B2FATAL("SectorMapBootstrapModule: the pointer to the DB payload is not set!");
    if (!(*m_ptrDBObjPtr).isValid()) B2FATAL("SectorMapBootstrapModule the DB object is not valid!");
 
    rootFileName = (*m_ptrDBObjPtr)->getFileName();
  }
 
  B2DEBUG(29, "SectorMapBootstrapModule: retrieving new SectorMap. New file name: " << rootFileName);
  TFile rootFile(rootFileName.c_str());
 
  // some cross check that the file is open
  if (!rootFile.IsOpen()) B2FATAL("The root file: " << rootFileName << " was not found.");
 
  TTree* tree = nullptr;
  rootFile.GetObject(c_setupKeyNameTTreeName.c_str(), tree);
  if (tree == nullptr) B2FATAL("SectorMapBootstrapModule: tree not found! tree name: " << c_setupKeyNameTTreeName.c_str());
 
  TString* setupKeyName = nullptr;
  // cppcheck-suppress nullPointerRedundantCheck
  tree->SetBranchAddress(c_setupKeyNameBranchName.c_str(),
                         & setupKeyName);
  if (setupKeyName == nullptr) B2FATAL("SectorMapBootstrapModule: setupKeyName not found");
 
  // ignore case, so only upper case
  TString setupToRead_upper = m_setupToRead;
  setupToRead_upper.ToUpper();
 
  // to monitor if anything was read from the root files
  bool read_something = false;
 
  FiltersContainer<SpacePoint>& filtersContainer = FiltersContainer<SpacePoint>::getInstance();
  auto nEntries = tree->GetEntriesFast();
  for (int i = 0;  i < nEntries ; i++) {
    tree->GetEntry(i);
 
    // if a setup name is specified only read that one
    if (setupToRead_upper != "") {
      TString buff = setupKeyName->Data();
      buff.ToUpper();
      if (buff != setupToRead_upper) continue;
    }
 
    rootFile.cd(setupKeyName->Data());
 
    B2DEBUG(29, "Retrieving SectorMap with name " << setupKeyName->Data());
 
    VXDTFFilters<SpacePoint>* segmentFilters = new VXDTFFilters<SpacePoint>();
 
    std::string setupKeyNameStd = std::string(setupKeyName->Data());
    segmentFilters->retrieveFromRootFile(setupKeyName);
 
    // if the m_twoHitFilterAdjustFunctions m_threeHitFilterAdjustFunctions are non empty filters will be altered
    if (m_twoHitFilterAdjustFunctions.size() > 0) {
      B2WARNING("The 2-hit filters will be altered from the default!");
      B2INFO("The following set of indizes and functions will be used to alter the 2-hit filters:");
      for (auto& entry : m_twoHitFilterAdjustFunctions) {
        B2INFO("index=" << std::get<0>(entry) << " function=" << std::get<1>(entry));
      }
      segmentFilters->modify2SPFilters(m_twoHitFilterAdjustFunctions);
    }
    if (m_threeHitFilterAdjustFunctions.size() > 0) {
      B2WARNING("The 3-hit filters will be altered from the default!");
      B2INFO("The following set of indizes and functions will be used to alter the 3-hit filters:");
      for (auto& entry : m_threeHitFilterAdjustFunctions) {
        B2INFO("index=" << std::get<0>(entry) << " function=" << std::get<1>(entry));
      }
      segmentFilters->modify3SPFilters(m_threeHitFilterAdjustFunctions);
    }
 
    // locks all functions that can modify the filters
    segmentFilters->lockFilters();
 
    B2DEBUG(29, "Retrieved map with name: " << setupKeyNameStd << " from rootfie.");
    filtersContainer.assignFilters(setupKeyNameStd, segmentFilters);
 
    rootFile.cd("..");
 
    setupKeyName->Clear();
 
    read_something = true;
  }
 
  if (!read_something) B2FATAL("SectorMapBootstrapModule: No setup was read from the root file! " <<
                                 "The requested setup name was: " << m_setupToRead);
 
  rootFile.Close();
 
  // delete the TString which was allocated by ROOT but not cleaned up
  if (setupKeyName != nullptr) {
    delete setupKeyName;
  }
 
}