ChargedFragmentsMergingAlgorithm.h

Go to the documentation of this file.

/*
 *
 * ChargedFragmentsMergingAlgorithm.h header template automatically generated by a class generator
 * Creation date : jeu. avr. 9 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 CHARGEDFRAGMENTSMERGINGALGORITHM_H
#define CHARGEDFRAGMENTSMERGINGALGORITHM_H 

#include "Pandora/Algorithm.h"
#include "Pandora/PandoraInputTypes.h"
#include "APRILApi/APRILInputTypes.h"

#include "APRILHelpers/CaloHitRangeSearchHelper.h"
#include "APRILHelpers/CaloHitNeighborSearchHelper.h"

namespace pandora { class ClusterFitResult; }

namespace april_content
{

class ChargedFragmentsMergingAlgorithm : public pandora::Algorithm
{
public:
    class Factory : public pandora::AlgorithmFactory
    {
    public:
        pandora::Algorithm *CreateAlgorithm() const;
    };

private:
    pandora::StatusCode Run();
    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);
  
    april_content::APRILCluster* GetMainCluster(const pandora::CaloHitVector& caloHitVector);
  
    void GetNearbyClusters(pandora::Cluster* cluster, const std::vector<april_content::APRILCluster*>& clusterVector, 
            std::vector<april_content::APRILCluster*>& clustersInRange);

    void SearchProperClusters(const pandora::Track* pTrack, APRILCluster* startingCluster, 
          std::vector<april_content::APRILCluster*>& properClusters);

    pandora::StatusCode CleanClusterForMerging(std::vector<APRILCluster*>& clusterVector);

    pandora::StatusCode GetEligibleClusters(std::vector<APRILCluster*>& clusterVector) const;

    pandora::StatusCode FindClustersToMerge(const pandora::ClusterVector &clusterVector, ClusterToClusterMap &clusterToClusterMap) const;

    bool CanMergeCluster(const pandora::Cluster *const pCluster) const;

    pandora::StatusCode FindBestParentCluster(const pandora::Cluster *const pDaughterCluster, const pandora::ClusterVector &clusterVector,
            const pandora::Cluster *&pBestParentCluster) const;

    pandora::StatusCode GetClusterBackwardDirection(const pandora::Cluster *const pCluster, pandora::CartesianVector &backwardDirection, pandora::CartesianVector &innerPosition) const;

    bool IsClusterAxesCompatible(const APRILCluster* startingCluster, const APRILCluster* nearbyCluster, float& axesDistance);

private:
    float                            m_maxStartingClusterDistance;
    float                            m_maxClosestClusterDistance;
    float                            m_maxClusterPosAxisAngle;
    float                            m_maxClusterAxesDistance;

    bool                             m_mergeChargedClusters;
    bool                             m_debugOutput;
    bool                             m_debugOutput2;
    bool                             m_onlyUseConnectedHits;
    bool                             m_useMCPForPID;
    bool                             m_useMCPToRejectNeutralCluster;

    arma::mat m_clusterCentroidsMatrix;
    std::vector<APRILCluster*> m_clustersToMerge;
};

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

inline pandora::Algorithm *ChargedFragmentsMergingAlgorithm::Factory::CreateAlgorithm() const
{
    return new ChargedFragmentsMergingAlgorithm();
}

} 

#endif