ClusterHelper.h

Go to the documentation of this file.

/*
 *
 * ClusterHelper.h header template automatically generated by a class generator
 * Creation date : ven. avr. 10 2015
 *
 * This file is part of APRILContent libraries.
 * 
 * APRILContent is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * based upon these libraries are permitted. Any copy of these libraries
 * must include this copyright notice.
 * 
 * APRILContent is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with APRILContent.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * @author Remi Ete
 * @copyright CNRS , IPNL
 */


#ifndef CLUSTERHELPER_H
#define CLUSTERHELPER_H

#include "Pandora/PandoraInternal.h"
#include "Pandora/PandoraInputTypes.h"
#include "APRILApi/APRILInputTypes.h"
#include "Helpers/ClusterFitHelper.h"

namespace april_content
{

class ClusterPca
{
public:
    ClusterPca(const pandora::Cluster *const pCluster);

    float GetEigenValue(int component) const;

    const pandora::CartesianVector &GetEigenVector(int component) const;

    float GetTransverseRatio() const;

    const pandora::Cluster *GetCluster() const;

private:
    struct Component
    {
        Component();

        float                         m_eigenValue;    
        pandora::CartesianVector      m_eigenVector;   
    };

    Component                   m_components[3];      
    float                       m_transverseRatio;    
    const pandora::Cluster     *m_pCluster;           
};

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

class ClusterHelper 
{
public:
    static pandora::StatusCode GetCentroid(const pandora::Cluster *const pCluster, pandora::CartesianVector &centroid);

    static pandora::StatusCode GetClosestDistanceApproach(const pandora::Cluster *const pCluster, const pandora::CartesianVector &point,
            float &closestDistance, bool onlyUseConnectedHit = true);
  
    static pandora::StatusCode GetClosestDistanceApproach(const pandora::CaloHitList& caloHitList, const pandora::CartesianVector &point,
      float &closestDistance, bool onlyUseConnectedHit = true);

    static pandora::StatusCode GetCentroidDistance(const pandora::Cluster *const pCluster, const pandora::CartesianVector &point,
            float &centroidDistance);
  
    static float GetHadronicEnergyInECAL(const pandora::Cluster *const pCluster);
    static float GetEnergyRatio(const pandora::OrderedCaloHitList& orderedCaloHitList);
    static pandora::StatusCode GetEnergyRatio(const pandora::OrderedCaloHitList& orderedCaloHitList, float& energyRatio, unsigned int& nHits);

    static pandora::HitRegion GetRegion(const pandora::Cluster *const pCluster);
  
    static float GetElectromagneticEnergyInECAL(const pandora::Cluster *const pCluster);
  
    static pandora::StatusCode GetClusterVolume(const pandora::Cluster *const pCluster, float& clusterVolume);
  
    static pandora::StatusCode FitStart(const pandora::Cluster *const pCluster, const unsigned int maxOccupiedLayers, pandora::ClusterFitResult &clusterFitResult);
  
    static pandora::StatusCode FitFullCluster(const pandora::Cluster *const pCluster, pandora::ClusterFitResult &clusterFitResult, bool useMainCluster = false, float eps = 50.);
  
    static pandora::StatusCode GetMainClusterHits(const pandora::Cluster *const pCluster, pandora::CaloHitList& mainClusterHits);
  
    static pandora::OrderedCaloHitList GetOrderedConnectedCaloHitList(const pandora::Cluster *const pCluster);
    
    static float GetClusterAxisStartingPointAngle(const pandora::Cluster *const pCluster);

    static void GetShowerStartingPoint(const pandora::Cluster *const pCluster, pandora::CartesianVector& startingPoint);
    static void GetShowerStartingLayer(const pandora::Cluster *const pCluster, int& showerStartLayer);

    static pandora::StatusCode GetClosestDistanceApproach(const pandora::Cluster *const pCluster, const pandora::CartesianVector &point,
      float &closestDistance, pandora::CartesianVector& distanceVector, bool onlyUseConnectedHit = true);

    static pandora::StatusCode GetClosestDistanceApproach(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
      float &closestDistance, pandora::CartesianVector& distanceVector, bool onlyUseConnectedHit = true);

    static pandora::StatusCode GetClosestDistanceApproach(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
            float &closestDistance, bool onlyUseConnectedHit = true);

    static pandora::StatusCode GetClosestDistanceApproach(const pandora::CaloHitList& caloHitList1, 
            const pandora::CaloHitList& caloHitList2, float &closestDistance, bool onlyUseConnectedHit = true);

    static pandora::StatusCode GetTrackClusterDistance(const pandora::TrackState *const pTrackState, const pandora::Cluster *const pCluster,
    const unsigned int maxSearchLayer, const float parallelDistanceCut, const float minTrackClusterCosAngle, float &trackClusterDistance);

    static pandora::StatusCode GetNCaloHitSeeds(const pandora::Cluster *const pCluster, unsigned int &nSeeds);

