NViewDeltaRayMatchingAlgorithm.h

Go to the documentation of this file.

#ifndef LAR_N_VIEW_DELTA_RAY_MATCHING_ALGORITHM_H
#define LAR_N_VIEW_DELTA_RAY_MATCHING_ALGORITHM_H 1

#include "larpandoracontent/LArThreeDReco/LArThreeDBase/NViewMatchingAlgorithm.h"

#include "larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayMatchingContainers.h"

#include "larpandoracontent/LArUtility/KDTreeLinkerAlgoT.h"

namespace lar_content
{
template <typename T>
class NViewDeltaRayMatchingAlgorithm : public NViewMatchingAlgorithm<T>
{
public:
    typedef std::map<const pandora::CaloHit *, const pandora::Cluster *> HitToClusterMap;
    typedef std::map<const pandora::Cluster *, const pandora::ParticleFlowObject *> ClusterToPfoMap;
    typedef std::map<const pandora::Cluster *, pandora::ClusterList> ClusterProximityMap;

    typedef KDTreeLinkerAlgo<const pandora::CaloHit *, 2> HitKDTree2D;
    typedef KDTreeNodeInfoT<const pandora::CaloHit *, 2> HitKDNode2D;
    typedef std::vector<HitKDNode2D> HitKDNode2DList;

    typedef std::vector<pandora::HitType> HitTypeVector;

    NViewDeltaRayMatchingAlgorithm();

    pandora::StatusCode GetMuonCluster(
        const pandora::PfoList &commonMuonPfoList, const pandora::HitType hitType, const pandora::Cluster *&pMuonCluster) const;

    pandora::StatusCode PerformThreeViewMatching(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
        const pandora::Cluster *const pCluster3, float &reducedChiSquared) const;

    pandora::StatusCode PerformThreeViewMatching(const pandora::Cluster *const pClusterU, const pandora::Cluster *const pClusterV,
        const pandora::Cluster *const pClusterW, float &chiSquaredSum, unsigned int &nSamplingPoints, unsigned int &nMatchedSamplingPoints,
        XOverlap &XOverlap) const;

    pandora::StatusCode PerformThreeViewMatching(const pandora::CaloHitList &pCluster1, const pandora::CaloHitList &pCluster2,
        const pandora::CaloHitList &pCluster3, float &reducedChiSquared) const;

    pandora::StatusCode PerformThreeViewMatching(const pandora::CaloHitList &clusterU, const pandora::CaloHitList &clusterV,
        const pandora::CaloHitList &clusterW, float &chiSquaredSum, unsigned int &nSamplingPoints, unsigned int &nMatchedSamplingPoints,
        XOverlap &XOverlap) const;

    pandora::StatusCode ProjectMuonPositions(const pandora::HitType &thirdViewHitType, const pandora::ParticleFlowObject *const pParentMuon,
        pandora::CartesianPointVector &projectedPositions) const;

    pandora::StatusCode GetProjectedPositions(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
        pandora::CartesianPointVector &projectedPositions) const;

    pandora::StatusCode CollectHitsFromMuon(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
        const pandora::Cluster *const pThirdViewCluster, const pandora::ParticleFlowObject *const pParentMuon,
        const float minDistanceFromMuon, const float maxDistanceToCollected, pandora::CaloHitList &collectedHits) const;

    void CollectHitsFromMuon(const pandora::CartesianVector &positionOnMuon, const pandora::CartesianVector &muonDirection,
        const pandora::Cluster *const pMuonCluster, const pandora::CartesianPointVector &deltaRayProjectedPositions,
        const float &minDistanceFromMuon, const float maxDistanceToCollected, pandora::CaloHitList &collectedHits) const;

    pandora::StatusCode ParameteriseMuon(const pandora::ParticleFlowObject *const pParentMuon, const pandora::Cluster *const pDeltaRayCluster,
        pandora::CartesianVector &positionOnMuon, pandora::CartesianVector &muonDirection) const;

    pandora::StatusCode ParameteriseMuon(const pandora::ParticleFlowObject *const pParentMuon, const pandora::CartesianPointVector &deltaRayProjectedPositions,
        const pandora::HitType hitType, pandora::CartesianVector &positionOnMuon, pandora::CartesianVector &muonDirection) const;

    void SplitMuonCluster(const std::string &clusterListName, const pandora::Cluster *const pMuonCluster,
        const pandora::CaloHitList &collectedHits, const pandora::Cluster *&pDeltaRayCluster) const;

    bool CreatePfos(ProtoParticleVector &protoParticleVector);

    void UpdateForNewClusters(const pandora::ClusterVector &newClusterVector, const pandora::PfoVector &pfoVector);

    void UpdateUponDeletion(const pandora::Cluster *const pDeletedCluster);
    void SelectInputClusters(const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const;
    void PrepareInputClusters(pandora::ClusterList &preparedClusterList);

protected:
    virtual bool DoesClusterPassTensorThreshold(const pandora::Cluster *const pCluster) const = 0;

    void FillStrayClusterList(const pandora::HitType hitType);

    void GetNearbyMuonPfos(const pandora::Cluster *const pCluster, pandora::ClusterList &consideredClusters, pandora::PfoList &nearbyMuonPfos) const;

    void GetClusterSpanX(const pandora::CaloHitList &caloHitList, float &xMin, float &xMax) const;

    pandora::StatusCode GetClusterSpanZ(const pandora::CaloHitList &caloHitList, const float xMin, const float xMax, float &zMin, float &zMax) const;

    void CollectStrayClusters(const pandora::Cluster *const pClusterToEnlarge, const float rangeMinX, const float rangeMaxX,
        pandora::ClusterList &collectedClusters);

    void AddInStrayClusters(const pandora::Cluster *const pClusterToEnlarge, const pandora::ClusterList &collectedClusters);

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

    std::string m_muonPfoListName;                           
    pandora::ClusterList m_strayClusterListU;                
    pandora::ClusterList m_strayClusterListV;                
    pandora::ClusterList m_strayClusterListW;                
    DeltaRayMatchingContainers m_deltaRayMatchingContainers; 
    float m_pseudoChi2Cut;                                   
    float m_xOverlapWindow;                                  
    float m_minMatchedFraction;                              
    unsigned int m_minMatchedPoints;                         
    unsigned int m_minProjectedPositions;                    
    float m_maxCosmicRayHitFraction; 
    float m_maxDistanceToCluster; 
    float m_maxDistanceToReferencePoint; 
    float m_strayClusterSeparation; 
};

} // namespace lar_content

#endif // #ifndef LAR_N_VIEW_DELTA_RAY_MATCHING_ALGORITHM_H