trkf::SurfYZLine Class Reference

#include "SurfYZLine.h"

Inheritance diagram for trkf::SurfYZLine:

Public Types
enum	TrackDirection { FORWARD, BACKWARD, UNKNOWN }
	Track direction enum. More...

Public Member Functions
	SurfYZLine ()
	Default constructor. More...
	SurfYZLine (double x0, double y0, double z0, double phi)
	Initializing constructor. More...
virtual	~SurfYZLine ()
	Destructor. More...
double	x0 () const
	X origin. More...
double	y0 () const
	Y origin. More...
double	z0 () const
	Z origin. More...
double	phi () const
	Rotation angle about x-axis. More...
virtual Surface *	clone () const
	Clone method. More...
virtual bool	isTrackValid (const TrackVector &vec) const
	Surface-specific tests of validity of track parameters. More...
virtual void	toLocal (const double xyz[3], double uvw[3]) const
	Transform global to local coordinates. More...
virtual void	toGlobal (const double uvw[3], double xyz[3]) const
	Transform local to global coordinates. More...
virtual TrackVector	getDiff (const TrackVector &vec1, const TrackVector &vec2) const
	Calculate difference of two track parameter vectors. More...
virtual void	getPosition (const TrackVector &vec, double xyz[3]) const
	Get position of track. More...
virtual void	getMomentum (const TrackVector &vec, double mom[3], TrackDirection dir=UNKNOWN) const
	Get momentum vector of track. More...
virtual bool	isParallel (const Surface &surf) const
	Test whether two surfaces are parallel, within tolerance. More...
virtual double	distanceTo (const Surface &surf) const
	Find perpendicular distance to a parallel surface. More...
virtual bool	isEqual (const Surface &surf) const
	Test two surfaces for equality, within tolerance. More...
virtual std::ostream &	Print (std::ostream &out) const
	Printout. More...
double	PointingError (const TrackVector &vec, const TrackError &err) const
	Get pointing error of track. More...
void	getStartingError (TrackError &err) const
	Get starting error matrix for Kalman filter. More...
virtual TrackDirection	getDirection (const TrackVector &, TrackDirection dir=UNKNOWN) const
	Get direction of track (default UNKNOWN). More...

Private Attributes
double	fX0
	X origin. More...
double	fY0
	Y origin. More...
double	fZ0
	Z origin. More...
double	fPhi
	Rotation angle about x-axis. More...

Static Private Attributes
static double	fPhiTolerance = 1.e-10
	Phi tolerance for parallel. More...
static double	fSepTolerance = 1.e-6
	Separation tolerance for equal. More...

Detailed Description

Definition at line 78 of file SurfYZLine.h.

Member Enumeration Documentation

enum trkf::Surface::TrackDirection

inherited

Track direction enum.

Enumerator
FORWARD
BACKWARD
UNKNOWN

Definition at line 54 of file Surface.h.

{ FORWARD, BACKWARD, UNKNOWN };

Constructor & Destructor Documentation

trkf::SurfYZLine::SurfYZLine

(

)

Default constructor.

Definition at line 25 of file SurfYZLine.cxx.

Referenced by clone(), and trkf::SurfWireLine::SurfWireLine().

: fX0(0.), fY0(0.), fZ0(0.), fPhi(0.) {}

trkf::SurfYZLine::SurfYZLine	(	double	x0,
		double	y0,
		double	z0,
		double	phi
	)

Initializing constructor.

Initializing constructor.

Arguments:

x0, y0, z0 - Global coordinates of local origin. phi - Rotation angle about x-axis.

Definition at line 34 of file SurfYZLine.cxx.

    : fX0(x0), fY0(y0), fZ0(z0), fPhi(phi)
  {}

trkf::SurfYZLine::~SurfYZLine ( )

virtual

Destructor.

Definition at line 39 of file SurfYZLine.cxx.

{}

Member Function Documentation

Surface * trkf::SurfYZLine::clone ( ) const

virtual

Clone method.

Implements trkf::Surface.

Definition at line 42 of file SurfYZLine.cxx.

