SPTCRefereeModule.h

/**************************************************************************
 * 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.                  *
 **************************************************************************/
#pragma once
 
#include <framework/core/Module.h>
#include <framework/datastore/StoreArray.h>
 
#include <tracking/spacePointCreation/SpacePointTrackCand.h>
 
#include <string>
#include <vector>
 
namespace Belle2 {

  class SPTCRefereeModule : public Module {
 
  public:
    SPTCRefereeModule(); 
 
    void initialize() override; 
 
    void event() override; 
 
    void terminate() override; 
 
  protected:

    typedef std::tuple<std::vector<int>, std::vector<int>> CheckInfo;
 
    // ==================================================== PARAMETERS ============================================================

    std::string m_PARAMsptcName = "";

    std::string m_PARAMnewArrayName = "";

    std::string m_PARAMcurlingSuffix = "_curlParts";

    bool m_PARAMcheckSameSensor = true;

    bool m_PARAMcheckIfFitted = true;

    bool m_PARAMcheckMinDistance = true;

    bool m_PARAMcheckCurling = true;

    bool m_PARAMsplitCurlers = false;

    bool m_PARAMkeepOnlyFirstPart = false;

    bool m_PARAMuseMCInfo = true;

    bool m_PARAMkickSpacePoint = false;

    int m_PARAMminNumSpacePoints = 0;

    bool m_PARAMstoreNewArray = true;

    double m_PARAMminDistance = 0.;

    std::vector<double> m_PARAMsetOrigin = { 0., 0., 0. };
 
    // ======================================================= INTERNALLY USED MEMBERS =============================================

    B2Vector3F m_origin;

    std::string m_curlingArrayName;
 
    // ========================================== COUNTER VARIABLES ===============================================================

    unsigned int m_SameSensorCtr;

    unsigned int m_minDistanceCtr;

    unsigned int m_totalTrackCandCtr;

    unsigned int m_kickedSpacePointsCtr;

    unsigned int m_curlingTracksCtr;

    unsigned int m_regTrackStubsCtr;

    unsigned int m_allInwardsCtr;

    void initializeCounters()
    {
      m_SameSensorCtr = 0;
      m_minDistanceCtr = 0;
      m_totalTrackCandCtr = 0;
      m_kickedSpacePointsCtr = 0;
      m_curlingTracksCtr = 0;
      m_regTrackStubsCtr = 0;
      m_allInwardsCtr = 0;
    }
 
 
    // ========================================================== MODULE METHODS ==================================================

    static const std::vector<int> checkSameSensor(const Belle2::SpacePointTrackCand* trackCand);

    static const std::vector<int> checkMinDistance(const Belle2::SpacePointTrackCand* trackCand, double minDistance);

    const std::vector<int> checkCurling(Belle2::SpacePointTrackCand* trackCand, bool useMCInfo);

    const std::vector<bool> getDirectionsOfFlight(const std::vector<const Belle2::SpacePoint*>& spacePoints, bool useMCInfo);

    std::vector<Belle2::SpacePointTrackCand>
    splitTrackCand(const Belle2::SpacePointTrackCand* trackCand, const std::vector<int>& splitIndices, bool onlyFirstPart,
                   const CheckInfo& prevChecksInfo, bool removedHits);

    template <typename TrueHitType>
    bool getDirOfFlightTrueHit(const Belle2::SpacePoint* spacePoint, B2Vector3F origin);

    std::vector<bool> getDirsOfFlightSpacePoints(const std::vector<const Belle2::SpacePoint*>& spacePoints, B2Vector3F origin);

    bool getDirOfFlightPosMom(B2Vector3F position, B2Vector3F momentum, B2Vector3F origin);

    static void
    copyToNewStoreArray(const Belle2::SpacePointTrackCand* trackCand, Belle2::StoreArray<Belle2::SpacePointTrackCand> newStoreArray);

    void addToStoreArray(const Belle2::SpacePointTrackCand& trackCand, Belle2::StoreArray<Belle2::SpacePointTrackCand> storeArray,
                         const Belle2::SpacePointTrackCand* origTrackCand);

    static unsigned short int getCheckStatus(const Belle2::SpacePointTrackCand* trackCand);

    const std::vector<int> removeSpacePoints(Belle2::SpacePointTrackCand* trackCand, const std::vector<int>& indsToRemove);

    template<typename T>
    static bool vectorHasValueBetween(std::vector<T> V, std::pair<T, T> P)
    {
      return std::find_if(V.begin(), V.end(), [&P](const T & aValue) { return (aValue < P.second && aValue >= P.first);}) != V.end();
    }
 
  private:
    StoreArray<SpacePointTrackCand> m_inputSpacePointTrackCands; 
    StoreArray<SpacePointTrackCand> m_optionalOutputSpacePointTrackCands; 
    StoreArray<SpacePointTrackCand> m_curlingSpacePointTrackCands; 
  };

}