CDCRLWireHit.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
#pragma once
 
#include <cdc/topology/EStereoKind.h>
#include <cdc/topology/ISuperLayer.h>
 
#include <tracking/trackingUtilities/numerics/ERightLeft.h>
#include <tracking/trackingUtilities/numerics/Index.h>
#include <tracking/trackingUtilities/numerics/ESign.h>
 
#include <Math/Vector2D.h>
 
#include <iosfwd>
 
 
 
namespace Belle2 {
  class CDCSimHit;
  class CDCHit;
  class WireID;
 
  namespace CDC {
    class CDCWire;
  }
  namespace TrackingUtilities {
    class CDCTrajectory2D;
    class CDCWireHit;
    class Vector3D;
    class Vector2D;

    class CDCRLWireHit {
 
    public:
      CDCRLWireHit() = default;

      explicit CDCRLWireHit(const CDCWireHit* wireHit,
                            ERightLeft rlInfo = ERightLeft::c_Unknown);

      CDCRLWireHit(const CDCWireHit* wireHit,
                   ERightLeft rlInfo,
                   double driftLength,
                   double driftLengthVariance);

      static CDCRLWireHit average(const CDCRLWireHit& rlWireHit1, const CDCRLWireHit& rlWireHit2);

      static CDCRLWireHit average(const CDCRLWireHit& rlWireHit1,
                                  const CDCRLWireHit& rlWireHit2,
                                  const CDCRLWireHit& rlWireHit3);

      static CDCRLWireHit fromSimHit(const CDCWireHit* wirehit, const CDCSimHit& simhit);

      CDCRLWireHit reversed() const
      {
        return CDCRLWireHit(m_wireHit,
                            NRightLeft::reversed(m_rlInfo),
                            m_refDriftLength,
                            m_refDriftLengthVariance);
      }

      void reverse()
      {
        m_rlInfo = NRightLeft::reversed(m_rlInfo);
      }

      CDCRLWireHit getAlias() const
      {
        return reversed();
      }

      bool operator==(const CDCRLWireHit& rhs) const
      {
        return &getWireHit() == &rhs.getWireHit() and getRLInfo() == rhs.getRLInfo();
      }

      bool operator<(const CDCRLWireHit& rhs) const
      {
        return &getWireHit() < &rhs.getWireHit() or
               (&getWireHit() == &rhs.getWireHit() and (getRLInfo() < rhs.getRLInfo()));
      }

      friend bool operator<(const CDCRLWireHit& rlWireHit, const CDC::CDCWire& wire)
      {
        return &rlWireHit.getWire() < &wire;
      }

      friend bool operator<(const CDC::CDCWire& wire, const CDCRLWireHit& rlWireHit)
      {
        return &wire < &rlWireHit.getWire();
      }

      friend bool operator<(const CDCRLWireHit& rlWireHit, const CDCWireHit& wireHit)
      {
        return &rlWireHit.getWireHit() < &wireHit;
      }

      friend bool operator<(const CDCWireHit& wireHit, const CDCRLWireHit& rlWireHit)
      {
        return &wireHit < rlWireHit.m_wireHit;
      }

      operator const Belle2::CDCHit* () const
      {
        return getHit();
      }

      const CDCHit* getHit() const;

      Index getStoreIHit() const { return m_iHit; }

      const CDC::CDCWire& getWire() const;

      bool isOnWire(const CDC::CDCWire& wire) const
      {
        return &getWire() == &wire;
      }

      const WireID& getWireID() const;

      CDC::ISuperLayer getISuperLayer() const;

      CDC::EStereoKind getStereoKind() const;

      bool isAxial() const;

      const ROOT::Math::XYVector& getRefPos2D() const;

      double getRefCylindricalR() const;

      const CDCWireHit& getWireHit() const
      {
        return *m_wireHit;
      }

      bool hasWireHit(const CDCWireHit& wirehit) const
      {
        return &getWireHit() == &wirehit;
      }

      double getRefDriftLength() const
      {
        return m_refDriftLength;
      }

      void setRefDriftLength(double driftLength)
      {
        m_refDriftLength = driftLength;
      }

      double getSignedRefDriftLength() const
      {
        return static_cast<double>(getRLInfo()) * getRefDriftLength();
      }

      double getRefDriftLengthVariance() const
      {
        return m_refDriftLengthVariance;
      }

      void setRefDriftLengthVariance(double driftLengthVariance)
      {
        m_refDriftLengthVariance = driftLengthVariance;
      }

      ERightLeft getRLInfo() const
      {
        return m_rlInfo;
      }

      void setRLInfo(const ERightLeft rlInfo)
      {
        m_rlInfo = rlInfo;
      }

      Vector2D reconstruct2D(const CDCTrajectory2D& trajectory2D) const;

      Vector3D reconstruct3D(const CDCTrajectory2D& trajectory2D, double z = 0) const;
 
    private:
      // index instead.
      const CDCWireHit* m_wireHit = nullptr; 

      Index m_iHit = c_InvalidIndex;

      double m_refDriftLength = 0.0;

      double m_refDriftLengthVariance = 0.0;

      ERightLeft m_rlInfo = ERightLeft::c_Unknown;
    };

    std::ostream& operator<<(std::ostream& output, const CDCRLWireHit& rlWireHit);
  }
}