RecoVertex/VertexTools/interface/PerigeeLinearizedTrackState.h - master - githubmirror/cmssw

RecoVertex/VertexTools/interface/PerigeeLinearizedTrackState.h
267 строк9 KB
Ivan Razumov
Fix classes that inherit from LinearizedTrackState
22 июл 2024, 14:00
22 июл 2024, 14:006c125c7
#ifndef PerigeeLinearizedTrackState_H
#define PerigeeLinearizedTrackState_H

#include "RecoVertex/VertexPrimitives/interface/LinearizedTrackState.h"
#include "TrackingTools/PatternTools/interface/TSCPBuilderNoMaterial.h"
#include "DataFormats/GeometrySurface/interface/ReferenceCounted.h"
#include "RecoVertex/VertexPrimitives/interface/LinearizedTrackState.h"
#include "Math/SMatrix.h"
#include "DataFormats/CLHEP/interface/Migration.h"
#include "FWCore/Utilities/interface/Likely.h"

/** Calculates and stores the ImpactPointMeasurement of the
 *  impact point (point of closest approach in 3D) to the
 *  given linearization point.
 *  (see V.Karimaki, HIP-1997-77 / EXP)
 *
 *  Computes the parameters of the trajectory state at the transverse
 *  point of closest approach (in the global transverse plane) to
 *  the linearization point, and the jacobiam matrices.
 *  (see R.Fruehwirth et al. Data Analysis Techniques in HEP Experiments
 *  Second Edition, Cambridge University Press 2000, or
 *  R.Fruehwirth et al. Vertex reconstruction and track bundling at the LEP
 *  collider using robust algorithms. Computer Physics Communications 96
 *  (1996) 189-208).
 *
 *  Both are done `on-demand' to improve CPU performance.
 *
 *  This particular implementation works with "perigee"
 *  helix parametrization:
 *  see Billoir et al. NIM in PR A311(1992) 139-150
 */

class PerigeeLinearizedTrackState final : public LinearizedTrackState<5> {
public:
  /** Friend class properly dealing with creation
   *  of reference-counted pointers to LinearizedTrack objects
   */
  friend class LinearizedTrackStateFactory;
  typedef ReferenceCountingPointer<LinearizedTrackState<5> > RefCountedLinearizedTrackState;

  /**
   * Returns a new linearized state with respect to a new linearization point.
   * A new object of the same type is returned, without change to the existing one.
   */
  RefCountedLinearizedTrackState stateWithNewLinearizationPoint(const GlobalPoint& newLP) const override;

  /**
   * The point at which the track state has been linearized
   */
  const GlobalPoint& linearizationPoint() const override { return theLinPoint; }

  reco::TransientTrack track() const override { return theTrack; }

  const TrajectoryStateOnSurface state() const { return theTSOS; }

  /** Method returning the constant term of the Taylor expansion
   *  of the measurement equation
   */
  const AlgebraicVector5& constantTerm() const override;

  /** Method returning the Position Jacobian from the Taylor expansion
   *  (Matrix A)
   */
  const AlgebraicMatrix53& positionJacobian() const override;

  /** Method returning the Momentum Jacobian from the Taylor expansion
   *  (Matrix B)
   */
  const AlgebraicMatrix53& momentumJacobian() const override;

  /** Method returning the parameters of the Taylor expansion
   */
  const AlgebraicVector5& parametersFromExpansion() const override;

  /** Method returning the track state at the point of closest approach
   *  to the linearization point, in the transverse plane (a.k.a.
   *  transverse impact point).
   */
  const TrajectoryStateClosestToPoint& predictedState() const;

  /** Method returning the parameters of the track state at the
   *  transverse impact point.
   */
  AlgebraicVector5 predictedStateParameters() const override;

  /** Method returning the momentum part of the parameters of the track state
   *  at the linearization point.
   */
  AlgebraicVector3 predictedStateMomentumParameters() const override;

  /** Method returning the weight matrix of the track state at the
   *  transverse impact point.
   * The error variable is 0 in case of success.
   */
  AlgebraicSymMatrix55 predictedStateWeight(int& error) const override;

  /** Method returning the covariance matrix of the track state at the
   *  transverse impact point.
   */
  AlgebraicSymMatrix55 predictedStateError() const override;

  /** Method returning the momentum covariance matrix of the track state at the
   *  transverse impact point.
   */
  AlgebraicSymMatrix33 predictedStateMomentumError() const override;

  //   /** Method returning the impact point measurement
  //    */
  //   ImpactPointMeasurement impactPointMeasurement() const;

  TrackCharge charge() const override { return theCharge; }

  bool hasError() const override;

  bool operator==(const LinearizedTrackState<5>& other) const override;

