ThreeHitVariables.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/vxdHoughTracking/filters/pathFilters/TwoHitVariables.h>
#include <tracking/spacePointCreation/SpacePoint.h>
#include <framework/geometry/B2Vector3.h>
 
#include <cmath>
#include <boost/math/special_functions/sign.hpp>
 
namespace Belle2 {
  namespace vxdHoughTracking {
 
    class ThreeHitVariables {
    public:
      ThreeHitVariables() : m_oHit(0., 0., 0.), m_cHit(0., 0., 0.), m_iHit(0., 0., 0.),
        m_outerDifferenceVector(0., 0., 0.), m_innerDifferenceVector(0., 0., 0.)
      {};
 
      ThreeHitVariables(const B2Vector3D& oHit, const B2Vector3D& cHit, const B2Vector3D& iHit) :
        m_oHit(oHit), m_cHit(cHit), m_iHit(iHit)
      {
        m_outerDifferenceVector = oHit - cHit;
        m_innerDifferenceVector = cHit - iHit;
      };
 
      void setHits(const B2Vector3D& oHit, const B2Vector3D& cHit, const B2Vector3D& iHit)
      {
        m_oHit = oHit;
        m_oHit = oHit;
        m_iHit = iHit;
        m_outerDifferenceVector = oHit - cHit;
        m_innerDifferenceVector = cHit - iHit;
      }
 
      double calcAvgDistanceXY(const B2Vector3D& circleCenter)
      {
        return (sqrt(std::pow(circleCenter.X() - m_oHit.X(), 2) + std::pow(circleCenter.Y() - m_oHit.Y(), 2)) +
                sqrt(std::pow(circleCenter.X() - m_cHit.X(), 2) + std::pow(circleCenter.Y() - m_cHit.Y(), 2)) +
                sqrt(std::pow(circleCenter.X() - m_iHit.X(), 2) + std::pow(circleCenter.Y() - m_iHit.Y(), 2))) / 3.;
      }
 
 
      double getAngle3D()
      {
        double result = acos(m_outerDifferenceVector.Dot(m_innerDifferenceVector) /
                             (m_outerDifferenceVector.Mag() * m_innerDifferenceVector.Mag())); // 0-pi
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      }
 
 
      double getAngle3DSimple()
      {
        // fullCalc would be acos(m_vecAB.Dot(m_vecBC) / m_vecAB.Mag()*m_vecBC.Mag()), but here time-consuming parts have been neglected
        double result = m_outerDifferenceVector.Dot(m_innerDifferenceVector) /
                        (m_outerDifferenceVector.Mag2() * m_innerDifferenceVector.Mag2());
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      }
 
 
      double getAngleRZ()
      {
        B2Vector3D rzVecAB(m_outerDifferenceVector.Perp(), m_outerDifferenceVector.Z(), 0.);
        B2Vector3D rzVecBC(m_innerDifferenceVector.Perp(), m_innerDifferenceVector.Z(), 0.);
        TwoHitVariables twoHitVariables(rzVecAB, rzVecBC);
 
        double result = acos(twoHitVariables.getCosXY());  // 0-pi
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      } // return unit: rad (0 - pi)
 
 
      double getCosAngleRZSimple()
      {
        B2Vector3D rzVecAB(m_outerDifferenceVector.Perp(), m_outerDifferenceVector.Z(), 0.);
        B2Vector3D rzVecBC(m_innerDifferenceVector.Perp(), m_innerDifferenceVector.Z(), 0.);
        TwoHitVariables twoHitVariables(rzVecAB, rzVecBC);
 
        return twoHitVariables.getCosXY();
      }
 
