#include <SurfYZPlane.h>

Inheritance diagram for trkf::SurfYZPlane:

Public Member Functions
	SurfYZPlane ()
	Default constructor. More...

	SurfYZPlane (double x0, double y0, double z0, double phi)
	Initializing constructor. More...

virtual	~SurfYZPlane ()
	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 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 forward 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...

Public Member Functions inherited from trkf::SurfPlane
	SurfPlane ()
	Default constructor. More...

virtual	~SurfPlane ()
	Destructor. 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...

Public Member Functions inherited from trkf::Surface
	Surface ()
	Default constructor. More...

virtual	~Surface ()
	Destructor. More...

virtual TrackVector	getDiff (const TrackVector &vec1, const TrackVector &vec2) const
	Calculate difference of two track parameter vectors. 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...

Additional Inherited Members
Public Types inherited from trkf::Surface
enum	TrackDirection { FORWARD, BACKWARD, UNKNOWN }
	Track direction enum. More...

Detailed Description

Definition at line 46 of file SurfYZPlane.h.

Constructor & Destructor Documentation

trkf::SurfYZPlane::SurfYZPlane ( )

Default constructor.

Definition at line 24 of file SurfYZPlane.cxx.

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

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

Initializing constructor.

Arguments:

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

Definition at line 38 of file SurfYZPlane.cxx.

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

trkf::SurfYZPlane::~SurfYZPlane ( )

virtual

Destructor.

Definition at line 46 of file SurfYZPlane.cxx.

47 {}

Member Function Documentation

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

virtual

Clone method.

Implements trkf::Surface.

Definition at line 50 of file SurfYZPlane.cxx.

   {
     return new SurfYZPlane(*this);
   }

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

virtual

Find perpendicular forward distance to a parallel surface.

Throw an exception if the other surface is not parallel.

Assuming the other surface is parallel, the distance is simply the w-coordinate of the other surface, and is signed.

Arguments:

surf - Other surface.

Returned value: Distance.

Implements trkf::Surface.

Definition at line 218 of file SurfYZPlane.cxx.

   {
     // Check if the other surface is parallel to this one.
 
     bool parallel = isParallel(surf);
     if(!parallel)
       throw cet::exception("SurfYZPlane") << "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 is local w-coordinate of other surface origin.
 
     return myuvw[2];
   }

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

virtual

Get momentum vector of track.

Arguments:

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

Implements trkf::Surface.

Definition at line 135 of file SurfYZPlane.cxx.

   {
 
     // Get momentum.
 
     double invp = std::abs(vec(4));
     double p = 1. / std::max(invp, 1.e-3);   // Capped at 1000. GeV/c.
 
     // Get track slope parameters.
 
     double dudw = vec(2);
     double dvdw = vec(3);
 
     // Calculate dw/ds.
 
     double dwds = 1. / std::sqrt(1. + dudw*dudw + dvdw*dvdw);
     TrackDirection realdir = getDirection(vec, dir);   // Should be same as original direction.
     if(realdir == BACKWARD)
       dwds = -dwds;
     else if(realdir != FORWARD)
       throw cet::exception("SurfYZPlane") << "Track direction not specified.\n";
 
     // Calculate momentum vector in local coordinate system.
 
     double pu = p * dudw * dwds;
     double pv = p * dvdw * dwds;
     double pw = p * dwds;
 
     // Rotate momentum to global coordinte system.
 
     double sinphi = std::sin(fPhi);
     double cosphi = std::cos(fPhi);
 
     mom[0] = pu;
     mom[1] = pv * cosphi - pw * sinphi;
     mom[2] = pv * sinphi + pw * cosphi;
 
     return;
   }

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

virtual

Get position of track.

Arguments:

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

Implements trkf::Surface.

Definition at line 112 of file SurfYZPlane.cxx.

   {
     // Get position in local coordinate system.
 
     double uvw[3];
     uvw[0] = vec(0);
     uvw[1] = vec(1);
     uvw[2] = 0.;
 
     // Transform to global coordinate system.
 
     toGlobal(uvw, xyz);
     return;
   }

bool trkf::SurfYZPlane::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 251 of file SurfYZPlane.cxx.

   {
     bool result = false;
 
     // Test if the other surface is a SurfYZPlane.
 
     const SurfYZPlane* psurf = dynamic_cast<const SurfYZPlane*>(&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::SurfYZPlane::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 SurfYZPlane.

Arguments:

surf - Other surface.

Returned value: true if parallel.

Implements trkf::Surface.

Definition at line 186 of file SurfYZPlane.cxx.

   {
     bool result = false;
 
     // Test if the other surface is a SurfYZPlane.
 
     const SurfYZPlane* psurf = dynamic_cast<const SurfYZPlane*>(&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::SurfYZPlane::isTrackValid ( const TrackVector & vec ) const

virtual

Surface-specific tests of validity of track parameters.

Implements trkf::Surface.

Definition at line 56 of file SurfYZPlane.cxx.

   {
     return true;
   }

double trkf::SurfYZPlane::phi ( ) const

inline

Rotation angle about x-axis.

Definition at line 63 of file SurfYZPlane.h.

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

virtual

Printout.

Implements trkf::Surface.

Definition at line 276 of file SurfYZPlane.cxx.

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

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

virtual

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 90 of file SurfYZPlane.cxx.

   {
     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::SurfYZPlane::toLocal	(	const double	xyz[3],
		double	uvw[3]
	)		const

virtual

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 68 of file SurfYZPlane.cxx.

   {
     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::SurfYZPlane::x0 ( ) const

inline

X origin.

Definition at line 60 of file SurfYZPlane.h.

double trkf::SurfYZPlane::y0 ( ) const

inline

Y origin.

Definition at line 61 of file SurfYZPlane.h.

double trkf::SurfYZPlane::z0 ( ) const

inline

Z origin.

Definition at line 62 of file SurfYZPlane.h.

Member Data Documentation

double trkf::SurfYZPlane::fPhi

private

Rotation angle about x-axis.

Definition at line 108 of file SurfYZPlane.h.

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

staticprivate

Phi tolerance for parallel.

Definition at line 100 of file SurfYZPlane.h.

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

staticprivate

Separation tolerance for equal.

Definition at line 101 of file SurfYZPlane.h.

double trkf::SurfYZPlane::fX0

private

X origin.

Definition at line 105 of file SurfYZPlane.h.

double trkf::SurfYZPlane::fY0

private

Y origin.

Definition at line 106 of file SurfYZPlane.h.

double trkf::SurfYZPlane::fZ0

private

Z origin.

Definition at line 107 of file SurfYZPlane.h.

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

lardata/lardata/RecoObjects/SurfYZPlane.h
lardata/lardata/RecoObjects/SurfYZPlane.cxx

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation