DLNeutrinoHierarchyAlgorithm.h

Go to the documentation of this file.

#ifndef LAR_DL_NEUTRINO_HIERARCHY_ALGORITHM_H
#define LAR_DL_NEUTRINO_HIERARCHY_ALGORITHM_H 1

#include "Pandora/Algorithm.h"

#include "larpandoracontent/LArHelpers/LArPfoHelper.h"
#include "larpandoracontent/LArObjects/LArThreeDSlidingFitResult.h"

#include "larpandoradlcontent/LArCheating/DLCheatHierarchyTool.h"
#include "larpandoradlcontent/LArThreeDReco/LArEventBuilding/DLLaterTierHierarchyTool.h"
#include "larpandoradlcontent/LArThreeDReco/LArEventBuilding/DLPrimaryHierarchyTool.h"
#include "larpandoradlcontent/LArThreeDReco/LArEventBuilding/LArHierarchyPfo.h"

using namespace lar_content;

namespace lar_dl_content
{

//------------------------------------------------------------------------------------------------------------------------------------------

class DLNeutrinoHierarchyAlgorithm : public pandora::Algorithm
{
public:
    DLNeutrinoHierarchyAlgorithm();

    ~DLNeutrinoHierarchyAlgorithm();

private:
    typedef std::map<const pandora::ParticleFlowObject *, const pandora::MCParticle *> PfoToMCParticleMap;
    typedef std::map<const pandora::ParticleFlowObject *, std::pair<const pandora::ParticleFlowObject *, int>> ChildToParentPfoMap;
    typedef std::vector<pandora::PfoVector> Hierarchy;

    pandora::StatusCode Run();

    bool GetNeutrinoPfo(const pandora::ParticleFlowObject *&pNeutrinoPfo) const;

    void FillTrackShowerVectors(const pandora::ParticleFlowObject *const pNeutrinoPfo, HierarchyPfoVector &trackPfos, HierarchyPfoVector &showerPfos) const;

    bool GetExtremalVerticesAndDirections(const pandora::ParticleFlowObject *const pNeutrinoPfo, const pandora::ParticleFlowObject *const pPfo,
        const ThreeDSlidingFitResult &slidingFitResult, ExtremalPoint &upstreamPoint, ExtremalPoint &downstreamPoint) const;

    bool GetShowerDirection(
        const pandora::ParticleFlowObject *const pPfo, const pandora::CartesianVector &vertex, pandora::CartesianVector &direction) const;

    void SetPrimaryScores(const pandora::ParticleFlowObject *const pNeutrinoPfo, HierarchyPfoVector &trackPfos, HierarchyPfoVector &showerPfos) const;

    float GetPrimaryScore(
        const pandora::ParticleFlowObject *const pNeutrinoPfo, const HierarchyPfoVector &trackPfos, const HierarchyPfo &hierarchyPfo) const;

    void UpdateHierarchy(const pandora::ParticleFlowObject *const pNeutrinoPfo, const bool buildPrimaryTier, const bool usePrimaryScore,
        const float trackThreshold, const float showerThreshold, const bool isLowerThreshold, HierarchyPfoVector &trackPfos,
        HierarchyPfoVector &showerPfos, Hierarchy &hierarchy) const;

    void SetLaterTierScores(const pandora::ParticleFlowObject *const pNeutrinoPfo, HierarchyPfoVector &trackPfos, HierarchyPfoVector &showerPfos) const;

    float GetLaterTierScore(const pandora::ParticleFlowObject *const pNeutrinoPfo, const HierarchyPfo &parentPfo, const HierarchyPfo &childPfo) const;

    void BuildPandoraHierarchy(const pandora::ParticleFlowObject *const pNeutrinoPfo, const HierarchyPfoVector &trackPfos,
        const HierarchyPfoVector &showerPfos) const;

    //------------------------------------------------------------------------------------------------------------------------------------------
    // Training functions
    //------------------------------------------------------------------------------------------------------------------------------------------

