MainFragmentRemovalAlgorithm.h

Go to the documentation of this file.

#ifndef APRIL_MAIN_FRAGMENT_REMOVAL_ALGORITHM_H
#define APRIL_MAIN_FRAGMENT_REMOVAL_ALGORITHM_H 1

#include "Pandora/Algorithm.h"

#include "APRILHelpers/FragmentRemovalHelper.h"

#include <map>

namespace april_content
{

class ChargedClusterContact : public ClusterContact
{
public:
    class Parameters : public ClusterContact::Parameters
    {
    public:
        float           m_coneCosineHalfAngle2;         
        float           m_coneCosineHalfAngle3;         
        float           m_helixComparisonMipFractionCut;
        unsigned int    m_helixComparisonStartOffset;   
        unsigned int    m_helixComparisonStartOffsetMip;
        unsigned int    m_nHelixComparisonLayers;       
        unsigned int    m_maxLayersCrossedByHelix;      
        float           m_maxTrackClusterDeltaZ;        
    };

    ChargedClusterContact(const pandora::Pandora &pandora, const pandora::Cluster *const pDaughterCluster,
        const pandora::Cluster *const pParentCluster, const Parameters &parameters);

    float GetParentTrackEnergy() const;

    float GetConeFraction2() const;

    float GetConeFraction3() const;

    float GetMeanDistanceToHelix() const;

    float GetClosestDistanceToHelix() const;

private:
    void ClusterHelixComparison(const pandora::Pandora &pandora, const pandora::Cluster *const pDaughterCluster,
        const pandora::Cluster *const pParentCluster, const Parameters &parameters);

    float               m_parentTrackEnergy;            
    float               m_coneFraction2;                
    float               m_coneFraction3;                
    float               m_meanDistanceToHelix;          
    float               m_closestDistanceToHelix;       
};

typedef std::vector<ChargedClusterContact> ChargedClusterContactVector;
typedef std::map<const pandora::Cluster *, ChargedClusterContactVector> ChargedClusterContactMap;

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

class MainFragmentRemovalAlgorithm : public pandora::Algorithm
{
public:
    class Factory : public pandora::AlgorithmFactory
    {
    public:
        pandora::Algorithm *CreateAlgorithm() const;
    };

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

    pandora::StatusCode GetChargedClusterContactMap(bool &isFirstPass, const pandora::ClusterSet &affectedClusters,
        ChargedClusterContactMap &chargedClusterContactMap) const;

    bool PassesClusterContactCuts(const ChargedClusterContact &chargedClusterContact) const;

    pandora::StatusCode GetClusterMergingCandidates(const ChargedClusterContactMap &chargedClusterContactMap, const pandora::Cluster *&pBestParentCluster,
        const pandora::Cluster *&pBestDaughterCluster);

    bool PassesPreselection(const pandora::Cluster *const pDaughterCluster, const ChargedClusterContactVector &chargedClusterContactVector,
        float &globalDeltaChi2) const;

    float GetTotalEvidenceForMerge(const ChargedClusterContact &chargedClusterContact) const;

    float GetRequiredEvidenceForMerge(const pandora::Cluster *const pDaughterCluster, const ChargedClusterContact &chargedClusterContact,
        const unsigned int correctionLayer, const float globalDeltaChi2);

    unsigned int GetClusterCorrectionLayer(const pandora::Cluster *const pDaughterCluster) const;

    pandora::StatusCode GetAffectedClusters(const ChargedClusterContactMap &chargedClusterContactMap, const pandora::Cluster *const pBestParentCluster,
        const pandora::Cluster *const pBestDaughterCluster, pandora::ClusterSet &affectedClusters) const;

    typedef ChargedClusterContact::Parameters ContactParameters;
    ContactParameters   m_contactParameters;                        

    unsigned int        m_minDaughterCaloHits;                      
    float               m_minDaughterHadronicEnergy;                

    float               m_contactCutMaxDistance;                    
    unsigned int        m_contactCutNLayers;                        
    float               m_contactCutConeFraction1;                  
    float               m_contactCutCloseHitFraction1;              
    float               m_contactCutCloseHitFraction2;              
    float               m_contactCutMeanDistanceToHelix;            
    float               m_contactCutClosestDistanceToHelix;         
    float               m_contactCutMaxHitDistance;                 
    unsigned int        m_contactCutMinDaughterInnerLayer;          

