LArPfoHelper.h

Go to the documentation of this file.

#ifndef LAR_PFO_HELPER_H
#define LAR_PFO_HELPER_H 1

#include "Objects/Cluster.h"
#include "Objects/ParticleFlowObject.h"
#include "Objects/Vertex.h"

#include "larpandoracontent/LArObjects/LArPfoObjects.h"

namespace lar_content
{

class LArPfoHelper
{
public:
    static void GetCoordinateVector(
        const pandora::ParticleFlowObject *const pPfo, const pandora::HitType &hitType, pandora::CartesianPointVector &coordinateVector);

    static void GetCaloHits(const pandora::PfoList &pfoList, const pandora::HitType &hitType, pandora::CaloHitList &caloHitList);

    static void GetCaloHits(const pandora::ParticleFlowObject *const pPfo, const pandora::HitType &hitType, pandora::CaloHitList &caloHitList);

    static void GetIsolatedCaloHits(const pandora::PfoList &pfoList, const pandora::HitType &hitType, pandora::CaloHitList &caloHitList);

    static void GetIsolatedCaloHits(const pandora::ParticleFlowObject *const pPfo, const pandora::HitType &hitType, pandora::CaloHitList &caloHitList);

    static void GetAllCaloHits(const pandora::ParticleFlowObject *pPfo, pandora::CaloHitList &caloHitList);

    static void GetClusters(const pandora::PfoList &pfoList, const pandora::HitType &hitType, pandora::ClusterList &clusterList);

    static void GetClusters(const pandora::ParticleFlowObject *const pPfo, const pandora::HitType &hitType, pandora::ClusterList &clusterList);

    static unsigned int GetNumberOfTwoDHits(const pandora::ParticleFlowObject *const pPfo);

    static unsigned int GetNumberOfThreeDHits(const pandora::ParticleFlowObject *const pPfo);

    static void GetTwoDClusterList(const pandora::ParticleFlowObject *const pPfo, pandora::ClusterList &clusterList);

    static void GetThreeDClusterList(const pandora::ParticleFlowObject *const pPfo, pandora::ClusterList &clusterList);

    static void GetAllConnectedPfos(const pandora::PfoList &inputPfoList, pandora::PfoList &outputPfoList);

    static void GetAllConnectedPfos(const pandora::ParticleFlowObject *const pPfo, pandora::PfoList &outputPfoList);

    static void GetAllDownstreamPfos(const pandora::PfoList &inputPfoList, pandora::PfoList &outputPfoList);

    static void GetAllDownstreamPfos(const pandora::ParticleFlowObject *const pPfo, pandora::PfoList &outputPfoList);

    static void GetAllDownstreamPfos(
        const pandora::ParticleFlowObject *const pPfo, pandora::PfoList &outputTrackPfoList, pandora::PfoList &outputLeadingShowerPfoList);

    static int GetHierarchyTier(const pandora::ParticleFlowObject *const pPfo);

    static float GetTwoDLengthSquared(const pandora::ParticleFlowObject *const pPfo);

    static float GetThreeDLengthSquared(const pandora::ParticleFlowObject *const pPfo);

    static float GetClosestDistance(const pandora::ParticleFlowObject *const pPfo, const pandora::Cluster *const pCluster);

    static float GetThreeDSeparation(const pandora::ParticleFlowObject *const pPfo1, const pandora::ParticleFlowObject *const pPfo2);

    static bool IsTwoD(const pandora::ParticleFlowObject *const pPfo);

    static bool IsThreeD(const pandora::ParticleFlowObject *const pPfo);

    static bool IsTrack(const pandora::ParticleFlowObject *const pPfo);

    static bool IsShower(const pandora::ParticleFlowObject *const pPfo);

    static float GetTrackScore(const pandora::ParticleFlowObject *const pPfo);

    static int GetPrimaryNeutrino(const pandora::ParticleFlowObject *const pPfo);

    static bool IsFinalState(const pandora::ParticleFlowObject *const pPfo);

    static bool IsNeutrinoFinalState(const pandora::ParticleFlowObject *const pPfo);

    static bool IsNeutrino(const pandora::ParticleFlowObject *const pPfo);

    static bool IsTestBeamFinalState(const pandora::ParticleFlowObject *const pPfo);

    static bool IsTestBeam(const pandora::ParticleFlowObject *const pPfo);

    static void GetRecoNeutrinos(const pandora::PfoList *const pPfoList, pandora::PfoList &recoNeutrinos);

    static const pandora::ParticleFlowObject *GetParentPfo(const pandora::ParticleFlowObject *const pPfo);

    static const pandora::ParticleFlowObject *GetParentNeutrino(const pandora::ParticleFlowObject *const pPfo);

    static const pandora::Vertex *GetVertex(const pandora::ParticleFlowObject *const pPfo);

    static const pandora::Vertex *GetTestBeamInteractionVertex(const pandora::ParticleFlowObject *const pPfo);

    static const pandora::Vertex *GetVertexWithLabel(const pandora::VertexList &vertexList, const pandora::VertexLabel vertexLabel);

    static void GetSlidingFitTrajectory(const pandora::CartesianPointVector &pointVector, const pandora::CartesianVector &vertexPosition,
        const unsigned int layerWindow, const float layerPitch, LArTrackStateVector &trackStateVector, pandora::IntVector *const pIndexVector = nullptr);

    static void GetSlidingFitTrajectory(const pandora::ParticleFlowObject *const pPfo, const pandora::Vertex *const pVertex,
        const unsigned int slidingFitHalfWindow, const float layerPitch, LArTrackStateVector &trackStateVector);

    static LArShowerPCA GetPrincipalComponents(const pandora::CartesianPointVector &pointVector, const pandora::CartesianVector &vertexPosition);

    static LArShowerPCA GetPrincipalComponents(const pandora::ParticleFlowObject *const pPfo, const pandora::Vertex *const pVertex);

    static bool SortByHitProjection(const LArTrackTrajectoryPoint &lhs, const LArTrackTrajectoryPoint &rhs);

    static bool SortByNHits(const pandora::ParticleFlowObject *const pLhs, const pandora::ParticleFlowObject *const pRhs);

    static void GetBreadthFirstHierarchyRepresentation(const pandora::ParticleFlowObject *const pPfo, pandora::PfoList &pfoList);

private:
    template <typename T>
    static void SlidingFitTrajectoryImpl(const T *const pT, const pandora::CartesianVector &vertexPosition, const unsigned int layerWindow,
        const float layerPitch, LArTrackStateVector &trackStateVector, pandora::IntVector *const pIndexVector = nullptr);
};

} // namespace lar_content

#endif // #ifndef LAR_PFO_HELPER_H