    bool ShouldTrainOnEvent(const pandora::ParticleFlowObject *const pNeutrinoPfo) const;

    void GetParticleIDMap(const HierarchyPfoVector &trackPfos, const HierarchyPfoVector &showerPfos,
        std::map<const pandora::ParticleFlowObject *, int> &particleIDMap) const;

    std::pair<float, float> GetTrainingCuts(const HierarchyPfo &parentHierarchyPfo, const HierarchyPfo &childHierarchyPfo,
        const bool trueParentOrientation, const bool trueChildOrientation) const;

    void FillEventTree(const HierarchyPfoVector &trackPfos, const HierarchyPfoVector &showerPfos, const int nPrimaryTrackLinks,
        const int nPrimaryShowerLinks, const int nLaterTierTrackTrackLinks, const int nLaterTierTrackShowerLinks) const;

    void FillPrimaryTrees(const PfoToMCParticleMap &matchingMap, const ChildToParentPfoMap &childToParentPfoMap,
        const pandora::ParticleFlowObject *const pNeutrinoPfo, const HierarchyPfoVector &trackPfos, const HierarchyPfoVector &showerPfos,
        const std::map<const pandora::ParticleFlowObject *, int> &particleIDMap, int &nPrimaryTrackLinks, int &nPrimaryShowerLinks) const;

    void FillPrimaryTree(const std::string &treeName, const bool isTrainingLink, const bool isTrueLink, const bool isOrientationCorrect,
        const int trueVisibleGen, const int truePDG, const int trueParentID, const int particleID,
        const DLPrimaryHierarchyTool::DLPrimaryNetworkParams &primaryNetworkParams) const;

    void FillLaterTierTrees(const PfoToMCParticleMap &matchingMap, const ChildToParentPfoMap &childToParentPfoMap,
        const pandora::ParticleFlowObject *const pNeutrinoPfo, const HierarchyPfoVector &trackPfos, const HierarchyPfoVector &showerPfos,
        const std::map<const pandora::ParticleFlowObject *, int> &particleIDMap, int &nTrackLinks, int &nShowerLinks) const;

    void FillLaterTierTree(const std::string &treeName, const bool isTrainingLink, const bool isTrueLink, const bool isOrientationCorrect,
        const int childTrueGen, const std::pair<float, float> &trainingCuts, const int parentID, const int childID,
        const DLLaterTierHierarchyTool::DLLaterTierNetworkParams &networkParams) const;

    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

    int m_eventID;                                      
    bool m_trainingMode;                                
    std::string m_trainingFileName;                     
    std::string m_eventTreeName;                        
    std::string m_primaryTrackTreeName;                 
    std::string m_primaryShowerTreeName;                
    std::string m_laterTierTrackTrackTreeName;          
    std::string m_laterTierTrackShowerTreeName;         
    std::string m_mcParticleListName;                   
    float m_trainingVertexAccuracy;                     
    std::string m_neutrinoPfoListName;                  
    pandora::StringVector m_pfoListNames;               
    unsigned int m_minClusterSize;                      
    int m_slidingFitWindow;                             
    float m_regionForDirFit;                            
    int m_nAngularBins;                                 
    float m_primaryRegion;                              
    float m_primaryThresholdTrackPass1;                 
    float m_primaryThresholdShowerPass1;                
    float m_laterTierThresholdTrackPass1;               
    float m_laterTierThresholdShowerPass1;              
    float m_primaryThresholdTrackPass2;                 
    float m_primaryThresholdShowerPass2;                
    float m_laterTierThresholdTrackPass2;               
    float m_laterTierThresholdShowerPass2;              
    DLPrimaryHierarchyTool *m_primaryHierarchyTool;     
    DLLaterTierHierarchyTool *m_laterTierHierarchyTool; 
    DLCheatHierarchyTool *m_cheatHierarchyTool;         
};

} // namespace lar_dl_content

#endif // #ifndef LAR_DL_NEUTRINO_HIERARCHY_ALGORITHM_H