RawCluster.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file RawCluster.h

#ifndef CALOBASE_RAWCLUSTER_H
#define CALOBASE_RAWCLUSTER_H

#include "RawClusterDefs.h"
#include "RawTowerDefs.h"

#include <phool/PHObject.h>
#include <phool/phool.h>

#include <CLHEP/Vector/ThreeVector.h>

#include <climits>
#include <cmath>  // def of NAN
#include <cstddef>
#include <iostream>
#include <map>
#include <string>  // for string
#include <type_traits>
#include <utility>

class RawCluster : public PHObject
{
 public:
  typedef std::map<RawTowerDefs::keytype, float> TowerMap;
  typedef TowerMap::iterator TowerIterator;
  typedef TowerMap::const_iterator TowerConstIterator;
  typedef std::pair<TowerIterator, TowerIterator> TowerRange;
  typedef std::pair<TowerConstIterator, TowerConstIterator> TowerConstRange;

  ~RawCluster() override {}
  void Reset() override { PHOOL_VIRTUAL_WARNING; }

  PHObject* CloneMe() const override { return nullptr; }

  int isValid() const override
  {
    PHOOL_VIRTUAL_WARNING;
    return 0;
  }
  void identify(std::ostream& /*os*/ = std::cout) const override { PHOOL_VIRTUAL_WARNING; }

  virtual RawClusterDefs::keytype get_id() const
  {
    PHOOL_VIRTUAL_WARN("get_id()");
    return 0;
  }
  virtual float get_energy() const
  {
    PHOOL_VIRTUAL_WARN("get_energy()");
    return NAN;
  }
  virtual size_t getNTowers() const
  {
    PHOOL_VIRTUAL_WARNING;
    return 0;
  }
  virtual TowerConstRange get_towers() const
  {
    PHOOL_VIRTUAL_WARN("get_towers()");
    static TowerMap dummy;
    return make_pair(dummy.begin(), dummy.end());
  }
  virtual const TowerMap& get_towermap() const
  {
    PHOOL_VIRTUAL_WARN("get_towers()");
    static TowerMap dummy;
    return dummy;
  }

  virtual CLHEP::Hep3Vector get_position() const
  {
    PHOOL_VIRTUAL_WARN("get_position()");
    return CLHEP::Hep3Vector(NAN, NAN, NAN);
  }
  //
  virtual float get_phi() const
  {
    PHOOL_VIRTUAL_WARN("get_phi()");
    return NAN;
  }
  virtual float get_r() const
  {
    PHOOL_VIRTUAL_WARN("get_r()");
    return NAN;
  }
  virtual float get_z() const
  {
    PHOOL_VIRTUAL_WARN("get_z()");
    return NAN;
  }
  //


  virtual float get_x() const
  {
    PHOOL_VIRTUAL_WARN("get_x()");
    return NAN;
  }
  virtual float get_y() const
  {
    PHOOL_VIRTUAL_WARN("get_y()");
    return NAN;
  }
  //
  virtual float get_ecore() const
  {
    PHOOL_VIRTUAL_WARN("get_ecore()");
    return NAN;
  }
  virtual float get_chi2() const
  {
    PHOOL_VIRTUAL_WARN("get_chi2()");
    return NAN;
  }
  virtual float get_prob() const
  {
    PHOOL_VIRTUAL_WARN("get_prob()");
    return NAN;
  }
  virtual float get_et_iso() const
  {
    PHOOL_VIRTUAL_WARN("get_et_iso()");
    return NAN;
  }
  virtual float get_et_iso(const int /*radiusx10*/, bool /*subtracted*/, bool /*clusterTower*/) const
  {
    PHOOL_VIRTUAL_WARN("get_et_iso(const int radiusx10, bool subtracted, bool clusterTower)");
    return NAN;
  }

  //  //! truth cluster's PHG4Particle ID
  //  virtual int get_truth_track_ID() const
  //  {
  //    PHOOL_VIRTUAL_WARN("get_truth_track_ID()");
  //    return 0;
  //  }
  //  //! truth cluster's PHG4Particle flavor
  //  virtual int get_truth_flavor() const
  //  {
  //    PHOOL_VIRTUAL_WARN("get_truth_flavor()");
  //    return 0;
  //  }
  //  // end of getters


  virtual void set_id(const RawClusterDefs::keytype) { PHOOL_VIRTUAL_WARNING; }
  virtual void addTower(const RawClusterDefs::keytype /*twrid*/, const float /*etower*/) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_energy(const float) { PHOOL_VIRTUAL_WARNING; }
  //
  virtual void set_phi(const float) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_z(const float) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_r(const float) { PHOOL_VIRTUAL_WARNING; }
  //
  virtual void set_ecore(const float) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_chi2(const float) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_prob(const float) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_et_iso(const float) { PHOOL_VIRTUAL_WARNING; }
  virtual void set_et_iso(const float /*e*/, const int /*radiusx10*/, bool /*subtracted*/, bool /*clusterTower*/) { PHOOL_VIRTUAL_WARNING; }
  //  //! truth cluster's PHG4Particle ID
  //  virtual void set_truth_track_ID(const int) { PHOOL_VIRTUAL_WARNING; }
  //  //! truth cluster's PHG4Particle flavor
  //  virtual void set_truth_flavor(const int) { PHOOL_VIRTUAL_WARNING; }
  //
  /*
   *
   * @} */
  // end of setters

 public:
  enum PROPERTY
  {  //
    // ----- additional cluster properties -----
    prop_ecore = 0,
    prop_prob = 1,
    prop_chi2 = 2,

    // ----- analysis specific quantities -----
    prop_et_iso_calotower_sub_R01 = 20,
    prop_et_iso_calotower_R01 = 21,
    prop_et_iso_calotower_sub_R02 = 22,
    prop_et_iso_calotower_R02 = 23,
    prop_et_iso_calotower_sub_R03 = 24,
    prop_et_iso_calotower_R03 = 25,
    prop_et_iso_calotower_sub_R04 = 26,
    prop_et_iso_calotower_R04 = 27,
    //    // ----- truth cluster quantities -----
    //    //! truth cluster's PHG4Particle ID
    //    prop_truth_track_ID = 100,
    //    //! truth cluster's PHG4Particle flavor
    //    prop_truth_flavor = 101,

    prop_MAX_NUMBER = UCHAR_MAX
  };

  enum PROPERTY_TYPE
  {  //
    type_int = 1,
    type_uint = 2,
    type_float = 3,
    type_unknown = -1
  };

  virtual bool has_property(const PROPERTY /*prop_id*/) const { return false; }
  virtual float get_property_float(const PROPERTY /*prop_id*/) const { return NAN; }
  virtual int get_property_int(const PROPERTY /*prop_id*/) const { return INT_MIN; }
  virtual unsigned int get_property_uint(const PROPERTY /*prop_id*/) const { return UINT_MAX; }
  virtual void set_property(const PROPERTY /*prop_id*/, const float /*value*/) { return; }
  virtual void set_property(const PROPERTY /*prop_id*/, const int /*value*/) { return; }
  virtual void set_property(const PROPERTY /*prop_id*/, const unsigned int /*value*/) { return; }
  static std::pair<const std::string, PROPERTY_TYPE> get_property_info(PROPERTY prop_id);
  static bool check_property(const PROPERTY prop_id, const PROPERTY_TYPE prop_type);
  static std::string get_property_type(const PROPERTY_TYPE prop_type);
  // end of property map definitions

 protected:
  RawCluster() {}  // make sure nobody calls ctor of base class
  ClassDefOverride(RawCluster, 1)
};

#endif