MatchingBaseAlgorithm.h

Go to the documentation of this file.

#ifndef LAR_MATCHING_BASE_ALGORITHM_H
#define LAR_MATCHING_BASE_ALGORITHM_H 1

#include "Api/PandoraContentApi.h"

#include "Pandora/Algorithm.h"

#include <unordered_map>
#include <vector>

namespace lar_content
{

class ProtoParticle
{
public:
    pandora::ClusterList m_clusterList; 
};

typedef std::vector<ProtoParticle> ProtoParticleVector;
typedef std::unordered_map<const pandora::Cluster *, pandora::ClusterList> ClusterMergeMap;

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

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

    virtual ~MatchingBaseAlgorithm();

    virtual void UpdateForNewCluster(const pandora::Cluster *const pNewCluster) = 0;

    virtual void UpdateUponDeletion(const pandora::Cluster *const pDeletedCluster) = 0;

    virtual const std::string &GetClusterListName(const pandora::HitType hitType) const = 0;

    virtual const pandora::ClusterList &GetInputClusterList(const pandora::HitType hitType) const = 0;

    virtual const pandora::ClusterList &GetSelectedClusterList(const pandora::HitType hitType) const = 0;

    virtual void CalculateOverlapResult(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
        const pandora::Cluster *const pCluster3 = nullptr) = 0;

    virtual void SelectInputClusters(const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const;

    virtual void PrepareInputClusters(pandora::ClusterList &preparedClusterList);

    virtual bool MakeClusterMerges(const ClusterMergeMap &clusterMergeMap);

    virtual bool CreateThreeDParticles(const ProtoParticleVector &protoParticleVector);

    virtual void SetPfoParameters(const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const;

    virtual void SetPfoParticleId(PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const;

protected:
    virtual void SelectAllInputClusters() = 0;

    virtual void PrepareAllInputClusters() = 0;

    virtual void PerformMainLoop() = 0;

    virtual void ExamineOverlapContainer() = 0;

    virtual void TidyUp() = 0;

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

private:
    pandora::StatusCode Run();

    std::string m_outputPfoListName; 
};

} // namespace lar_content

#endif // #ifndef LAR_MATCHING_BASE_ALGORITHM_H