     static bool IsClusterLeavingDetector(const pandora::Cluster *const pCluster, const unsigned int nOuterLayersToExamine = 4, 
             const unsigned int nMipLikeOccupiedLayers = 4, const unsigned int nShowerLikeOccupiedLayers = 3, 
             const float showerLikeEnergyInOuterLayers = 1.f);

     static bool ContainsHitInOuterSamplingLayer(const pandora::Cluster *const pCluster);

    static bool IsClusterLeavingDetector(const pandora::Pandora &pandora, const pandora::Cluster *const pCluster, unsigned int nOuterLayersToExamine = 3,
            float maxDistanceToDetectorEdge = 50.f, unsigned int minNHitsNearEdges = 3);

    static bool ContainsHitType(const pandora::Cluster *const pCluster, const pandora::HitType hitType);

    static pandora::StatusCode GetMeanSurroundingEnergy(const pandora::Cluster *const pCluster, float &meanSurroundingEnergy);

    static pandora::StatusCode GetMeanDensity(const pandora::Cluster *const pCluster, float &meanDensity);
    static float GetMeanDensity(const pandora::Cluster *const pCluster);

    static pandora::StatusCode GetChiClusterMerging(const pandora::Pandora &pandora, const pandora::Cluster *const pClusterToEnlarge, const pandora::Cluster *const pClusterToMerge, float& trackEnergy, float &oldChi, float &newChi);

    static pandora::StatusCode MergeClusters(const pandora::Algorithm &algorithm, ClusterToClusterMap &clusterToClusterMap);

    static pandora::StatusCode GetTrackClusterDistance(const pandora::Pandora &pandora, const pandora::Cluster *const pCluster, const pandora::Track *const pTrack, const float maxTransverseDistance, float &trackClusterDistance);

        static bool DoesClusterCrossGapRegion(const pandora::Pandora &pandora, const pandora::Cluster *const pCluster, const unsigned int startLayer,
            const unsigned int endLayer, const pandora::DetectorGap *&pDetectorGap, const unsigned int nSamplingPoints = 50);

        static bool DoesFitCrossGapRegion(const pandora::Pandora &pandora, const pandora::ClusterFitResult &clusterFitResult,
            const pandora::CartesianVector &startPosition, const float propagationDistance, const pandora::DetectorGap *&pDetectorGap, const unsigned int nSamplingPoints = 50);

        static pandora::StatusCode GetDistanceToDetectorGap(const pandora::CartesianVector &positionVector, const pandora::DetectorGap *const pDetectorGap, float &distanceToGap);

        static pandora::StatusCode GetCaloHitsNearDetectorGaps(const pandora::Pandora &pandora, const pandora::Cluster *const pCluster, const float maxDistanceFine,
            const float maxDistanceCoarse, pandora::CaloHitList &caloHitList, bool shouldUseIsolatedHits);

        static pandora::StatusCode GetCaloHitsNearDetectorGap(const pandora::Pandora &pandora, const pandora::Cluster *const pCluster, const pandora::DetectorGap *const pDetectorGap, const float maxDistanceFine,
            const float maxDistanceCoarse, pandora::CaloHitList &caloHitList, bool shouldUseIsolatedHits);

        static pandora::StatusCode CleanAndDeleteCluster(const pandora::Algorithm &algorithm, const pandora::Cluster *const pCluster);

        static pandora::StatusCode CleanAndDeleteClusters(const pandora::Algorithm &algorithm, const pandora::ClusterList &clusterList);
  
        static bool CanMergeCluster(const pandora::Pandora &pandora, const pandora::Cluster *const pCluster, const float minMipFraction, 
                const float maxAllHitsFitRms);
  
        static float GetAverageTime(const pandora::Cluster *const pCluster, bool onlyForECALHit = false);
        static float GetMeanHitPerLayer(const pandora::Cluster *const pCluster);

        static pandora::StatusCode GetMainClusterHits(const pandora::Cluster *const pCluster, pandora::CaloHitList& mainClusterHits, float eps);

        static pandora::StatusCode GetRMS(const pandora::Cluster *const pCluster, pandora::CartesianVector cog, pandora::CartesianVector axis, float& rms1, float& rms2);
        static pandora::StatusCode GetRMS(const pandora::CaloHitList& clusterHits, pandora::CartesianVector cog, pandora::CartesianVector axis, float& rms1, float& rms2);
  
        static unsigned int GetClusterConnectorNumber(const pandora::Cluster *const pCluster);
};

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

inline float ClusterPca::GetEigenValue(int component) const
{
    if(component < 0 || component > 2)
        throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);

    return m_components[component].m_eigenValue;
}

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

inline const pandora::CartesianVector &ClusterPca::GetEigenVector(int component) const
{
    if(component < 0 || component > 2)
        throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);

    return m_components[component].m_eigenVector;
}

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

inline float ClusterPca::GetTransverseRatio() const
{
    return m_transverseRatio;
}

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

inline const pandora::Cluster *ClusterPca::GetCluster() const
{
    return m_pCluster;
}

} 

#endif  //  CLUSTERHELPER_H