References SurfYZLine().

Referenced by phi().

  {
    return new SurfYZLine(*this);
  }

double trkf::SurfYZLine::distanceTo ( const Surface &  surf ) const

virtual

Find perpendicular distance to a parallel surface.

Find perpendicular distance to a parallel surface.

Throw an exception if the other surface is not parallel.

Arguments:

surf - Other surface.

Returned value: Distance.

Implements trkf::Surface.

Definition at line 226 of file SurfYZLine.cxx.

References isParallel(), trkf::Surface::toGlobal(), and toLocal().

Referenced by phi().

  {
    // Check if the other surface is parallel to this one.

    bool parallel = isParallel(surf);
    if (!parallel)
      throw cet::exception("SurfYZLine") << "Attempt to find distance to non-parallel surface.\n";

    // Find the origin of the other surface in global coordinates,
    // then convert to our local coordinates.

    double otheruvw[3] = {0., 0., 0.};
    double xyz[3];
    double myuvw[3];
    surf.toGlobal(otheruvw, xyz);
    toLocal(xyz, myuvw);

    // Distance of v-axis to other surface origin.

    return std::hypot(myuvw[0], myuvw[2]);
  }

TrackVector trkf::SurfYZLine::getDiff ( const TrackVector &  vec1, const TrackVector &  vec2  ) const

virtual

Calculate difference of two track parameter vectors.

Calculate difference of two track parameter vectors, taking into account phi wrap.

Arguments:

vec1 - First vector. vec2 - Second vector.

Returns: vec1 - vec2

Reimplemented from trkf::Surface.

Definition at line 108 of file SurfYZLine.cxx.

Referenced by phi().

  {
    TrackVector result = vec1 - vec2;
    while (result(2) <= -TMath::Pi())
      result(2) += TMath::TwoPi();
    while (result(2) > TMath::Pi())
      result(2) -= TMath::TwoPi();
    return result;
  }

virtual TrackDirection trkf::Surface::getDirection ( const TrackVector &  , TrackDirection  dir = UNKNOWN  ) const

inlinevirtualinherited

Get direction of track (default UNKNOWN).

Definition at line 83 of file Surface.h.

References dir, trkf::Surface::distanceTo(), trkf::Surface::getMomentum(), trkf::Surface::getStartingError(), trkf::Surface::isEqual(), trkf::Surface::isParallel(), trkf::operator<<(), trkf::Surface::PointingError(), and trkf::Surface::Print().

Referenced by trkf::SurfYZPlane::getMomentum(), and trkf::SurfXYZPlane::getMomentum().

    {
      return dir;
    }

void trkf::SurfYZLine::getMomentum ( const TrackVector &  vec, double  mom[3], TrackDirection  dir = UNKNOWN  ) const

virtual

Get momentum vector of track.

Get momentum vector of track.

Arguments:

vec - Track state vector. mom - Momentum vector in global coordinate system. dir - Track direction (ignored).

Implements trkf::Surface.

Definition at line 152 of file SurfYZLine.cxx.

References util::abs(), e, fPhi, and phi().

Referenced by phi().

  {

    // Get momentum.

    double invp = std::abs(vec(4));
    double p = 1. / std::max(invp, 1.e-3); // Capped at 1000. GeV/c.

    // Get track direction parameters.

    double phi = vec(2);
    double eta = vec(3);

    double sinphi = std::sin(phi);
    double cosphi = std::cos(phi);
    double sh = 1. / std::cosh(eta); // sech(eta)
    double th = std::tanh(eta);

    // Calculate momentum vector in local coordinate system.

    double pu = p * cosphi * sh;
    double pv = p * th;
    double pw = p * sinphi * sh;

    // Rotate momentum to global coordinte system.

    double sinfphi = std::sin(fPhi);
    double cosfphi = std::cos(fPhi);

    mom[0] = pu;
    mom[1] = pv * cosfphi - pw * sinfphi;
    mom[2] = pv * sinfphi + pw * cosfphi;

    return;
  }