    float               m_maxChi2;                                  
    float               m_maxGlobalChi2;                            
    float               m_chi2Base;                                 
    float               m_globalChi2Penalty;                        

    unsigned int        m_correctionLayerNHitLayers;                
    float               m_correctionLayerEnergyFraction;            

    unsigned int        m_contactEvidenceNLayers1;                  
    unsigned int        m_contactEvidenceNLayers2;                  
    unsigned int        m_contactEvidenceNLayers3;                  
    float               m_contactEvidence1;                         
    float               m_contactEvidence2;                         
    float               m_contactEvidence3;                         

    float               m_coneEvidenceFraction1;                    
    float               m_coneEvidenceFineGranularityMultiplier;    

    float               m_closestTrackEvidence1;                    
    float               m_closestTrackEvidence1d;                   
    float               m_closestTrackEvidence2;                    
    float               m_closestTrackEvidence2d;                   
    float               m_meanTrackEvidence1;                       
    float               m_meanTrackEvidence1d;                      
    float               m_meanTrackEvidence2;                       
    float               m_meanTrackEvidence2d;                      

    float               m_distanceEvidence1;                        
    float               m_distanceEvidence1d;                       
    float               m_distanceEvidenceCloseFraction1Multiplier; 
    float               m_distanceEvidenceCloseFraction2Multiplier; 

    float               m_contactWeight;                            
    float               m_coneWeight;                               
    float               m_distanceWeight;                           
    float               m_trackExtrapolationWeight;                 

    unsigned int        m_layerCorrectionLayerValue1;               
    unsigned int        m_layerCorrectionLayerValue2;               
    unsigned int        m_layerCorrectionLayerValue3;               
    float               m_layerCorrection1;                         
    float               m_layerCorrection2;                         
    float               m_layerCorrection3;                         
    float               m_layerCorrection4;                         

    float               m_layerCorrectionLayerSpan;                 
    float               m_layerCorrectionMinInnerLayer;             
    float               m_layerCorrection5;                         

    float               m_leavingCorrection;                        

    float               m_energyCorrectionThreshold;                

    float               m_lowEnergyCorrectionThreshold;             
    unsigned int        m_lowEnergyCorrectionNHitLayers1;           
    unsigned int        m_lowEnergyCorrectionNHitLayers2;           
    unsigned int        m_lowEnergyCorrectionNHitLayers3;           
    float               m_lowEnergyCorrection1;                     
    float               m_lowEnergyCorrection2;                     
    float               m_lowEnergyCorrection3;                     

    float               m_angularCorrectionOffset;                  
    float               m_angularCorrectionConstant;                
    float               m_angularCorrectionGradient;                

    float               m_photonCorrectionEnergy1;                  
    float               m_photonCorrectionEnergy2;                  
    float               m_photonCorrectionEnergy3;                  
    float               m_photonCorrectionShowerStart1;             
    float               m_photonCorrectionShowerStart2;             
    float               m_photonCorrectionShowerDiscrepancy1;       
    float               m_photonCorrectionShowerDiscrepancy2;       
    float               m_photonCorrection1;                        
    float               m_photonCorrection2;                        
    float               m_photonCorrection3;                        
    float               m_photonCorrection4;                        
    float               m_photonCorrection5;                        
    float               m_photonCorrection6;                        
    float               m_photonCorrection7;                        

    float               m_minRequiredEvidence;                      
};

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

inline float ChargedClusterContact::GetParentTrackEnergy() const
{
    return m_parentTrackEnergy;
}

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

inline float ChargedClusterContact::GetConeFraction2() const
{
    return m_coneFraction2;
}

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

inline float ChargedClusterContact::GetConeFraction3() const
{
    return m_coneFraction3;
}

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

inline float ChargedClusterContact::GetMeanDistanceToHelix() const
{
    return m_meanDistanceToHelix;
}

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

inline float ChargedClusterContact::GetClosestDistanceToHelix() const
{
    return m_closestDistanceToHelix;
}

inline pandora::Algorithm *MainFragmentRemovalAlgorithm::Factory::CreateAlgorithm() const
{
    return new MainFragmentRemovalAlgorithm();
}

} 

#endif