  bool operator==(const ReferenceCountingPointer<LinearizedTrackState<5> >& other) const;

  /** Creates the correct refitted state according to the results of the
   *  track refit.
   */
  RefCountedRefittedTrackState createRefittedTrackState(const GlobalPoint& vertexPosition,
                                                        const AlgebraicVector3& vectorParameters,
                                                        const AlgebraicSymMatrix66& covarianceMatrix) const override;

  AlgebraicVector5 refittedParamFromEquation(const RefCountedRefittedTrackState& theRefittedState) const override;

  double weightInMixture() const override { return theTSOS.weight(); }

  void inline checkParameters(AlgebraicVector5& parameters) const override;

  std::vector<ReferenceCountingPointer<LinearizedTrackState<5> > > components() const override;

  bool isValid() const override;

private:
  /** Constructor with the linearization point and the track.
   *  Private, can only be used by LinearizedTrackFactory.
   */
  PerigeeLinearizedTrackState(const GlobalPoint& linP,
                              const reco::TransientTrack& track,
                              const TrajectoryStateOnSurface& tsos)
      : theLinPoint(linP), theTrack(track), theTSOS(tsos), theCharge(theTrack.charge()), jacobiansAvailable(false) {}

  /** Method calculating the track parameters and the Jacobians.
   */
  void computeJacobians() const;
  /** Method calculating the track parameters and the Jacobians for charged particles.
   */
  void computeChargedJacobians() const;
  /** Method calculating the track parameters and the Jacobians for neutral particles.
   */
  void computeNeutralJacobians() const;
  /** Method calculating the 3D impact point measurement
   */
  void compute3DImpactPoint() const;

  GlobalPoint theLinPoint;
  reco::TransientTrack theTrack;
  const TrajectoryStateOnSurface theTSOS;

  mutable AlgebraicMatrix53 thePositionJacobian, theMomentumJacobian;
  mutable TrajectoryStateClosestToPoint thePredState;
  mutable AlgebraicVector5 theConstantTerm;
  mutable AlgebraicVector5 theExpandedParams;

  TSCPBuilderNoMaterial builder;

  TrackCharge theCharge;
  mutable bool jacobiansAvailable;
};

/** Method returning the constant term of the Taylor expansion
 *  of the measurement equation
 */
inline const AlgebraicVector5& PerigeeLinearizedTrackState::constantTerm() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return theConstantTerm;
}

/**
 * Method returning the Position Jacobian (Matrix A)
 */
inline const AlgebraicMatrix53& PerigeeLinearizedTrackState::positionJacobian() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return thePositionJacobian;
}

/**      
 * Method returning the Momentum Jacobian (Matrix B)
 */
inline const AlgebraicMatrix53& PerigeeLinearizedTrackState::momentumJacobian() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return theMomentumJacobian;
}

/** Method returning the parameters of the Taylor expansion
 */
inline const AlgebraicVector5& PerigeeLinearizedTrackState::parametersFromExpansion() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return theExpandedParams;
}

/**
 * Method returning the TrajectoryStateClosestToPoint at the point
 * of closest approch to the z-axis (a.k.a. transverse impact point)
 */
inline const TrajectoryStateClosestToPoint& PerigeeLinearizedTrackState::predictedState() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return thePredState;
}

inline bool PerigeeLinearizedTrackState::hasError() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return thePredState.hasError();
}

inline AlgebraicVector5 PerigeeLinearizedTrackState::predictedStateParameters() const {
  if (!jacobiansAvailable)
    computeJacobians();
  return thePredState.perigeeParameters().vector();
}

inline AlgebraicVector3 PerigeeLinearizedTrackState::predictedStateMomentumParameters() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  auto v = thePredState.perigeeParameters().vector();
  return AlgebraicVector3(v[0], v[1], v[2]);
}

inline AlgebraicSymMatrix55 PerigeeLinearizedTrackState::predictedStateWeight(int& error) const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  if (!thePredState.isValid()) {
    error = 1;
    return AlgebraicSymMatrix55();
  }
  return thePredState.perigeeError().weightMatrix(error);
}

inline AlgebraicSymMatrix55 PerigeeLinearizedTrackState::predictedStateError() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return thePredState.perigeeError().covarianceMatrix();
}

inline AlgebraicSymMatrix33 PerigeeLinearizedTrackState::predictedStateMomentumError() const {
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return thePredState.perigeeError().covarianceMatrix().Sub<AlgebraicSymMatrix33>(0, 2);
}

inline bool PerigeeLinearizedTrackState::isValid() const {
  if UNLIKELY (!theTSOS.isValid())
    return false;
  if UNLIKELY (!jacobiansAvailable)
    computeJacobians();
  return jacobiansAvailable;
}

#endif