RingSetConf_v1.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef XAODCALORINGS_VERSIONS_RINGSETCONF_V1_H
#define XAODCALORINGS_VERSIONS_RINGSETCONF_V1_H
 
// std includes:
#include <vector>
#include <iosfwd>
 
// Athena framework includes:
#include "CaloGeoHelpers/CaloSampling.h"
#include "AthContainers/DataVector.h"
 
// EDM include(s):
#include "AthContainers/AuxElement.h"
#include "xAODCore/AuxStoreAccessorMacros.h"
 
// local includes:
#include "xAODCaloRings/CaloRingsDefs.h"
 
namespace xAOD {
 
// Forward declare the container type:
class RingSetConf_v1;
typedef DataVector< xAOD::RingSetConf_v1 > RingSetConfContainer_v1;

class RingSetConf_v1 : public SG::AuxElement {
 
  public:


    struct RawConf {
      unsigned nRings;    
      std::vector<CaloSampling::CaloSample> layers;
      float etaWidth;   
      float phiWidth;   
      float cellMaxDEtaDist;   
      float cellMaxDPhiDist;   
      Ringer::CalJointLayer calJointLayer;
      Ringer::CalJointSection calJointSection;
      bool doEtaAxesDivision;
      bool doPhiAxesDivision;
      unsigned layerStartIdx;
      unsigned layerEndIdx;
      unsigned sectionStartIdx;
      unsigned sectionEndIdx;


      RawConf();
      RawConf(const unsigned nRings, 
          const std::vector<CaloSampling::CaloSample> &layers,
          const float etaWidth, const float phiWidth,
          const float cellMaxDEtaDist, const float cellMaxDPhiDist,
          const Ringer::CalJointLayer calJointLayer,
          const Ringer::CalJointSection calJointSection,
          const bool doEtaAxesDivision = false,
          const bool doPhiAxesDivision = false);
      RawConf(const unsigned nRings, 
          const std::vector<CaloSampling::CaloSample> &layers,
          const float etaWidth, const float phiWidth,
          const float cellMaxDEtaDist, const float cellMaxDPhiDist,
          const Ringer::CalJointLayer calJointLayer,
          const Ringer::CalJointSection calJointSection,
          const bool doEtaAxesDivision,
          const bool doPhiAxesDivision,
          const unsigned layerStartIdx,
          const unsigned layerEndIdx,
          const unsigned sectionStartIdx,
          const unsigned sectionEndIdx);
      RawConf(const RingSetConf_v1 &rsConf);
 
    };

    typedef std::vector<RawConf> RawConfCollection;

