NeutrinoIdTool.h

Go to the documentation of this file.

#ifndef LAR_NEUTRINO_ID_TOOL_H
#define LAR_NEUTRINO_ID_TOOL_H 1

#include "larpandoracontent/LArControlFlow/MasterAlgorithm.h"
#include "larpandoracontent/LArControlFlow/SliceIdBaseTool.h"

#include "larpandoracontent/LArObjects/LArAdaBoostDecisionTree.h"
#include "larpandoracontent/LArObjects/LArSupportVectorMachine.h"

#include <functional>

namespace lar_content
{

template <typename T>
class NeutrinoIdTool : public SliceIdBaseTool
{
public:
    NeutrinoIdTool();

    void SelectOutputPfos(const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses,
        const SliceHypotheses &crSliceHypotheses, pandora::PfoList &selectedPfos);

private:
    class SliceFeatures
    {
    public:
        SliceFeatures(const pandora::PfoList &nuPfos, const pandora::PfoList &crPfos, const NeutrinoIdTool *const pTool);

        bool IsFeatureVectorAvailable() const;

        void GetFeatureVector(LArMvaHelper::MvaFeatureVector &featureVector) const;

        void GetFeatureMap(LArMvaHelper::DoubleMap &featureMap) const;

        float GetNeutrinoProbability(const T &t, const float defaultProbability) const;

    private:
        const pandora::ParticleFlowObject *GetNeutrino(const pandora::PfoList &nuPfos) const;

        void GetSpacePoints(const pandora::ParticleFlowObject *const pPfo, pandora::CartesianPointVector &spacePoints) const;

        pandora::CartesianVector GetDirection(const pandora::CartesianPointVector &spacePoints,
            std::function<bool(const pandora::CartesianVector &pointA, const pandora::CartesianVector &pointB)> fShouldChooseA) const;

        pandora::CartesianVector GetDirectionFromVertex(const pandora::CartesianPointVector &spacePoints, const pandora::CartesianVector &vertex) const;

        pandora::CartesianVector GetUpperDirection(const pandora::CartesianPointVector &spacePoints) const;

        pandora::CartesianVector GetLowerDirection(const pandora::CartesianPointVector &spacePoints) const;

        void GetPointsInSphere(const pandora::CartesianPointVector &spacePoints, const pandora::CartesianVector &vertex, const float radius,
            pandora::CartesianPointVector &spacePointsInSphere) const;

        bool m_isAvailable;                             
        LArMvaHelper::MvaFeatureVector m_featureVector; 
        LArMvaHelper::DoubleMap m_featureMap;           
        const NeutrinoIdTool *const m_pTool;            
    };

    typedef std::pair<unsigned int, float> UintFloatPair;
    typedef std::vector<SliceFeatures> SliceFeaturesVector;

    void GetSliceFeatures(const NeutrinoIdTool *const pTool, const SliceHypotheses &nuSliceHypotheses,
        const SliceHypotheses &crSliceHypotheses, SliceFeaturesVector &sliceFeaturesVector) const;

    bool GetBestMCSliceIndex(const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses,
        const SliceHypotheses &crSliceHypotheses, unsigned int &bestSliceIndex) const;

    bool PassesQualityCuts(const pandora::Algorithm *const pAlgorithm, const float purity, const float completeness) const;

    void Collect2DHits(const pandora::PfoList &pfos, pandora::CaloHitList &reconstructedCaloHitList,
        const pandora::CaloHitSet &reconstructableCaloHitSet) const;

    unsigned int CountNeutrinoInducedHits(const pandora::CaloHitList &caloHitList) const;

    int GetNuanceCode(const pandora::Algorithm *const pAlgorithm) const;

    void SelectAllPfos(const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &hypotheses, pandora::PfoList &selectedPfos) const;

    void SelectPfosByProbability(const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &nuSliceHypotheses,
        const SliceHypotheses &crSliceHypotheses, const SliceFeaturesVector &sliceFeaturesVector, pandora::PfoList &selectedPfos) const;

    void SelectPfos(const pandora::PfoList &pfos, pandora::PfoList &selectedPfos) const;

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

    // Training
    bool m_useTrainingMode;           
    std::string m_trainingOutputFile; 
    bool m_selectNuanceCode;          
    int m_nuance;                     
    float m_minPurity;                
    float m_minCompleteness;          

    // Classification
    float m_minProbability;      
    float m_defaultProbability;  
    unsigned int m_maxNeutrinos; 

    bool m_persistFeatures; 

    T m_mva;                                   
    std::string m_filePathEnvironmentVariable; 
};

typedef NeutrinoIdTool<AdaBoostDecisionTree> BdtNeutrinoIdTool;
typedef NeutrinoIdTool<SupportVectorMachine> SvmNeutrinoIdTool;

} // namespace lar_content

#endif // #ifndef LAR_NEUTRINO_ID_TOOL_H