ObjectCreation.h

Go to the documentation of this file.

 
#ifndef PANDORA_OBJECT_CREATION_H
#define PANDORA_OBJECT_CREATION_H 1
 
#include "Pandora/PandoraInternal.h"
#include "Pandora/PandoraInputTypes.h"
#include "Pandora/StatusCodes.h"
 
namespace pandora
{
    class Algorithm; class Pandora;
    template <typename Parameters, typename Object> class ObjectFactory;
    template <typename Parameters, typename Object> class PandoraObjectFactory;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
namespace object_creation
{
 
template <typename PARAMETERS, typename METADATA, typename OBJECT>
class ObjectCreationHelper
{
public:
    typedef PARAMETERS Parameters;
    typedef METADATA Metadata;
    typedef OBJECT Object;
 
    static pandora::StatusCode Create(const pandora::Pandora &pandora, const Parameters &parameters,
        const pandora::ObjectFactory<Parameters, Object> &factory = pandora::PandoraObjectFactory<Parameters, Object>());
 
    static pandora::StatusCode Create(const pandora::Algorithm &algorithm, const Parameters &parameters,
        const Object *&pObject, const pandora::ObjectFactory<Parameters, Object> &factory = pandora::PandoraObjectFactory<Parameters, Object>());
 
    static pandora::StatusCode AlterMetadata(const pandora::Algorithm &algorithm, const Object *const pObject, const Metadata &metadata);
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class ObjectMetadata
{
public:
    virtual ~ObjectMetadata();
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class ObjectParameters
{
public:
    virtual ~ObjectParameters();
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class CaloHitMetadata : public ObjectMetadata
{
public:
    pandora::InputFloat                 m_x0;                       
    pandora::InputBool                  m_isIsolated;               
    pandora::InputBool                  m_isPossibleMip;            
};
 
class CaloHitParameters : public ObjectParameters
{
public:
    pandora::InputCartesianVector       m_positionVector;           
    pandora::InputCartesianVector       m_expectedDirection;        
    pandora::InputCartesianVector       m_cellNormalVector;         
    pandora::InputCellGeometry          m_cellGeometry;             
    pandora::InputFloat                 m_cellSize0;                
    pandora::InputFloat                 m_cellSize1;                
    pandora::InputFloat                 m_cellThickness;            
    pandora::InputFloat                 m_nCellRadiationLengths;    
    pandora::InputFloat                 m_nCellInteractionLengths;  
    pandora::InputFloat                 m_time;                     
    pandora::InputFloat                 m_inputEnergy;              
    pandora::InputFloat                 m_mipEquivalentEnergy;      
    pandora::InputFloat                 m_electromagneticEnergy;    
    pandora::InputFloat                 m_hadronicEnergy;           
    pandora::InputBool                  m_isDigital;                
    pandora::InputHitType               m_hitType;                  
    pandora::InputHitRegion             m_hitRegion;                
    pandora::InputUInt                  m_layer;                    
    pandora::InputBool                  m_isInOuterSamplingLayer;   
    pandora::InputAddress               m_pParentAddress;           
};
 
typedef ObjectCreationHelper<CaloHitParameters, CaloHitMetadata, pandora::CaloHit> CaloHit;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class MCParticleParameters : public ObjectParameters
{
public:
    pandora::InputFloat                 m_energy;                   
    pandora::InputCartesianVector       m_momentum;                 
    pandora::InputCartesianVector       m_vertex;                   
    pandora::InputCartesianVector       m_endpoint;                 
    pandora::InputInt                   m_particleId;               
    pandora::InputMCParticleType        m_mcParticleType;           
    pandora::InputAddress               m_pParentAddress;           
};
 
typedef ObjectCreationHelper<MCParticleParameters, ObjectMetadata, pandora::MCParticle> MCParticle;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class TrackParameters : public ObjectParameters
{
public:
    pandora::InputFloat                 m_d0;                       
    pandora::InputFloat                 m_z0;                       
    pandora::InputInt                   m_particleId;               
    pandora::InputInt                   m_charge;                   
    pandora::InputFloat                 m_mass;                     
    pandora::InputCartesianVector       m_momentumAtDca;            
    pandora::InputTrackState            m_trackStateAtStart;        
    pandora::InputTrackState            m_trackStateAtEnd;          
    pandora::InputTrackState            m_trackStateAtCalorimeter;  
    pandora::InputFloat                 m_timeAtCalorimeter;        
    pandora::InputBool                  m_reachesCalorimeter;       
    pandora::InputBool                  m_isProjectedToEndCap;      
    pandora::InputBool                  m_canFormPfo;               
    pandora::InputBool                  m_canFormClusterlessPfo;    
    pandora::InputAddress               m_pParentAddress;           
};
 
typedef ObjectCreationHelper<TrackParameters, ObjectMetadata, pandora::Track> Track;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class Geometry
{
public:
    class LayerParameters : public ObjectParameters
    {
    public:
        pandora::InputFloat             m_closestDistanceToIp;      
        pandora::InputFloat             m_nRadiationLengths;        
        pandora::InputFloat             m_nInteractionLengths;      
    };
 
    typedef std::vector<LayerParameters> LayerParametersVector;
 
    class SubDetectorParameters : public ObjectParameters
    {
    public:
        pandora::InputString            m_subDetectorName;          
        pandora::InputSubDetectorType   m_subDetectorType;          
        pandora::InputFloat             m_innerRCoordinate;         
        pandora::InputFloat             m_innerZCoordinate;         
        pandora::InputFloat             m_innerPhiCoordinate;       
        pandora::InputUInt              m_innerSymmetryOrder;       
        pandora::InputFloat             m_outerRCoordinate;         
        pandora::InputFloat             m_outerZCoordinate;         
        pandora::InputFloat             m_outerPhiCoordinate;       
        pandora::InputUInt              m_outerSymmetryOrder;       
        pandora::InputBool              m_isMirroredInZ;            
        pandora::InputUInt              m_nLayers;                  
        LayerParametersVector           m_layerParametersVector;    
    };
 
    typedef ObjectCreationHelper<SubDetectorParameters, ObjectMetadata, pandora::SubDetector> SubDetector;
 
    class LArTPCParameters : public ObjectParameters
    {
    public:
        pandora::InputUInt              m_larTPCVolumeId;           
        pandora::InputFloat             m_centerX;                  
        pandora::InputFloat             m_centerY;                  
        pandora::InputFloat             m_centerZ;                  
        pandora::InputFloat             m_widthX;                   
        pandora::InputFloat             m_widthY;                   
        pandora::InputFloat             m_widthZ;                   
        pandora::InputFloat             m_wirePitchU;               
        pandora::InputFloat             m_wirePitchV;               
        pandora::InputFloat             m_wirePitchW;               
        pandora::InputFloat             m_wireAngleU;               
        pandora::InputFloat             m_wireAngleV;               
        pandora::InputFloat             m_wireAngleW;               
        pandora::InputFloat             m_sigmaUVW;                 
        pandora::InputBool              m_isDriftInPositiveX;       
    };
 
    typedef ObjectCreationHelper<LArTPCParameters, ObjectMetadata, pandora::LArTPC> LArTPC;
 
    class LineGapParameters : public ObjectParameters
    {
    public:
        pandora::InputLineGapType       m_lineGapType;              
        pandora::InputFloat             m_lineStartX;               
        pandora::InputFloat             m_lineEndX;                 
        pandora::InputFloat             m_lineStartZ;               
        pandora::InputFloat             m_lineEndZ;                 
    };
 
    typedef ObjectCreationHelper<LineGapParameters, ObjectMetadata, pandora::LineGap> LineGap;
 
    class BoxGapParameters : public ObjectParameters
    {
    public:
        pandora::InputCartesianVector   m_vertex;                   
        pandora::InputCartesianVector   m_side1;                    
        pandora::InputCartesianVector   m_side2;                    
        pandora::InputCartesianVector   m_side3;                    
    };
 
    typedef ObjectCreationHelper<BoxGapParameters, ObjectMetadata, pandora::BoxGap> BoxGap;
 
    class ConcentricGapParameters : public ObjectParameters
    {
    public:
        pandora::InputFloat             m_minZCoordinate;           
        pandora::InputFloat             m_maxZCoordinate;           
        pandora::InputFloat             m_innerRCoordinate;         
        pandora::InputFloat             m_innerPhiCoordinate;       
        pandora::InputUInt              m_innerSymmetryOrder;       
        pandora::InputFloat             m_outerRCoordinate;         
        pandora::InputFloat             m_outerPhiCoordinate;       
        pandora::InputUInt              m_outerSymmetryOrder;       
    };
 
    typedef ObjectCreationHelper<ConcentricGapParameters, ObjectMetadata, pandora::ConcentricGap> ConcentricGap;
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class ClusterMetadata : public ObjectMetadata
{
public:
    pandora::InputInt                   m_particleId;               
};
 
class ClusterParameters : public ObjectParameters
{
public:
    pandora::CaloHitList                m_caloHitList;              
    pandora::CaloHitList                m_isolatedCaloHitList;      
    pandora::InputTrackAddress          m_pTrack;                   
};
 
typedef ObjectCreationHelper<ClusterParameters, ClusterMetadata, pandora::Cluster> Cluster;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class ParticleFlowObjectMetadata : public ObjectMetadata
{
public:
    pandora::InputInt                   m_particleId;               
    pandora::InputInt                   m_charge;                   
    pandora::InputFloat                 m_mass;                     
    pandora::InputFloat                 m_energy;                   
    pandora::InputCartesianVector       m_momentum;                 
    pandora::PropertiesMap              m_propertiesToAdd;          
    pandora::StringVector               m_propertiesToRemove;       
};
 
class ParticleFlowObjectCreation : public ParticleFlowObjectMetadata, public ObjectParameters
{
public:
    pandora::ClusterList                m_clusterList;              
    pandora::TrackList                  m_trackList;                
    pandora::VertexList                 m_vertexList;               
};
 
typedef ObjectCreationHelper<ParticleFlowObjectCreation, ParticleFlowObjectMetadata, pandora::ParticleFlowObject> ParticleFlowObject;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class VertexMetadata : public ObjectMetadata
{
public:
    pandora::InputFloat                 m_x0;                       
    pandora::InputVertexLabel           m_vertexLabel;              
    pandora::InputVertexType            m_vertexType;               
};
 
class VertexParameters : public VertexMetadata, public ObjectParameters
{
public:
    pandora::InputCartesianVector       m_position;                 
};
 
typedef ObjectCreationHelper<VertexParameters, VertexMetadata, pandora::Vertex> Vertex;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
template <typename PARAMETERS, typename OBJECT>
class TypedefHelper
{
public:
    typedef PARAMETERS Parameters;
    typedef OBJECT Object;
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class CaloHitFragmentParameters : public ObjectParameters
{
public:
    const pandora::CaloHit             *m_pOriginalCaloHit;         
    pandora::InputFloat                 m_weight;                   
};
 
typedef TypedefHelper<CaloHitFragmentParameters, pandora::CaloHit> CaloHitFragment;
 
//------------------------------------------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline ObjectMetadata::~ObjectMetadata()
{
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline ObjectParameters::~ObjectParameters()
{
}
 
} // namespace object_creation
 
#endif // #ifndef PANDORA_OBJECT_CREATION_H