      double getAngleXY()
      {
        TwoHitVariables twoHitVariables(m_outerDifferenceVector, m_innerDifferenceVector);
        double result = acos(twoHitVariables.getCosXY());   // 0-pi
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      }
 
 
      B2Vector3D getCircleCenterXY()
      {
        // calculates the intersection point using Cramer's rule.
        // x_1+s*n_1==x_2+t*n_2 --> n_1 *s - n_2 *t == x_2 - x_1 --> http://en.wikipedia.org/wiki/Cramer%27s_rule
        double inX = m_cHit.X() - m_iHit.X(); // x value of the normal vector of the inner segment (m_cHit-m_iHit)
        double inY = m_cHit.Y() - m_iHit.Y(); // y value of the normal vector of the inner segment (m_cHit-m_iHit)
        double outX = m_oHit.X() - m_cHit.X(); // x value of the normal vector of the outer segment (m_oHit-m_cHit)
        double outY = m_oHit.Y() - m_cHit.Y(); // y value of the normal vector of the outer segment (m_oHit-m_cHit)
 
        // searching solution for Ax = b, aij are the matrix elements of A, bi are elements of b
        double a11 = inY;
        double a12 = -inX;
        double a21 = -outY;
        double a22 = outX;
        double b1 = m_cHit.X() + outX * 0.5 - (m_iHit.X() + inX * 0.5);
        double b2 = m_cHit.Y() + outY * 0.5 - (m_iHit.Y() + inY * 0.5);
 
        // protect against the determinant being zero
        if (a11 * a22 == a12 * a21) {
          return B2Vector3D(1e30, 1e30, 1e30);
        }
 
        // the determinant is zero if the three hits are on a line in (x,y), which is checked above.
        double s = (b1 * a22 - b2 * a21) / (a11 * a22 - a12 * a21);
 
        return B2Vector3D(m_iHit.X() + inX * 0.5 + s * inY, m_iHit.Y() + inY * 0.5 - s * inX, 0.);
      }
 
 
      double getCircleDistanceIP()
      {
        B2Vector3D circleCenter = getCircleCenterXY();
        if (circleCenter.Perp2() > 1e30) {
          return NAN;
        }
        double circleRadius = calcAvgDistanceXY(circleCenter);
 
        // distance of closest approach of circle to the IP :
        // WARNING only valid for IP=0,0,X
        return (fabs(circleCenter.Perp() - circleRadius));
      }
 
 
      double getCircleRadius()
      {
        B2Vector3D circleCenter = getCircleCenterXY();
        if (circleCenter.Perp2() > 1e30) {
          return NAN;
        }
        return calcAvgDistanceXY(circleCenter);
      }
 
 
      double getCosAngleXY()
      {
        double result = (m_outerDifferenceVector.X() * m_innerDifferenceVector.X() +
                         m_outerDifferenceVector.Y() * m_innerDifferenceVector.Y()) /
                        (m_outerDifferenceVector.Perp() * m_innerDifferenceVector.Perp());
 
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      }
 
 
      double getDeltaSlopeRZ()
      {
        TwoHitVariables outerTwoHitVariables(m_oHit, m_cHit);
        TwoHitVariables innerTwoHitVariables(m_cHit, m_iHit);
        double slopeOC = outerTwoHitVariables.getRZSlope();
        double slopeCI = innerTwoHitVariables.getRZSlope();
 
        return slopeCI - slopeOC;
      }
 
 
      double getDeltaSlopeZoverS()
      {
        B2Vector3D circleCenter = getCircleCenterXY();
        if (circleCenter.Perp2() > 1e30) {
          return NAN;
        }
        double circleRadius = calcAvgDistanceXY(circleCenter);
        B2Vector3D vecOuter2cC  = m_oHit - circleCenter;
        B2Vector3D vecCenter2cC = m_cHit - circleCenter;
        B2Vector3D vecInner2cC  = m_iHit - circleCenter;
 
        TwoHitVariables outerTwoHitVariables(vecOuter2cC, vecCenter2cC);
        TwoHitVariables innerTwoHitVariables(vecCenter2cC, vecInner2cC);
 
        // WARNING: this is only approximately S (valid in the limit of small angles) but might be OK for this use!!!
        //  want to replace id with 2*sin ( alfa ) * circleRadius
        double alfaOCr = acos(outerTwoHitVariables.getCosXY()) * circleRadius ;
        double alfaCIr = acos(innerTwoHitVariables.getCosXY()) * circleRadius ;
 
        // Beware of z>r!:
        double result = (asin(double(m_oHit.Z() - m_cHit.Z()) / alfaOCr)) - asin(double(m_cHit.Z() - m_iHit.Z()) / alfaCIr);
 
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      }
 
 
      double getDeltaSoverZ()
      {
        B2Vector3D circleCenter = getCircleCenterXY();
        if (circleCenter.Perp2() > 1e30) {
          return NAN;
        }
        B2Vector3D vecOuter2cC  = m_oHit - circleCenter;
        B2Vector3D vecCenter2cC = m_cHit - circleCenter;
        B2Vector3D vecInner2cC  = m_iHit - circleCenter;
 
        TwoHitVariables outerTwoHitVariables(vecOuter2cC, vecCenter2cC);
        TwoHitVariables innerTwoHitVariables(vecCenter2cC, vecInner2cC);
        double alfaOC = acos(outerTwoHitVariables.getCosXY());
        double alfaCI = acos(innerTwoHitVariables.getCosXY());
 
        // equals to alfaAB/dZAB and alfaBC/dZBC, but this solution here can not produce a division by zero:
        return (alfaOC * double(m_cHit.Z() - m_iHit.Z())) - (alfaCI * double(m_oHit.Z() - m_cHit.Z()));
      }
 
 
      double performHelixParamterFit()
      {
        B2Vector3D circleCenter = getCircleCenterXY();
        if (circleCenter.Perp2() > 1e30) {
          return NAN;
        }
 
        B2Vector3D vecOuter2cC  = m_oHit - circleCenter;
        B2Vector3D vecCenter2cC = m_cHit - circleCenter;
        B2Vector3D vecInner2cC  = m_iHit - circleCenter;
        TwoHitVariables outerTwoHitVariables(vecOuter2cC, vecCenter2cC);
        TwoHitVariables innerTwoHitVariables(vecCenter2cC, vecInner2cC);
 
        double alfaAB = outerTwoHitVariables.getCosXY();
        double alfaBC = innerTwoHitVariables.getCosXY();
 
        // real calculation: ratio is (m_vecij[2] = deltaZ): alfaAB/deltaZab : alfaBC/deltaZbc, the following equation saves two times '/'
        double result = (alfaAB * double(m_cHit.Z() - m_iHit.Z())) / (alfaBC * double(m_oHit.Z() - m_cHit.Z()));
 
        return (std::isnan(result) || std::isinf(result)) ? double(0) : result;
      }
 
 
      double getSimplePTEstimate()
      {
        B2Vector3D circleCenter = getCircleCenterXY();
        if (circleCenter.Perp2() > 1e30) {
          return NAN;
        }
        double circleRadius = calcAvgDistanceXY(circleCenter);
 
        return 0.00299792458 * m_BFieldZ * circleRadius;
      }
 
 
      int getCurvatureSign()
      {
        using boost::math::sign;
        B2Vector3D ba(m_oHit.X() - m_cHit.X(), m_oHit.Y() - m_cHit.Y(), 0.0);
        B2Vector3D bc(m_cHit.X() - m_iHit.X(), m_cHit.Y() - m_iHit.Y(), 0.0);
        return sign(bc.Orthogonal() * ba); //normal vector of m_vecBC times segment of ba
      }
 
      int getCurvatureSign(const B2Vector3D& oHit, const B2Vector3D& cHit, const B2Vector3D& iHit)
      {
        using boost::math::sign;
        B2Vector3D ba(oHit.X() - cHit.X(), oHit.Y() - cHit.Y(), 0.0);
        B2Vector3D bc(cHit.X() - iHit.X(), cHit.Y() - iHit.Y(), 0.0);
        return sign(bc.Orthogonal() * ba); //normal vector of m_vecBC times segment of ba
      }
 
      void setBFieldZ(const double bfieldZ = 1.5) { m_BFieldZ = bfieldZ; }
 
    private:
      double m_BFieldZ = 1.5;
      B2Vector3D m_oHit;
      B2Vector3D m_cHit;
      B2Vector3D m_iHit;
      B2Vector3D m_outerDifferenceVector;
      B2Vector3D m_innerDifferenceVector;
 
    };
  }
}