FlowElement_v1.h

Go to the documentation of this file.

// this files is  -*- c++ -*-
/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
#ifndef XAODPFLOW_VERSIONS_FLOWELEMENT_V1_H
#define XAODPFLOW_VERSIONS_FLOWELEMENT_V1_H
 
// Core include(s):
#include "AthLinks/ElementLink.h"
 
// xAOD include(s):
#include "xAODBase/IParticle.h"
#include "xAODBase/IParticleContainer.h"
 
namespace xAOD {

  class FlowElement_v1 : public IParticle {
  public:
 
    using IParticle::IParticle;
    
    typedef unsigned long  signal_t; // 32-bit minimum
    typedef short vertex_t;
    using IParticle::FourMom_t ;
    
    enum SignalType { 
             // global characteristics
             Neutral      = 0x1000,
             Charged      = 0x2000,
             Combined     = 0x4000, //needed??
 
             // detector level signals and flow objects
             CaloCluster  = Neutral | 0x0100,
             Track        = Charged | 0x0200,
             Muon         = Charged | 0x0400,
             PFlow        = 0x0010,
             NeutralPFlow = Neutral | PFlow,
             ChargedPFlow = Charged | PFlow,
 
             // higher level flow objects
             TCC          = 0x0020,
             NeutralTCC   = Neutral | TCC,
             ChargedTCC   = Charged | TCC,
             UFO          = 0x0001,
             NeutralUFO   = Neutral | UFO,
             ChargedUFO   = Charged | UFO,
 
             // unknown
             Unknown      = 0x0000
    };

    enum MatchedPVType {
            Undefined = 0x00, HardScatter = 0x10, Pileup = 0x20, PileupSideBand = 0x21
    };
 
    // *************************************************
    virtual double pt()    const override;
    virtual double eta()   const override;
    virtual double phi()   const override;
    virtual double m()     const override;
    virtual double e()     const override;
    virtual double rapidity()     const override;
    virtual FourMom_t p4() const override;
    virtual Type::ObjectType type() const override ;
    
    void setP4(float pt, float eta, float phi, float m) ;
    void setP4(const FourMom_t& p4);
 
    // *************************************************
    signal_t signalType() const;
    void setSignalType(signal_t t);
    
    // *************************************************
    bool     isMatchedToPV(MatchedPVType vxtype=HardScatter) const;
 
    vertex_t vertexType() const;
    void     setVertexType(vertex_t t);
    
    // *************************************************
    bool  isCharged() const;
    float charge() const;
 
    void  setCharge(float c);
 
    // *************************************************

    std::vector<const xAOD::IParticle*> chargedObjects() const ;
    std::vector<std::pair<const xAOD::IParticle*,float> > chargedObjectsAndWeights() const ;
 
    std::size_t nChargedObjects() const ; 
    const xAOD::IParticle* chargedObject( std::size_t i ) const;
    std::pair< const xAOD::IParticle*, float > chargedObjectAndWeight( std::size_t i ) const;
    


    const std::vector<ElementLink<IParticleContainer>> & chargedObjectLinks() const ;
    const std::vector<float> & chargedObjectWeights() const ;
    void setChargedObjectLinks(const std::vector<ElementLink<IParticleContainer>> & elV);
    void setChargedObjectLinks(const std::vector<ElementLink<IParticleContainer>> & elV, const std::vector<float> & wV);
 
    // *************************************************
    std::vector<const xAOD::IParticle*> otherObjects() const ;
    std::vector<std::pair<const xAOD::IParticle*,float> > otherObjectsAndWeights() const ;
 
    std::size_t nOtherObjects() const ; 
    const xAOD::IParticle* otherObject( std::size_t i ) const;
    std::pair< const xAOD::IParticle*, float > otherObjectAndWeight( std::size_t i ) const;
    
    const std::vector<ElementLink<IParticleContainer>>& otherObjectLinks() const ;
    const std::vector<float>& otherObjectWeights() const ;
 
    void setOtherObjectLinks(const std::vector<ElementLink<IParticleContainer>> & elV);
    void setOtherObjectLinks(const std::vector<ElementLink<IParticleContainer>> & elV, const std::vector<float> & wV);
    
  };
 
}
// Declare IParticle as a base class of FlowElement_v1:
#include "AthContainers/DataVector.h"
DATAVECTOR_BASE( xAOD::FlowElement_v1, xAOD::IParticle );
 
 
#endif