PerfectPfoCreationAlgorithm.h

Go to the documentation of this file.

/*
 *
 * PerfectPfoCreationAlgorithm.h header template automatically generated by a class generator
 * Creation date : ven. mars 20 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 John Marshall
 */


#ifndef APRIL_PERFECT_PFO_CREATION_ALGORITHM_H
#define APRIL_PERFECT_PFO_CREATION_ALGORITHM_H

#include "Pandora/Algorithm.h"

#include "Api/PandoraContentApi.h"

namespace april_content
{

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

    PerfectPfoCreationAlgorithm();

private:
    typedef PandoraContentApi::ParticleFlowObject::Parameters PfoParameters;

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

    pandora::StatusCode CreateTrackBasedPfos() const;

    pandora::StatusCode PopulateTrackBasedPfo(const pandora::Track *const pTrack, PfoParameters &pfoParameters, const bool readSiblingInfo = true) const;

    pandora::StatusCode SetTrackBasedPfoParameters(const pandora::Track *const pTrack, PfoParameters &pfoParameters) const;

    pandora::StatusCode SetSiblingTrackBasedPfoParameters(const pandora::Track *const pTrack, PfoParameters &pfoParameters) const;

    pandora::StatusCode SetDaughterTrackBasedPfoParameters(const pandora::Track *const pTrack, PfoParameters &pfoParameters) const;

    pandora::StatusCode SetSimpleTrackBasedPfoParameters(const pandora::Track *const pTrack, PfoParameters &pfoParameters) const;

    pandora::StatusCode CreateNeutralPfos() const;

    const pandora::CartesianVector GetEnergyWeightedCentroid(const pandora::Cluster *const pCluster, const unsigned int innerPseudoLayer,
        const unsigned int outerPseudoLayer) const;

    pandora::StatusCode TrackCollection(const pandora::MCParticle *const pPfoTarget, PfoParameters &pfoParameters) const;

    void SetPfoParametersFromTracks(int &nTracksUsed, PfoParameters &pfoParameters) const;
    void SetPfoParametersFromClusters(const pandora::MCParticle *const pPfoTarget, const int nTracksUsed, PfoParameters &pfoParameters) const;
    pandora::StatusCode SetPfoParametersFromClusters() const;
    pandora::StatusCode TrackClusterAssociation(const pandora::MCParticle *const pPfoTarget, PfoParameters &pfoParameters) const;

    std::string     m_outputPfoListName;                    
    std::string     m_associationAlgorithmName;             
    bool            m_collapsedMCParticlesToPfoTarget;

    //pandora::StringVector   m_associationAlgorithms;        ///< The ordered list of track-cluster associations algorithm to run
};

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

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

}

#endif