LArClusterHelper.h

Go to the documentation of this file.

#ifndef LAR_CLUSTER_HELPER_H
#define LAR_CLUSTER_HELPER_H 1

#include "Objects/Cluster.h"

namespace lar_content
{

class LArClusterHelper
{
public:
    typedef std::set<unsigned int> UIntSet;

    static void GetAllHits(const pandora::Cluster *const pCluster, pandora::CaloHitList &caloHitList);

    static pandora::HitType GetClusterHitType(const pandora::Cluster *const pCluster);

    static void GetClustersUVW(const pandora::ClusterList &inputClusters, pandora::ClusterList &clusterListU,
        pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW);

    static void GetClustersByHitType(const pandora::ClusterList &inputClusters, const pandora::HitType hitType, pandora::ClusterList &clusterList);

    static float GetLengthSquared(const pandora::Cluster *const pCluster);

    static float GetLength(const pandora::Cluster *const pCluster);

    static float GetEnergyFromLength(const pandora::Cluster *const pCluster);

    static unsigned int GetLayerSpan(const pandora::Cluster *const pCluster);

    static float GetLayerOccupancy(const pandora::Cluster *const pCluster);

    static float GetLayerOccupancy(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2);

    static float GetClosestDistance(const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2);

    static float GetClosestDistance(const pandora::Cluster *const pCluster, const pandora::ClusterList &clusterList);

    static float GetClosestDistance(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2);

    static float GetClosestDistance(const pandora::CartesianVector &position, const pandora::ClusterList &clusterList);

    static float GetClosestDistance(const pandora::CartesianVector &position, const pandora::Cluster *const pCluster);

    static float GetClosestDistance(const pandora::CartesianVector &position, const pandora::CaloHitList &caloHitList);

    static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::ClusterList &clusterList);

    static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::Cluster *const pCluster);

    static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::CaloHitList &caloHitList);

    static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::OrderedCaloHitList &caloHitList);

    static void GetClosestPositions(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
        pandora::CartesianVector &position1, pandora::CartesianVector &position2);

    static void GetExtremalCoordinates(
        const pandora::ClusterList &clusterList, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate);

    static void GetExtremalCoordinates(
        const pandora::Cluster *const pCluster, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate);

    static void GetExtremalCoordinates(const pandora::OrderedCaloHitList &orderedCaloHitList, pandora::CartesianVector &innerCoordinate,
        pandora::CartesianVector &outerCoordinate);

    static void GetExtremalCoordinates(const pandora::CartesianPointVector &coordinateVector, pandora::CartesianVector &innerCoordinate,
        pandora::CartesianVector &outerCoordinate);

    static void GetClusterBoundingBox(
        const pandora::Cluster *const pCluster, pandora::CartesianVector &minimumCoordinate, pandora::CartesianVector &maximumCoordinate);

    static void GetCoordinateVector(const pandora::Cluster *const pCluster, pandora::CartesianPointVector &coordinateVector);

    static void GetCaloHitListInBoundingBox(const pandora::Cluster *const pCluster, const pandora::CartesianVector &lowerBound,
        const pandora::CartesianVector &upperBound, pandora::CaloHitList &caloHitList);

    static void GetDaughterVolumeIDs(const pandora::Cluster *const pCluster, UIntSet &daughterVolumeIds);

    static pandora::StatusCode GetAverageZ(const pandora::Cluster *const pCluster, const float xmin, const float xmax, float &averageZ);

    static bool SortByNOccupiedLayers(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);

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

    static bool SortByLayerSpan(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);

    static bool SortByInnerLayer(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);

    static bool SortByPosition(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);

    static bool SortByPulseHeight(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);

    static bool SortHitsByPosition(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs);

    static bool SortHitsByPositionInX(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs);

    static bool SortHitsByPulseHeight(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs);

    static bool SortCoordinatesByPosition(const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs);
};

} // namespace lar_content

#endif // #ifndef LAR_CLUSTER_HELPER_H