PandoraApi.h

Go to the documentation of this file.

 
#ifndef PANDORA_API_H
#define PANDORA_API_H 1
 
#include "Pandora/ObjectCreation.h"
#include "Pandora/Pandora.h"
#include "Pandora/PandoraObjectFactories.h"
 
namespace pandora { class AlgorithmFactory; class AlgorithmToolFactory; }
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class PandoraApi
{
public:
    /* Map object creation into PandoraApi */
    typedef object_creation::CaloHit CaloHit;
    typedef object_creation::MCParticle MCParticle;
    typedef object_creation::Track Track;
 
    class Geometry
    {
    public:
        typedef object_creation::Geometry::LayerParameters LayerParameters;
        typedef object_creation::Geometry::SubDetector SubDetector;
        typedef object_creation::Geometry::LArTPC LArTPC;
        typedef object_creation::Geometry::LineGap LineGap;
        typedef object_creation::Geometry::BoxGap BoxGap;
        typedef object_creation::Geometry::ConcentricGap ConcentricGap;
    };
 
    static pandora::StatusCode ProcessEvent(const pandora::Pandora &pandora);
 
    static pandora::StatusCode ReadSettings(const pandora::Pandora &pandora, const std::string &xmlFileName);
 
    static pandora::StatusCode RegisterAlgorithmFactory(const pandora::Pandora &pandora, const std::string &algorithmType,
        pandora::AlgorithmFactory *const pAlgorithmFactory);
 
    static pandora::StatusCode RegisterAlgorithmToolFactory(const pandora::Pandora &pandora, const std::string &algorithmToolType,
        pandora::AlgorithmToolFactory *const pAlgorithmToolFactory);
 
    static pandora::StatusCode SetMCParentDaughterRelationship(const pandora::Pandora &pandora, const void *const pParentAddress,
        const void *const pDaughterAddress);
 
    static pandora::StatusCode SetTrackParentDaughterRelationship(const pandora::Pandora &pandora, const void *const pParentAddress,
        const void *const pDaughterAddress);
 
    static pandora::StatusCode SetTrackSiblingRelationship(const pandora::Pandora &pandora, const void *const pFirstSiblingAddress,
        const void *const pSecondSiblingAddress);
 
    static pandora::StatusCode SetCaloHitToMCParticleRelationship(const pandora::Pandora &pandora, const void *const pCaloHitParentAddress,
        const void *const pMCParticleParentAddress, const float mcParticleWeight = 1);
 
    static pandora::StatusCode SetTrackToMCParticleRelationship(const pandora::Pandora &pandora, const void *const pTrackParentAddress,
        const void *const pMCParticleParentAddress, const float mcParticleWeight = 1);
 
    static pandora::StatusCode GetCurrentPfoList(const pandora::Pandora &pandora, const pandora::PfoList *&pPfoList);
 
    static pandora::StatusCode GetPfoList(const pandora::Pandora &pandora, const std::string &pfoListName, const pandora::PfoList *&pPfoList);
 
    static pandora::StatusCode SetExternalParameters(const pandora::Pandora &pandora, const std::string &algorithmType,
        pandora::ExternalParameters *const pExternalParameters);
 
    static pandora::StatusCode SetHitTypeGranularity(const pandora::Pandora &pandora, const pandora::HitType hitType,
        const pandora::Granularity granularity);
 
    static pandora::StatusCode SetBFieldPlugin(const pandora::Pandora &pandora, pandora::BFieldPlugin *const pBFieldPlugin);
 
    static pandora::StatusCode SetLArTransformationPlugin(const pandora::Pandora &pandora, pandora::LArTransformationPlugin *const pLArTransformationPlugin);
 
    static pandora::StatusCode SetPseudoLayerPlugin(const pandora::Pandora &pandora, pandora::PseudoLayerPlugin *const pPseudoLayerPlugin);
 
    static pandora::StatusCode SetShowerProfilePlugin(const pandora::Pandora &pandora, pandora::ShowerProfilePlugin *const pShowerProfilePlugin);
 
    static pandora::StatusCode RegisterEnergyCorrectionPlugin(const pandora::Pandora &pandora, const std::string &name,
        const pandora::EnergyCorrectionType energyCorrectionType, pandora::EnergyCorrectionPlugin *const pEnergyCorrectionPlugin);
 
    static pandora::StatusCode RegisterParticleIdPlugin(const pandora::Pandora &pandora, const std::string &name,
        pandora::ParticleIdPlugin *const pParticleIdPlugin);
 
    static pandora::StatusCode Reset(const pandora::Pandora &pandora);
};
 
#endif // #ifndef PANDORA_API_H