DLPrimaryHierarchyTool.h

Go to the documentation of this file.

#ifndef LAR_DL_PRIMARY_HIERARCHY_TOOL_H
#define LAR_DL_PRIMARY_HIERARCHY_TOOL_H 1

#include "Pandora/PandoraInternal.h"

#include "larpandoradlcontent/LArHelpers/LArDLHelper.h"
#include "larpandoradlcontent/LArThreeDReco/LArEventBuilding/DLBaseHierarchyTool.h"
#include "larpandoradlcontent/LArThreeDReco/LArEventBuilding/LArHierarchyPfo.h"

namespace lar_dl_content
{
class DLPrimaryHierarchyTool : public DLBaseHierarchyTool
{
public:
    struct DLPrimaryNetworkParams // all floats because they'll be normalised
    {
        float m_nSpacepoints = -999.f;             
        float m_nuSeparation = -999.f;             
        float m_vertexRegionNHits = -999.f;        
        float m_vertexRegionNParticles = -999.f;   
        float m_dca = -999.f;                      
        float m_connectionExtrapDistance = -999.f; 
        float m_isPOIClosestToNu = -999.f;         
        float m_parentConnectionDistance = -999.f; 
        float m_childConnectionDistance = -999.f;  

        void AddCommonParamsToInput(int &insertIndex, LArDLHelper::TorchInput &modelInput) const;

        void AddOrientationParamsToInput(int &insertIndex, LArDLHelper::TorchInput &modelInput) const;
    };

    struct NormalisationLimits
    {
        float m_nSpacepointsMin = 0.f;                
        float m_nSpacepointsMax = 2000.f;             
        float m_nuSeparationMin = -50.f;              
        float m_nuSeparationMax = 500.f;              
        float m_vertexRegionNHitsMin = -10.f;         
        float m_vertexRegionNHitsMax = 100.f;         
        float m_vertexRegionNParticlesMin = -1.f;     
        float m_vertexRegionNParticlesMax = 8.f;      
        float m_dcaMin = -60.f;                       
        float m_dcaMax = 600.f;                       
        float m_connectionExtrapDistanceMin = -700.f; 
        float m_connectionExtrapDistanceMax = 500.f;  
        float m_parentConnectionDistanceMin = -150.f; 
        float m_parentConnectionDistanceMax = 150.f;  
        float m_childConnectionDistanceMin = -30.f;   
        float m_childConnectionDistanceMax = 300.f;   
    };

    pandora::StatusCode Run(const pandora::Algorithm *const pAlgorithm, const pandora::ParticleFlowObject *const pNeutrinoPfo,
        const HierarchyPfoVector &trackPfos, const HierarchyPfo &hierarchyPfo, std::vector<DLPrimaryNetworkParams> &networkParamVector,
        float &primaryScore);

    DLPrimaryHierarchyTool();

    void CalculateConnectionDistances(const ExtremalPoint &parentPoint, const ExtremalPoint &childPoint, float &parentConnectionDistance,
        float &childConnectionDistance) const;

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

    pandora::StatusCode CalculateNetworkVariables(const pandora::Algorithm *const pAlgorithm, const HierarchyPfo &hierarchyPfo,
        const pandora::ParticleFlowObject *const pNeutrinoPfo, const HierarchyPfoVector &trackPfos, const bool useUpstream,
        DLPrimaryNetworkParams &primaryNetworkParams) const;

    void SetVertexRegionParams(const pandora::Algorithm *const pAlgorithm, const pandora::ParticleFlowObject *const pPfo,
        const pandora::CartesianVector &particleVertex, DLPrimaryNetworkParams &primaryNetworkParams) const;

    void SetConnectionParams(
        const ExtremalPoint &particlePoint, const pandora::CartesianVector &nuVertex, DLPrimaryNetworkParams &primaryNetworkParams) const;

    void SetContextParams(const pandora::ParticleFlowObject *const pPfo, const ExtremalPoint &particlePoint,
        const pandora::CartesianVector &nuVertex, const HierarchyPfoVector &trackPfos, DLPrimaryNetworkParams &primaryNetworkParams) const;

    void NormaliseNetworkParams(DLPrimaryNetworkParams &primaryNetworkParams) const;

    float ClassifyTrack(const DLPrimaryNetworkParams &edgeParamsUp, const DLPrimaryNetworkParams &edgeParamsDown);

    pandora::FloatVector ClassifyTrackEdge(const DLPrimaryNetworkParams &edgeParams, const DLPrimaryNetworkParams &otherEdgeParams);

    float ClassifyShower(const DLPrimaryNetworkParams &primaryNetworkParams);

    // For model
    bool m_trainingMode;                                    
    std::string m_primaryTrackBranchModelName;              
    std::string m_primaryTrackClassifierModelName;          
    std::string m_primaryShowerClassifierModelName;         
    LArDLHelper::TorchModel m_primaryTrackBranchModel;      
    LArDLHelper::TorchModel m_primaryTrackClassifierModel;  
    LArDLHelper::TorchModel m_primaryShowerClassifierModel; 
    // For tool
    float m_extrapolationStepSize; 
    // For normalisation
    bool m_normalise;                 
    NormalisationLimits m_normLimits; 
};

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

} // namespace lar_dl_content

#endif // #ifndef LAR_DL_PRIMARY_HIERARCHY_TOOL_H