CDCTrajectory3D.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 <tracking/trackingUtilities/geometry/UncertainHelix.h>
#include <tracking/trackingUtilities/geometry/Helix.h>
#include <tracking/trackingUtilities/geometry/HelixParameters.h>
 
#include <tracking/trackingUtilities/numerics/ESign.h>
 
#include <Math/Vector3D.h>
#include <Math/Vector2D.h>
 
#include <TMath.h>
#include <cmath>
#include <cstddef>
#include <iosfwd>
 
namespace genfit {
  class TrackCand;
}
 
namespace Belle2 {
  class MCParticle;
  namespace CDC {
    class WireLine;
  }
 
  namespace TrackingUtilities {
    class CDCTrajectory2D;
    class CDCTrajectorySZ;
 
    class UncertainPerigeeCircle;
    class UncertainSZLine;

    class CDCTrajectory3D {
 
    public:
      CDCTrajectory3D()
        : m_localOrigin()
        , m_localHelix()
      {
      }

      explicit CDCTrajectory3D(const UncertainHelix& helix)
        : m_localOrigin(0.0, 0.0, 0.0)
        , m_localHelix(helix)
        , m_flightTime(0.0)
      {
      }

      explicit CDCTrajectory3D(const Helix& helix) : CDCTrajectory3D(UncertainHelix(helix))
      {
      }

      CDCTrajectory3D(const ROOT::Math::XYZVector& localOrigin,
                      const UncertainHelix& localHelix,
                      double flightTime = NAN)
        : m_localOrigin(localOrigin)
        , m_localHelix(localHelix)
        , m_flightTime(flightTime)
      {
      }

      CDCTrajectory3D(const CDCTrajectory2D& trajectory2D, const CDCTrajectorySZ& trajectorySZ);

      explicit CDCTrajectory3D(const CDCTrajectory2D& trajectory2D);

      CDCTrajectory3D(const ROOT::Math::XYZVector& pos3D,
                      double time,
                      const ROOT::Math::XYZVector& mom3D,
                      double charge,
                      double bZ);

      CDCTrajectory3D(const ROOT::Math::XYZVector& pos3D, double time, const ROOT::Math::XYZVector& mom3D, double charge);

      CDCTrajectory3D(const MCParticle& mcParticle, double bZ);

      explicit CDCTrajectory3D(const MCParticle& mcParticle);

      CDCTrajectory3D(const genfit::TrackCand& gfTrackCand, double bZ);

      explicit CDCTrajectory3D(const genfit::TrackCand& gfTrackCand);
 
    public:
      bool isInvalid() const
      {
        return m_localHelix->isInvalid();
      }

      bool isFitted() const
      {
        return not isInvalid();
      }

      void clear()
      {
        m_localOrigin.SetXYZ(0.0, 0.0, 0.0);
        m_localHelix.invalidate();
        m_flightTime = NAN;
      }
 
    public:
      bool fillInto(genfit::TrackCand& trackCand) const;

      bool fillInto(genfit::TrackCand& gfTrackCand, double bZ) const;

      CovarianceMatrix<6> getCartesianCovariance(double bZ) const;
 
    public:
      void reverse()
      {
        m_localHelix.reverse();
        m_flightTime = -m_flightTime;
      }

      CDCTrajectory3D reversed() const
      {
        return CDCTrajectory3D(getLocalOrigin(), getLocalHelix().reversed(), -getFlightTime());
      }

      ROOT::Math::XYZVector reconstruct3D(const CDC::WireLine& wireLine, double distance = 0.0) const;

      double calcArcLength2D(const ROOT::Math::XYZVector& point) const
      {
        return getLocalHelix()->circleXY().arcLengthTo(VectorUtil::getXYVector(point - getLocalOrigin()));
      }

      double getArcLength2DPeriod() const
      {
        return getLocalHelix()->arcLength2DPeriod();
      }
 
    public:
      double shiftPeriod(int nPeriods);
 
    public:
      ESign getChargeSign() const;

      double getAbsMom3D(double bZ) const;

      double getAbsMom3D() const;

      ROOT::Math::XYZVector getMom3DAtSupport(const double bZ) const
      {
        return getFlightDirection3DAtSupport() * getAbsMom3D(bZ);
      }

      ROOT::Math::XYZVector getMom3DAtSupport() const
      {
        return getFlightDirection3DAtSupport() * getAbsMom3D();
      }

      ROOT::Math::XYZVector getFlightDirection3DAtSupport() const
      {
        return getLocalHelix()->tangential();
      }

      ROOT::Math::XYZVector getSupport() const
      {
        return getLocalHelix()->perigee() + getLocalOrigin();
      }

      ROOT::Math::XYZVector getGlobalPerigee() const
      {
        return getLocalHelix()->closestXY(-VectorUtil::getXYVector(m_localOrigin)) + m_localOrigin;
      }

      ROOT::Math::XYVector getGlobalCenter() const
      {
        return getLocalHelix()->centerXY() + VectorUtil::getXYVector(m_localOrigin);
      }
 
    public:
      bool isCurler(double factor = 1) const;

      double getMaximalCylindricalR() const
      {
        return std::fabs(getGlobalImpact() + 2 * getLocalHelix()->radiusXY());
      }

      double getMinimalCylindricalR() const
      {
        return std::fabs(getGlobalImpact());
      }

      double getGlobalImpact() const
      {
        return getLocalHelix()->distanceXY(-VectorUtil::getXYVector(m_localOrigin));
      }
 
    public:
      CDCTrajectory2D getTrajectory2D() const;

      CDCTrajectorySZ getTrajectorySZ() const;

      PerigeeCircle getGlobalCircle() const;

      UncertainPerigeeCircle getLocalCircle() const;

      UncertainSZLine getLocalSZLine() const;

      double getLocalCovariance(EHelixParameter iRow, EHelixParameter iCol) const
      {
        return getLocalHelix().covariance(iRow, iCol);
      }

      double getLocalVariance(EHelixParameter i) const
      {
        return getLocalHelix().variance(i);
      }

      double getTanLambda() const
      {
        return getLocalHelix()->tanLambda();
      }

      double getCurvatureXY() const
      {
        return getLocalHelix()->curvatureXY();
      }

      double getPValue() const
      {
        return TMath::Prob(getChi2(), getNDF());
      }

      double getChi2() const
      {
        return getLocalHelix().chi2();
      }

      void setChi2(const double chi2)
      {
        return m_localHelix.setChi2(chi2);
      }

      size_t getNDF() const
      {
        return getLocalHelix().ndf();
      }

      void setNDF(std::size_t ndf)
      {
        return m_localHelix.setNDF(ndf);
      }

      const UncertainHelix& getLocalHelix() const
      {
        return m_localHelix;
      }

      void setLocalHelix(const UncertainHelix& localHelix)
      {
        m_localHelix = localHelix;
      }

      const ROOT::Math::XYZVector& getLocalOrigin() const
      {
        return m_localOrigin;
      }

      double setLocalOrigin(const ROOT::Math::XYZVector& localOrigin);

      double getFlightTime() const
      {
        return m_flightTime;
      }

      void setFlightTime(double flightTime)
      {
        m_flightTime = flightTime;
      }
    private:
      ROOT::Math::XYZVector m_localOrigin;

      UncertainHelix m_localHelix;

      double m_flightTime = NAN;
    };

    std::ostream& operator<<(std::ostream& output, const CDCTrajectory3D& trajectory3D);
  }
}