void trkf::SurfYZLine::getPosition ( const TrackVector &  vec, double  xyz[3]  ) const

virtual

Get position of track.

Get position of track.

Arguments:

vec - Track state vector. xyz - Position in global coordinate system.

Implements trkf::Surface.

Definition at line 125 of file SurfYZLine.cxx.

References phi(), and toGlobal().

Referenced by phi().

  {
    // Get position in local coordinate system.

    double phi = vec(2);
    double sinphi = std::sin(phi);
    double cosphi = std::cos(phi);

    double uvw[3];
    uvw[0] = -vec(0) * sinphi;
    uvw[1] = vec(1);
    uvw[2] = vec(0) * cosphi;

    // Transform to global coordinate system.

    toGlobal(uvw, xyz);
    return;
  }

void trkf::SurfLine::getStartingError ( TrackError &  err ) const

virtualinherited

Get starting error matrix for Kalman filter.

Get starting error matrix for Kalman filter.

Arguments:

err - Error matrix.

Implements trkf::Surface.

Definition at line 90 of file SurfLine.cxx.

  {
    err.resize(5, false);
    err.clear();
    err(0, 0) = 1000.;
    err(1, 1) = 1000.;
    err(2, 2) = 10.;
    err(3, 3) = 10.;
    err(4, 4) = 10.;
  }

bool trkf::SurfYZLine::isEqual ( const Surface &  surf ) const

virtual

Test two surfaces for equality, within tolerance.

Test two surfaces for equality, within tolerance. Here equal is defined as having all surface parameters the same, not just having the surfaces coincide spatially, so that the local coordinate systems are the same between the two surfaces.

Arguments:

surf - Other surface.

Returned values: true if equal.

Implements trkf::Surface.

Definition at line 259 of file SurfYZLine.cxx.

References util::abs(), fPhi, fPhiTolerance, fSepTolerance, fX0, fY0, fZ0, phi(), x0(), y0(), and z0().

Referenced by trkf::KHitWireLine::KHitWireLine(), and phi().

  {
    bool result = false;

    // Test if the other surface is a SurfYZLine.

    const SurfYZLine* psurf = dynamic_cast<const SurfYZLine*>(&surf);
    if (psurf != 0) {

      // Test whether surface parameters are the same within tolerance.

      double delta_phi = TVector2::Phi_mpi_pi(fPhi - psurf->phi());
      double dx = fX0 - psurf->x0();
      double dy = fY0 - psurf->y0();
      double dz = fZ0 - psurf->z0();
      if (std::abs(delta_phi) <= fPhiTolerance && std::abs(dx) <= fSepTolerance &&
          std::abs(dy) <= fSepTolerance && std::abs(dz) <= fSepTolerance)
        result = true;
    }
    return result;
  }

bool trkf::SurfYZLine::isParallel ( const Surface &  surf ) const

virtual

Test whether two surfaces are parallel, within tolerance.

Test whether two surfaces are parallel, within tolerance. This method will only return true if the other surface is a SurfYZLine.

Arguments:

surf - Other surface.

Returned value: true if parallel.

Implements trkf::Surface.

Definition at line 198 of file SurfYZLine.cxx.

References util::abs(), fPhi, fPhiTolerance, and phi().

Referenced by distanceTo(), and phi().

  {
    bool result = false;

    // Test if the other surface is a SurfYZLine.

    const SurfYZLine* psurf = dynamic_cast<const SurfYZLine*>(&surf);
    if (psurf != 0) {

      // Test whether surface angle parameters are the same
      // within tolerance.

      double delta_phi = TVector2::Phi_mpi_pi(fPhi - psurf->phi());
      if (std::abs(delta_phi) <= fPhiTolerance) result = true;
    }
    return result;
  }

bool trkf::SurfYZLine::isTrackValid ( const TrackVector &  vec ) const

virtual

Surface-specific tests of validity of track parameters.

Implements trkf::Surface.

Definition at line 48 of file SurfYZLine.cxx.

References util::abs().

Referenced by phi().

  {
    // Limit allowed range of eta parameter.

    return std::abs(vec(3)) < 10.;
  }

