PandoraContentApi.h

Go to the documentation of this file.

 
#ifndef PANDORA_CONTENT_API_H
#define PANDORA_CONTENT_API_H 1
 
#include "Pandora/ObjectCreation.h"
#include "Pandora/Pandora.h"
#include "Pandora/PandoraObjectFactories.h"
 
namespace pandora { class TiXmlElement; }
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class PandoraContentApi
{
public:
    /* Map object creation and metadata functionality into PandoraContentApi */
    typedef object_creation::CaloHit CaloHit;
    typedef object_creation::Cluster Cluster;
    typedef object_creation::ParticleFlowObject ParticleFlowObject;
    typedef object_creation::Vertex Vertex;
    typedef object_creation::MCParticle MCParticle;
    typedef object_creation::Track Track;
    typedef object_creation::CaloHitFragment CaloHitFragment;
 
    /* Accessors for plugins and global settings */
 
    static const pandora::PandoraSettings *GetSettings(const pandora::Algorithm &algorithm);
 
    static const pandora::GeometryManager *GetGeometry(const pandora::Algorithm &algorithm);
 
    static const pandora::PluginManager *GetPlugins(const pandora::Algorithm &algorithm);
 
 
    /* High-level steering functions */
 
    static pandora::StatusCode RepeatEventPreparation(const pandora::Algorithm &algorithm);
 
    static pandora::StatusCode CreateAlgorithmTool(const pandora::Algorithm &algorithm, pandora::TiXmlElement *const pXmlElement,
        pandora::AlgorithmTool *&pAlgorithmTool);
 
    static pandora::StatusCode CreateDaughterAlgorithm(const pandora::Algorithm &algorithm, pandora::TiXmlElement *const pXmlElement,
        std::string &daughterAlgorithmName);
 
    static pandora::StatusCode RunDaughterAlgorithm(const pandora::Algorithm &algorithm, const std::string &daughterAlgorithmName);
 
    static pandora::StatusCode RunClusteringAlgorithm(const pandora::Algorithm &algorithm, const std::string &clusteringAlgorithmName,
        const pandora::ClusterList *&pNewClusterList, std::string &newClusterListName);
 
 
    /* List-manipulation functions */
 
    template <typename T>
    static pandora::StatusCode GetCurrentList(const pandora::Algorithm &algorithm, const T *&pT);
 
    template <typename T>
    static pandora::StatusCode GetCurrentList(const pandora::Algorithm &algorithm, const T *&pT, std::string &listName);
 
    template <typename T>
    static pandora::StatusCode GetCurrentListName(const pandora::Algorithm &algorithm, std::string &listName);
 
    template <typename T>
    static pandora::StatusCode ReplaceCurrentList(const pandora::Algorithm &algorithm, const std::string &newListName);
 
    template <typename T>
    static pandora::StatusCode DropCurrentList(const pandora::Algorithm &algorithm);
 
    template <typename T>
    static pandora::StatusCode GetList(const pandora::Algorithm &algorithm, const std::string &listName, const T *&pT);
 
    template <typename T>
    static pandora::StatusCode RenameList(const pandora::Algorithm &algorithm, const std::string &oldListName, const std::string &newListName);
 
 
    /* List-manipulation functions: input objects only (CaloHits, Tracks, MCParticles) */
 
    template <typename T>
    static pandora::StatusCode SaveList(const pandora::Algorithm &algorithm, const T &t, const std::string &newListName);
 
 
    /* List-manipulation functions: algorithm objects only (Clusters, Pfos, Vertices) */
 
    template <typename T>
    static pandora::StatusCode SaveList(const pandora::Algorithm &algorithm, const std::string &newListName);
 
    template <typename T>
    static pandora::StatusCode SaveList(const pandora::Algorithm &algorithm, const std::string &oldListName, const std::string &newListName);
 
    template <typename T>
    static pandora::StatusCode SaveList(const pandora::Algorithm &algorithm, const std::string &newListName, const T &t);
 
    template <typename T>
    static pandora::StatusCode SaveList(const pandora::Algorithm &algorithm, const std::string &oldListName, const std::string &newListName,
        const T &t);
 
    template <typename T>
    static pandora::StatusCode TemporarilyReplaceCurrentList(const pandora::Algorithm &algorithm, const std::string &newListName);
 
    template <typename T>
    static pandora::StatusCode CreateTemporaryListAndSetCurrent(const pandora::Algorithm &algorithm, const T *&pT, std::string &temporaryListName);
 
 
    /* Object-related functions */
 
    template <typename T>
    static bool IsAvailable(const pandora::Algorithm &algorithm, const T *const pT);
 
 
    /* Object-related functions: algorithm objects only (Clusters, Pfos, Vertices) */
 
    template <typename T>
    static pandora::StatusCode Delete(const pandora::Algorithm &algorithm, const T *const pT);
 
    template <typename T>
    static pandora::StatusCode Delete(const pandora::Algorithm &algorithm, const T *const pT, const std::string &listName);
 
 
    /* CaloHit-related functions */
 
    template <typename T>
    static pandora::StatusCode AddToCluster(const pandora::Algorithm &algorithm, const pandora::Cluster *const pCluster, const T *const pT);
 
    static pandora::StatusCode RemoveFromCluster(const pandora::Algorithm &algorithm, const pandora::Cluster *const pCluster,
        const pandora::CaloHit *const pCaloHit);
 
    template <typename T>
    static pandora::StatusCode AddIsolatedToCluster(const pandora::Algorithm &algorithm, const pandora::Cluster *const pCluster, const T *const pT);
 
    static pandora::StatusCode RemoveIsolatedFromCluster(const pandora::Algorithm &algorithm, const pandora::Cluster *const pCluster,
        const pandora::CaloHit *const pCaloHit);
 
    static pandora::StatusCode Fragment(const pandora::Algorithm &algorithm, const pandora::CaloHit *const pOriginalCaloHit,
        const float fraction1, const pandora::CaloHit *&pDaughterCaloHit1, const pandora::CaloHit *&pDaughterCaloHit2,
        const pandora::ObjectFactory<object_creation::CaloHitFragment::Parameters, object_creation::CaloHitFragment::Object> &factory = pandora::PandoraObjectFactory<object_creation::CaloHitFragment::Parameters, object_creation::CaloHitFragment::Object>());
 
    static pandora::StatusCode MergeFragments(const pandora::Algorithm &algorithm, const pandora::CaloHit *const pFragmentCaloHit1,
        const pandora::CaloHit *const pFragmentCaloHit2, const pandora::CaloHit *&pMergedCaloHit,
        const pandora::ObjectFactory<object_creation::CaloHitFragment::Parameters, object_creation::CaloHitFragment::Object> &factory = pandora::PandoraObjectFactory<object_creation::CaloHitFragment::Parameters, object_creation::CaloHitFragment::Object>());
 
 
    /* Track-related functions */
 
    static pandora::StatusCode AddTrackClusterAssociation(const pandora::Algorithm &algorithm, const pandora::Track *const pTrack,
        const pandora::Cluster *const pCluster);
 
    static pandora::StatusCode RemoveTrackClusterAssociation(const pandora::Algorithm &algorithm, const pandora::Track *const pTrack,
        const pandora::Cluster *const pCluster);
 
    static pandora::StatusCode RemoveCurrentTrackClusterAssociations(const pandora::Algorithm &algorithm);
 
    static pandora::StatusCode RemoveAllTrackClusterAssociations(const pandora::Algorithm &algorithm);
 
 
    /* MCParticle-related functions */
 
    static pandora::StatusCode RemoveAllMCParticleRelationships(const pandora::Algorithm &algorithm);
 
 
    /* Cluster-related functions */
 
    static pandora::StatusCode MergeAndDeleteClusters(const pandora::Algorithm &algorithm, const pandora::Cluster *const pClusterToEnlarge,
        const pandora::Cluster *const pClusterToDelete);
 
    static pandora::StatusCode MergeAndDeleteClusters(const pandora::Algorithm &algorithm, const pandora::Cluster *const pClusterToEnlarge,
        const pandora::Cluster *const pClusterToDelete, const std::string &enlargeListName, const std::string &deleteListName);
 
 
    /* Pfo-related functions */
 
    template <typename T>
    static pandora::StatusCode AddToPfo(const pandora::Algorithm &algorithm, const pandora::ParticleFlowObject *const pPfo, const T *const pT);
 
    template <typename T>
    static pandora::StatusCode RemoveFromPfo(const pandora::Algorithm &algorithm, const pandora::ParticleFlowObject *const pPfo, const T *const pT);
 
    static pandora::StatusCode SetPfoParentDaughterRelationship(const pandora::Algorithm &algorithm, const pandora::ParticleFlowObject *const pParentPfo,
        const pandora::ParticleFlowObject *const pDaughterPfo);
 
    static pandora::StatusCode RemovePfoParentDaughterRelationship(const pandora::Algorithm &algorithm, const pandora::ParticleFlowObject *const pParentPfo,
        const pandora::ParticleFlowObject *const pDaughterPfo);
 
 
    /* Reclustering functions */
 
    static pandora::StatusCode InitializeFragmentation(const pandora::Algorithm &algorithm, const pandora::ClusterList &inputClusterList,
        std::string &originalClustersListName, std::string &fragmentClustersListName);
 
    static pandora::StatusCode EndFragmentation(const pandora::Algorithm &algorithm, const std::string &clusterListToSaveName,
        const std::string &clusterListToDeleteName);
 
    static pandora::StatusCode InitializeReclustering(const pandora::Algorithm &algorithm, const pandora::TrackList &inputTrackList,
        const pandora::ClusterList &inputClusterList, std::string &originalClustersListName);
 
    static pandora::StatusCode EndReclustering(const pandora::Algorithm &algorithm, const std::string &selectedClusterListName);
};
 
#endif // #ifndef PANDORA_CONTENT_API_H