    static bool isEMSection (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isHADSection(const std::vector<CaloSampling::CaloSample> &layers);
    static bool isPSLayer   (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isEM1Layer  (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isEM2Layer  (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isEM3Layer  (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isHAD1Layer (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isHAD2Layer (const std::vector<CaloSampling::CaloSample> &layers);
    static bool isHAD3Layer (const std::vector<CaloSampling::CaloSample> &layers);
    static Ringer::CalJointSection whichSection(
        const std::vector<CaloSampling::CaloSample> &layers);
    static Ringer::CalJointLayer whichLayer(
        const std::vector<CaloSampling::CaloSample> &layers);
    static void print( const RawConf &raw, std::ostream &stream);

    static unsigned totalNumberOfRings( const RawConfCollection &clRingsConf );
    static void getEdges( const RawConfCollection &clRingsConf,
        const Ringer::CalJointSection sec,
        unsigned &startEdge,
        unsigned &endEdge);
    static void getEdges( const RawConfCollection &clRingsConf,
        const Ringer::CalJointLayer layer,
        unsigned &startEdge,
        unsigned &endEdge);
    static void addRawConfColBounderies( RawConfCollection &clRingsConf );
    static void print( const RawConfCollection &raw, std::ostream &stream );

    static void fillRingSetConfContainer(
        const RawConfCollection &rawConfCol,
        RingSetConfContainer_v1 &container);
    static void getRawConfCol(RawConfCollection &rawConfCol,
        const RingSetConfContainer_v1 * container);
    


    RingSetConf_v1();
    RingSetConf_v1(const RingSetConf_v1& ringset);
    RingSetConf_v1(const unsigned nRings, 
        const std::vector<CaloSampling::CaloSample> &rsLayers,
        const float etaWidth, const float phiWidth,
        const float cellMaxDEtaDist, const float cellMaxDPhiDist,
        const Ringer::CalJointLayer calJointLayer,
        const Ringer::CalJointSection calJointSection,
        const bool doEtaAxesDivision, const bool doPhiAxesDivision,
        const unsigned layerStartIdx, const unsigned layerEndIdx,
        const unsigned sectionStartIdx, const unsigned sectionEndIdx);
    RingSetConf_v1(const RawConf &confStruct);
 
    


    unsigned nRings() const;
    void setNRings(unsigned nRings);


    unsigned nLayers() const;
    const std::vector< CaloSampling::CaloSample >& layers() const; 
    void setLayers(const std::vector< CaloSampling::CaloSample > &layers); 
    CaloSampling::CaloSample layerAt(const unsigned idx) const; 
    void addLayer(const CaloSampling::CaloSample c);
    void clearLayers();
 

    float etaWidth() const; 
    float phiWidth() const;
    void setEtaWidth(float etaWidth); 
    void setPhiWidth(float phiWidth);
    float cellMaxDEtaDist() const; 
    float cellMaxDPhiDist() const; 
    void setCellMaxDEtaDist(float cellMaxDEtaDist);
    void setCellMaxDPhiDist(float cellMaxDPhiDist);
    bool doEtaAxesDivision() const;
     void setdoEtaAxesDivision(bool doEtaAxesDivision);
    bool doPhiAxesDivision() const;
    void setdoPhiAxesDivision(bool doPhiAxesDivision);
 

    Ringer::CalJointLayer calJointLayer() const;
    Ringer::CalJointSection calJointSection() const;
    void setCalJointLayer(Ringer::CalJointLayer calJointLayer);
    void setCalJointSection(Ringer::CalJointSection calJointSection);
  

    unsigned layerStartIdx() const;

    unsigned sectionStartIdx() const;

    unsigned layerEndIdx() const;

    unsigned sectionEndIdx() const;

    void setLayerStartIdx(unsigned layerStartIdx);
    void setSectionStartIdx(unsigned sectionEndIdx);
    void setLayerEndIdx(unsigned layerEndIdx);
    void setSectionEndIdx(unsigned sectionEndIdx);
 

    void print( std::ostream &stream ) const;
 

    const RingSetConf_v1::RawConf getRawConf() const;


    RingSetConf_v1& operator=(const RingSetConf_v1& clrings);
 
};

//==============================================================================
inline
RingSetConf_v1::RingSetConf_v1(){;}
 
//==============================================================================
inline
RingSetConf_v1::RingSetConf_v1(const RingSetConf_v1& ringsetconf) : 
  SG::AuxElement(ringsetconf)
{
  this->makePrivateStore(ringsetconf);
}
 
//==============================================================================
inline
RingSetConf_v1::RawConf::RawConf()
  : nRings(0),
    etaWidth(0),   
    phiWidth(0), 
    cellMaxDEtaDist(0),
    cellMaxDPhiDist(0),
    calJointLayer(Ringer::CalJointLayer::UnknownJointLayer),
    calJointSection(Ringer::CalJointSection::UnknownJointSection),
    doEtaAxesDivision(false),
    doPhiAxesDivision(false),
    layerStartIdx(0),
    layerEndIdx(0),
    sectionStartIdx(0),
    sectionEndIdx(0){;}

 
} // End of namespace xAOD
 
#include "xAODCore/BaseInfo.h"
SG_BASE ( xAOD::RingSetConf_v1, SG::AuxElement );
 
#endif // XAODCALORINGS_VERSIONS_RINGSETCONF_V1_H