double trkf::SurfYZLine::phi ( ) const

inline

Rotation angle about x-axis.

Definition at line 93 of file SurfYZLine.h.

References clone(), dir, distanceTo(), fPhi, getDiff(), getMomentum(), getPosition(), isEqual(), isParallel(), isTrackValid(), Print(), toGlobal(), toLocal(), and trkf::Surface::UNKNOWN.

Referenced by getMomentum(), getPosition(), isEqual(), isParallel(), trkf::PropYZLine::origin_vec_prop(), trkf::PropYZLine::short_vec_prop(), and trkf::SurfWireLine::SurfWireLine().

double trkf::SurfLine::PointingError ( const TrackVector &  vec, const TrackError &  err  ) const

virtualinherited

Get pointing error of track.

Get pointing error of track.

Arguments:

vec - Track parameters. err - Track error matrix.

Returns: Pointing error.

This method calculates the track pointing error based on the slope track paramers and errors (parameters 2 and 3).

Implements trkf::Surface.

Definition at line 34 of file SurfLine.cxx.

  {
    // Get slope parameters and error matrix.

    double phi = vec(2);
    double eta = vec(3);
    double epp = err(2, 2); // sigma^2(phi,phi)
    double ehh = err(3, 3); // sigma^2(eta,eta)
    double ehp = err(3, 2); // sigma^2(eta,phi)

    // Calculate error matrix of pointing unit vector in some coordinate system.

    double sh = 1. / std::cosh(eta); // sech(eta)
    double sh2 = sh * sh;
    double sh3 = sh * sh2;
    double sh4 = sh * sh3;

    double th = std::tanh(eta);
    double th2 = th * th;

    double cphi = std::cos(phi);
    double cphi2 = cphi * cphi;

    double sphi = std::sin(phi);
    double sphi2 = sphi * sphi;

    double vxx = sh2 * th2 * cphi2 * ehh + sh2 * sphi2 * epp + 2. * sh2 * th * sphi * cphi * ehp;
    double vyy = sh2 * th2 * sphi2 * ehh + sh2 * cphi2 * epp - 2. * sh2 * th * sphi * cphi * ehp;
    double vzz = sh4 * epp;

    double vxy =
      sh2 * th2 * sphi * cphi * ehh - sh2 * sphi * cphi * epp - sh2 * th * (cphi2 - sphi2) * ehp;
    double vyz = -sh3 * th * sphi * ehh + sh3 * cphi * ehp;
    double vxz = -sh3 * th * cphi * ehh - sh3 * sphi * ehp;

    // For debugging.  The determinant of the error matrix should be zero.

    // double det = vxx*vyy*vzz + 2.*vxy*vyz*vxz - vxx*vyz*vyz - vyy*vxz*vxz - vzz*vxy*vxy;

    // Calculate square root of the largest eigenvalue of error matrix.

    double ddd2 = vxx * vxx + vyy * vyy + vzz * vzz - 2. * vxx * vyy - 2. * vxx * vzz -
                  2. * vyy * vzz + 4. * vxy * vxy + 4. * vyz * vyz + 4. * vxz * vxz;
    double ddd = sqrt(ddd2 > 0. ? ddd2 : 0.);
    double lambda2 = 0.5 * (vxx + vyy + vzz + ddd);
    double lambda = sqrt(lambda2 > 0. ? lambda2 : 0.);

    return lambda;
  }

std::ostream & trkf::SurfYZLine::Print ( std::ostream &  out ) const

virtual

Printout.

Implements trkf::Surface.

Definition at line 282 of file SurfYZLine.cxx.

References fPhi, fX0, fY0, and fZ0.

Referenced by phi().

  {
    out << "SurfYZLine{ x0=" << fX0 << ", y0=" << fY0 << ", z0=" << fZ0 << ", phi=" << fPhi << "}";
    return out;
  }

void trkf::SurfYZLine::toGlobal ( const double  uvw[3], double  xyz[3]  ) const

virtual

Transform local to global coordinates.

Transform local to global coordinates.

Arguments:

