APRILClusteringAlgorithm.h

Go to the documentation of this file.

/*
 *
 * APRILClusteringAlgorithm.h header template automatically generated by a class generator
 * Creation date : ven. d�c. 4 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 APRILCLUSTERINGALGORITHM_H
#define APRILCLUSTERINGALGORITHM_H

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

namespace april_content
{

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

    static const pandora::CaloHitList* GetCaloHitList() { return m_pCaloHitList; }
    static const pandora::CaloHitList* GetEcalHitList() { return &m_hcalCaloHitList; }
    static const pandora::CaloHitList* GetHcalHitList() { return &m_hcalCaloHitList; }
    static const pandora::CaloHitList* GetMuonHitList() { return &m_muonCaloHitList; }

private:
    pandora::StatusCode Run();
    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

    pandora::StatusCode SplitCaloHitList(const pandora::CaloHitList *const pCaloHitList, pandora::CaloHitList &ecalCaloHitList,
            pandora::CaloHitList &hcalCaloHitList, pandora::CaloHitList &muonCaloHitList) const;

    pandora::StatusCode ConnectCaloHits(const ConnectorAlgorithmToolVector &toolVector) const;

    pandora::StatusCode CreateClusters() const;


private:
    ConnectorAlgorithmToolVector      m_toolList;        

    static const pandora::CaloHitList*       m_pCaloHitList; 
    static pandora::CaloHitList              m_ecalCaloHitList; 
    static pandora::CaloHitList              m_hcalCaloHitList; 
    static pandora::CaloHitList              m_muonCaloHitList;

    bool                              m_allowSingleHitClusters;    
    bool                              m_useMultithread;            
    bool                              m_useAsIndependent;          
    
    // It seems that we can not add any member of type ConnectorAlgorithmToolVector or string more (?), otherwise it will crash.
};

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

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

} 

#endif  //  APRILCLUSTERINGALGORITHM_H