uvw - Cartesian coordinates in local coordinate system. xyz - Cartesian coordinates in global coordinate system.

Implements trkf::Surface.

Definition at line 84 of file SurfYZLine.cxx.

References fPhi, fX0, fY0, and fZ0.

Referenced by getPosition(), and phi().

  {
    double sinphi = std::sin(fPhi);
    double cosphi = std::cos(fPhi);

    // x = x0 + u
    xyz[0] = fX0 + uvw[0];

    // y = y0 + v*cos(phi) - w*sin(phi)
    xyz[1] = fY0 + uvw[1] * cosphi - uvw[2] * sinphi;

    // z = z0 + v*sin(phi) + w*cos(phi)
    xyz[2] = fZ0 + uvw[1] * sinphi + uvw[2] * cosphi;
  }

void trkf::SurfYZLine::toLocal ( const double  xyz[3], double  uvw[3]  ) const

virtual

Transform global to local coordinates.

Transform global to local coordinates.

Arguments:

xyz - Cartesian coordinates in global coordinate system. uvw - Cartesian coordinates in local coordinate system.

Implements trkf::Surface.

Definition at line 62 of file SurfYZLine.cxx.

References fPhi, fX0, fY0, and fZ0.

Referenced by distanceTo(), and phi().

  {
    double sinphi = std::sin(fPhi);
    double cosphi = std::cos(fPhi);

    // u = x-x0
    uvw[0] = xyz[0] - fX0;

    // v =  (y-y0)*cos(phi) + (z-z0)*sin(phi)
    uvw[1] = (xyz[1] - fY0) * cosphi + (xyz[2] - fZ0) * sinphi;

    // w = -(y-y0)*sin(phi) + (z-z0)*cos(phi)
    uvw[2] = -(xyz[1] - fY0) * sinphi + (xyz[2] - fZ0) * cosphi;
  }

double trkf::SurfYZLine::x0 ( ) const

inline

X origin.

Definition at line 90 of file SurfYZLine.h.

References fX0.

Referenced by isEqual(), and trkf::PropYZLine::short_vec_prop().

double trkf::SurfYZLine::y0 ( ) const

inline

Y origin.

Definition at line 91 of file SurfYZLine.h.

References fY0.

Referenced by isEqual(), and trkf::PropYZLine::short_vec_prop().

double trkf::SurfYZLine::z0 ( ) const

inline

Z origin.

Definition at line 92 of file SurfYZLine.h.

References fZ0.

Referenced by isEqual(), and trkf::PropYZLine::short_vec_prop().

Member Data Documentation

double trkf::SurfYZLine::fPhi

private

Rotation angle about x-axis.

Definition at line 141 of file SurfYZLine.h.

Referenced by getMomentum(), isEqual(), isParallel(), phi(), Print(), toGlobal(), and toLocal().

double trkf::SurfYZLine::fPhiTolerance = 1.e-10

staticprivate

Phi tolerance for parallel.

Definition at line 133 of file SurfYZLine.h.

Referenced by isEqual(), and isParallel().

double trkf::SurfYZLine::fSepTolerance = 1.e-6

staticprivate

Separation tolerance for equal.

Definition at line 134 of file SurfYZLine.h.

Referenced by isEqual().

double trkf::SurfYZLine::fX0

private

X origin.

Definition at line 138 of file SurfYZLine.h.

Referenced by isEqual(), Print(), toGlobal(), toLocal(), and x0().

double trkf::SurfYZLine::fY0

private

Y origin.

Definition at line 139 of file SurfYZLine.h.

Referenced by isEqual(), Print(), toGlobal(), toLocal(), and y0().

double trkf::SurfYZLine::fZ0

private

Z origin.

Definition at line 140 of file SurfYZLine.h.

Referenced by isEqual(), Print(), toGlobal(), toLocal(), and z0().

---

The documentation for this class was generated from the following files:

• lardata/v09_16_03/source/lardata/RecoObjects/SurfYZLine.h
• lardata/v09_16_03/source/lardata/RecoObjects/SurfYZLine.cxx