Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
recob::TrackTrajectory Class Reference

A trajectory in space reconstructed from hits. More...

#include <TrackTrajectory.h>

Inheritance diagram for recob::TrackTrajectory:
recob::Trajectory

Public Types

using Coord_t = tracking::Coord_t
 Type used for coordinates and values in general. More...
 
using Point_t = tracking::Point_t
 Type for representation of position in physical 3D space. More...
 
using Vector_t = tracking::Vector_t
 Type for representation of momenta in 3D space. More...
 
using PointFlags_t = recob::TrajectoryPointFlags
 Type for flags of a point/hit. More...
 
using flag = PointFlags_t::flag
 Flag traits (including the definition of flag mnemonics). More...
 
using Positions_t = tracking::Positions_t
 Type of trajectory point list. More...
 
using Momenta_t = tracking::Momenta_t
 Type of momentum list. More...
 
using Flags_t = std::vector< PointFlags_t >
 Type of point flag list. More...
 
using Ends_t = Trajectory_t::Ends_t
 Mnemonics for the access to begin and end of trajectory. More...
 
using TrajectoryPoint_t = tracking::TrajectoryPoint_t
 A point in the trajectory, with position and momentum. More...
 
using Rotation_t = tracking::Rotation_t
 Type for representation of space rotations. More...
 

Public Member Functions

 TrackTrajectory ()=default
 Default constructor; do not use it! it's needed by ROOT I/O. More...
 
 TrackTrajectory (Positions_t &&positions, Momenta_t &&momenta, Flags_t &&flags, bool hasMomenta)
 Constructor: specifies all the data for the trajectory. More...
 
 TrackTrajectory (const Trajectory &traj, Flags_t &&flags)
 Constructor: copies positions and momenta from an existing Trajectory, adds the flags. More...
 
Trajectory_t const & Trajectory () const
 Returns the plain trajectory of this object. More...
 
PointFlags_t const & FlagsAtPoint (size_t i) const
 Returns the flags for the specified trajectory point. More...
 
Flags_t const & Flags () const
 Returns all flags. More...
 
bool HasValidPoint (size_t i) const
 Returns whether the specified point has NoPoint flag unset. More...
 
size_t FirstValidPoint () const
 Returns the index of the first valid point in the trajectory. More...
 
size_t NextValidPoint (size_t index) const
 Returns the index of the next valid point in the trajectory. More...
 
size_t PreviousValidPoint (size_t index) const
 Returns the index of the previous valid point in the trajectory. More...
 
size_t LastValidPoint () const
 Returns the index of the last valid point in the trajectory. More...
 
unsigned int CountValidPoints () const
 Computes and returns the number of points with valid location. More...
 
Point_t const & Vertex () const
 Returns the position of the first valid point of the trajectory [cm]. More...
 
Point_t const & Start () const
 Returns the position of the first valid point of the trajectory [cm]. More...
 
Point_t const & End () const
 Returns the position of the last valid point of the trajectory [cm]. More...
 
template<typename T >
std::pair< T, T > Extent () const
 Fills the first and last valid point in the trajectory. More...
 
std::pair< Point_t, Point_tExtent () const
 Returns a copy of the first and last valid point in the trajectory. More...
 
double Length (size_t startAt=0) const
 Returns the approximate length of the trajectory. More...
 
Vector_t VertexDirection () const
 Returns the direction of the trajectory at the first point. More...
 
Vector_t StartDirection () const
 Returns the direction of the trajectory at the first point. More...
 
Vector_t EndDirection () const
 Returns the direction of the trajectory at the last point. More...
 
double Theta (size_t p) const
 Trajectory angle at point, with respect to positive z direction. More...
 
double Theta () const
 Trajectory angle at start, with respect to positive z direction. More...
 
double Phi (size_t p) const
 Azimuthal angle at a point on the trajectory, with respect to z. More...
 
double Phi () const
 Azimuthal angle at a first valid point, with respect to z. More...
 
double ZenithAngle (size_t p) const
 "Zenith" angle of trajectory, with respect to the vertical axis. More...
 
double ZenithAngle () const
 "Zenith" angle of trajectory, with respect to the vertical axis. More...
 
double AzimuthAngle (size_t p) const
 "Azimuth" angle of trajectory, with respect to the sky. More...
 
double AzimuthAngle () const
 "Azimuth" angle of trajectory, with respect to the sky. More...
 
Vector_t const & VertexMomentumVector () const
 Returns the momentum of the trajectory at the first valid point [GeV/c]. More...
 
Vector_t const & StartMomentumVector () const
 Returns the momentum of the trajectory at the first valid point [GeV/c]. More...
 
Vector_t const & EndMomentumVector () const
 Returns the momentum of the trajectory at the last valid point [GeV/c]. More...
 
double VertexMomentum () const
 
double StartMomentum () const
 
double EndMomentum () const
 
template<typename T >
std::pair< T, T > Direction () const
 Fills the starting and ending direction of the trajectory. More...
 
std::pair< Vector_t, Vector_tDirection () const
 Returns the trajectory directions at first and last valid points. More...
 
template<typename Stream >
void Dump (Stream &&out, unsigned int verbosity, std::string indent, std::string indentFirst) const
 Prints trajectory content into a stream. More...
 
template<typename Stream >
void Dump (Stream &&out, unsigned int verbosity=1, std::string indent={}) const
 Prints trajectory content into a stream. More...
 
template<typename Stream >
void LowLevelDump (Stream &&out, std::string indent, std::string indentFirst) const
 Prints low-level trajectory content into a stream. More...
 
Templated version of homonymous functions to access to position, direction, and momentum information.
template<typename T >
Start () const
 Start position. Use e.g. as: More...
 
template<typename T >
Vertex () const
 Start position. Use e.g. as: More...
 
template<typename T >
End () const
 End position. Use e.g. as: More...
 
template<typename T >
LocationAtPoint (unsigned int p) const
 Position at point p. Use e.g. as: More...
 
template<typename T >
StartDirection () const
 Start direction. Use e.g. as: More...
 
template<typename T >
VertexDirection () const
 Start direction. Use e.g. as: More...
 
template<typename T >
EndDirection () const
 End direction. Use e.g. as: More...
 
template<typename T >
DirectionAtPoint (unsigned int p) const
 Direction at point p. Use e.g. as: More...
 
template<typename T >
StartMomentumVector () const
 Momentum vector at start point. Use e.g. as: More...
 
template<typename T >
VertexMomentumVector () const
 Momentum vector at start point. Use e.g. as: More...
 
template<typename T >
EndMomentumVector () const
 Momentum vector at end point. Use e.g. as: More...
 
template<typename T >
MomentumVectorAtPoint (unsigned int p) const
 Momentum vector at point p. Use e.g. as: More...
 
template<typename T >
GlobalToLocalRotationAtPoint (unsigned int p) const
 Returns a rotation matrix that brings trajectory direction along z. Use e.g. as: More...
 
template<typename T >
LocalToGlobalRotationAtPoint (unsigned int p) const
 Returns a rotation matrix bringing relative directions to global. Use e.g. as: More...
 

Static Public Attributes

static constexpr unsigned int MaxDumpVerbosity = 7
 Largest verbosity level supported by Dump(). More...
 
static constexpr size_t InvalidIndex = std::numeric_limits<size_t>::max()
 Value returned on failed index queries. More...
 

Private Types

using Trajectory_t = recob::Trajectory
 
- Private Types inherited from recob::Trajectory
enum  Ends_t { kStart, kVertex = kStart, kEnd, NEnds }
 Mnemonics for the access to begin and end of trajectory. More...
 
using Coord_t = tracking::Coord_t
 Type used for coordinates and values in general. More...
 
using Point_t = tracking::Point_t
 Type for representation of position in physical 3D space. More...
 
using Vector_t = tracking::Vector_t
 Type for representation of momenta in 3D space. More...
 
using Positions_t = tracking::Positions_t
 Type of trajectory point list. More...
 
using Momenta_t = tracking::Momenta_t
 Type of momentum list. More...
 
using TrajectoryPoint_t = tracking::TrajectoryPoint_t
 A point in the trajectory, with position and momentum. More...
 
using Rotation_t = tracking::Rotation_t
 Type for representation of space rotations. More...
 

Private Member Functions

template<int Dir>
size_t ToValidPoint (size_t index) const
 Returns the index of the first valid point from index on. More...
 
bool AtLeastValidTrajectoryPoints (unsigned int left) const
 Returns whether there are at least min valid points in the trajectory. More...
 
- Private Member Functions inherited from recob::Trajectory
 Trajectory ()=default
 Default constructor; do not use it! it's needed by ROOT I/O. More...
 
 Trajectory (Positions_t &&positions, Momenta_t &&momenta, bool hasMomenta)
 Constructor: specifies all the data for the trajectory. More...
 
 Trajectory (Positions_t const &positions, Momenta_t const &momenta, bool hasMomenta)
 Constructor: copies positions and momenta. More...
 
template<typename Stream >
void Dump (Stream &&out, unsigned int verbosity, std::string indent, std::string indentFirst) const
 Prints trajectory content into a stream. More...
 
template<typename Stream >
void Dump (Stream &&out, unsigned int verbosity=1, std::string indent={}) const
 Prints trajectory content into a stream. More...
 
template<typename Stream >
void LowLevelDump (Stream &&out, std::string indent, std::string indentFirst) const
 Prints low-level trajectory content into a stream. More...
 
size_t NumberTrajectoryPoints () const
 Returns the number of stored trajectory points. More...
 
size_t NPoints () const
 Returns the number of stored trajectory points. More...
 
size_t FirstPoint () const
 Returns the index of the first point in the trajectory (yep, it's 0). More...
 
size_t LastPoint () const
 Returns the index of the last point in the trajectory. More...
 
bool HasPoint (size_t i) const
 Returns whether the specified trajectory point is available. More...
 
const Positions_tPositions () const
 Returns reference to stored vector of positions. More...
 
const Momenta_tMomenta () const
 Returns reference to stored vector of momenta. More...
 
TrajectoryPoint_t TrajectoryPoint (size_t i) const
 Returns position and momentum at the specified trajectory point. More...
 
Point_t const & Vertex () const
 Returns the position of the first point of the trajectory [cm]. More...
 
Point_t const & Start () const
 Returns the position of the first point of the trajectory [cm]. More...
 
Point_t const & End () const
 Returns the position of the last point of the trajectory [cm]. More...
 
Point_t const & LocationAtPoint (size_t i) const
 Returns the position at the specified trajectory point. More...
 
template<typename T >
std::pair< T, T > Extent () const
 Fills the first and last point in the trajectory. More...
 
std::pair< Point_t, Point_tExtent () const
 Returns a copy of the first and last point in the trajectory. More...
 
double Length (size_t startAt=0) const
 Returns the approximate length of the trajectory. More...
 
Vector_t VertexDirection () const
 Returns the direction of the trajectory at the first point. More...
 
Vector_t StartDirection () const
 Returns the direction of the trajectory at the first point. More...
 
Vector_t EndDirection () const
 Returns the direction of the trajectory at the last point. More...
 
double Theta (size_t p=0) const
 Trajectory angle at point, with respect to positive z direction. More...
 
double Phi (size_t p=0) const
 Azimuthal angle at a point on the trajectory, with respect to z. More...
 
double ZenithAngle (size_t p=0) const
 "Zenith" angle of trajectory, with respect to the vertical axis. More...
 
double AzimuthAngle (size_t p=0) const
 "Azimuth" angle of trajectory, with respect to the sky. More...
 
Vector_t const & VertexMomentumVector () const
 Returns the momentum of the trajectory at the first point [GeV/c]. More...
 
Vector_t const & StartMomentumVector () const
 Returns the momentum of the trajectory at the first point [GeV/c]. More...
 
Vector_t const & EndMomentumVector () const
 Returns the momentum of the trajectory at the last point [GeV/c]. More...
 
double VertexMomentum () const
 Computes and returns the modulus of momentum at the first point [GeV/c]. More...
 
double StartMomentum () const
 Computes and returns the modulus of momentum at the first point [GeV/c]. More...
 
double EndMomentum () const
 Computes and returns the modulus of momentum at the last point [GeV/c]. More...
 
Vector_t DirectionAtPoint (size_t i) const
 Computes and returns the direction of the trajectory at a point. More...
 
bool HasMomentum () const
 Returns whether information about the momentum is available. More...
 
double MomentumAtPoint (size_t i) const
 Computes and returns the modulus of the momentum at a point. More...
 
Vector_t const & MomentumVectorAtPoint (size_t i) const
 Returns the momentum vector at a point. More...
 
template<typename T >
std::pair< T, T > Direction () const
 Fills the starting and ending direction of the trajectory. More...
 
std::pair< Vector_t, Vector_tDirection () const
 Returns the trajectory directions at first and last point. More...
 
Rotation_t GlobalToLocalRotationAtPoint (size_t p) const
 Returns a rotation matrix that brings trajectory direction along z. More...
 
Rotation_t LocalToGlobalRotationAtPoint (size_t p) const
 Returns a rotation matrix bringing relative directions to global. More...
 
template<typename T >
Start () const
 Start position. Use e.g. as: More...
 
template<typename T >
Vertex () const
 Start position. Use e.g. as: More...
 
template<typename T >
End () const
 End position. Use e.g. as: More...
 
template<typename T >
LocationAtPoint (unsigned int p) const
 Position at point p. Use e.g. as: More...
 
template<typename T >
StartDirection () const
 Start direction. Use e.g. as: More...
 
template<typename T >
VertexDirection () const
 Start direction. Use e.g. as: More...
 
template<typename T >
EndDirection () const
 End direction. Use e.g. as: More...
 
template<typename T >
DirectionAtPoint (unsigned int p) const
 Direction at point p. Use e.g. as: More...
 
template<typename T >
StartMomentumVector () const
 Momentum vector at start point. Use e.g. as: More...
 
template<typename T >
VertexMomentumVector () const
 Momentum vector at start point. Use e.g. as: More...
 
template<typename T >
EndMomentumVector () const
 Momentum vector at end point. Use e.g. as: More...
 
template<typename T >
MomentumVectorAtPoint (unsigned int p) const
 Momentum vector at point p. Use e.g. as: More...
 
template<typename T >
GlobalToLocalRotationAtPoint (unsigned int p) const
 Returns a rotation matrix that brings trajectory direction along z. Use e.g. as: More...
 
template<typename T >
LocalToGlobalRotationAtPoint (unsigned int p) const
 Returns a rotation matrix bringing relative directions to global. Use e.g. as: More...
 

Private Attributes

Flags_t fFlags
 Flags of each of the points in trajectory. More...
 

Additional Inherited Members

- Static Private Attributes inherited from recob::Trajectory
static constexpr unsigned int MaxDumpVerbosity = 6
 Largest verbosity level supported by Dump(). More...
 

Detailed Description

A trajectory in space reconstructed from hits.


See also
recob::Trajectory, recob::Track, recob::trackutil::makeTrajectory()

The track trajectory class contains a trajectory in 6D space representing the path walked by a particle. A trajectory point is made of a 3D position component (measured in centimeters) and a momentum component (measured in GeV/c); for a discussion on the object type for coordinates see recob::tracking::Coord_t. The associated hits are integral part of the track trajectory. To store additional point-by-point information, the track trajectory augments recob::Trajectory, of which it presents most of the interface, with point metadata called for convenience "flags".

Each point is formally associated to a reconstructed hit, as for recob::Trajectory requirements. One flag set is provided for each point, whose flags describe the point and/or the hit.

The meaning of the flags is documented also in the flags class recob::TrajectoryPointFlagTraits, which can be accessed as typedef flags in this class (e.g. recob::TrackTrajectory::flag::NoPoint).

Invariants

The same as recob::Trajectory, plus:

Definition at line 62 of file TrackTrajectory.h.

Member Typedef Documentation

Type used for coordinates and values in general.

Definition at line 67 of file TrackTrajectory.h.

Mnemonics for the access to begin and end of trajectory.

Definition at line 91 of file TrackTrajectory.h.

Flag traits (including the definition of flag mnemonics).

Definition at line 79 of file TrackTrajectory.h.

Type of point flag list.

Definition at line 88 of file TrackTrajectory.h.

Type of momentum list.

Definition at line 85 of file TrackTrajectory.h.

Type for representation of position in physical 3D space.

Definition at line 70 of file TrackTrajectory.h.

Type for flags of a point/hit.

Definition at line 76 of file TrackTrajectory.h.

Type of trajectory point list.

Definition at line 82 of file TrackTrajectory.h.

Type for representation of space rotations.

Definition at line 97 of file TrackTrajectory.h.

Definition at line 63 of file TrackTrajectory.h.

A point in the trajectory, with position and momentum.

Definition at line 94 of file TrackTrajectory.h.

Type for representation of momenta in 3D space.

Definition at line 73 of file TrackTrajectory.h.

Constructor & Destructor Documentation

recob::TrackTrajectory::TrackTrajectory ( )
default

Default constructor; do not use it! it's needed by ROOT I/O.

recob::TrackTrajectory::TrackTrajectory ( Positions_t &&  positions,
Momenta_t &&  momenta,
Flags_t &&  flags,
bool  hasMomenta 
)

Constructor: specifies all the data for the trajectory.

Parameters
positions(moved) trajectory as a sorted list of points
momenta(moved) momentum along the trajectory, one per point
flags(moved) flag sets, one flag set per point
hasMomentawhether the information on momentum modulus is provided
Exceptions
std::runtime_errorif the invariants are violated
See also
recob::trackutil::makeTrackTrajectory()

The most convenient way to create a recob::Trajectory is to use recob::trackutil::makeTrackTrajectory().

Requirements

  • one momentum is required for each trajectory point
  • one flag is required for each trajectory point
  • at least two points must be provided

Definition at line 18 of file TrackTrajectory.cxx.

21  : Trajectory_t(std::move(positions), std::move(momenta), hasMomenta)
22  , fFlags(std::move(flags))
23 {
24  // additional invariant check
25  if (fFlags.size() != NPoints()) {
26  throw std::runtime_error("recob::TrackTrajectory constructed with "
27  + std::to_string(NPoints()) + " points "
28  + std::to_string(fFlags.size())
29  + " point flags! it requires the same number for both."
30  );
31  }
33  throw std::runtime_error("recob::TrackTrajectory constructed with only "
35  + " valid positions! at least 2 are required."
36  );
37  }
38 } // recob::TrackTrajectory::TrackTrajectory()
unsigned int CountValidPoints() const
Computes and returns the number of points with valid location.
Flags_t fFlags
Flags of each of the points in trajectory.
recob::Trajectory Trajectory_t
size_t NPoints() const
Returns the number of stored trajectory points.
Definition: Trajectory.h:167
def move(depos, offset)
Definition: depos.py:107
bool AtLeastValidTrajectoryPoints(unsigned int left) const
Returns whether there are at least min valid points in the trajectory.
std::string to_string(ModuleType const mt)
Definition: ModuleType.h:34
recob::TrackTrajectory::TrackTrajectory ( const Trajectory traj,
Flags_t &&  flags 
)
inline

Constructor: copies positions and momenta from an existing Trajectory, adds the flags.

Parameters
trajexisting Trajectory
flags(moved) flag sets, one flag set per point
Exceptions
std::runtime_errorif the invariants are violated

Definition at line 139 of file TrackTrajectory.h.

140  : TrackTrajectory(Positions_t(traj.Positions()),Momenta_t(traj.Momenta()),std::move(flags),traj.HasMomentum()) {}
TrackTrajectory()=default
Default constructor; do not use it! it&#39;s needed by ROOT I/O.
tracking::Positions_t Positions_t
Type of trajectory point list.
tracking::Momenta_t Momenta_t
Type of momentum list.
def move(depos, offset)
Definition: depos.py:107

Member Function Documentation

bool recob::TrackTrajectory::AtLeastValidTrajectoryPoints ( unsigned int  left) const
private

Returns whether there are at least min valid points in the trajectory.

Definition at line 92 of file TrackTrajectory.cxx.

93 {
94  if (min == 0) return true;
95  unsigned int left = min;
96  for (size_t i = 0; i < NPoints(); ++i) {
97  if (!HasValidPoint(i)) continue;
98  if (--left == 0) return true;
99  } // for
100  return false;
101 
102 } // moreThanTwoValidTrajectoryPoints()
size_t NPoints() const
Returns the number of stored trajectory points.
Definition: Trajectory.h:167
bool HasValidPoint(size_t i) const
Returns whether the specified point has NoPoint flag unset.
T min(sqlite3 *const db, std::string const &table_name, std::string const &column_name)
Definition: statistics.h:55
double recob::TrackTrajectory::AzimuthAngle ( size_t  p) const
inline

"Azimuth" angle of trajectory, with respect to the sky.

Parameters
pthe index point to extract the angle from (no default!)
Returns
the azimuth angle, in $ [-\pi,\pi[ $ [radians]
See also
AzimuthAngle(), ZenithAngle(size_t), Phi(size_t)

The azimuth is returned, as defined in recob::Trajectory::Azimuth(), for point with the specified index p.

If the point is invalid, the behaviour is undefined.

Note
This function has no default value for p; if p is not specified at all, the method Azimuth() is called instead.

Definition at line 437 of file TrackTrajectory.h.

438  { return Trajectory().AzimuthAngle(p); }
Trajectory_t const & Trajectory() const
Returns the plain trajectory of this object.
double AzimuthAngle(size_t p=0) const
"Azimuth" angle of trajectory, with respect to the sky.
Definition: Trajectory.cxx:96
p
Definition: test.py:223
double recob::TrackTrajectory::AzimuthAngle ( ) const
inline

"Azimuth" angle of trajectory, with respect to the sky.

Returns
the azimuth angle, in $ [-\pi,\pi[ $ [radians]
See also
AzimuthAngle(size_t), ZenithAngle(), Phi()
Zenith(size_t), Theta()

The azimuth angle is returned, as defined in recob::Trajectory::Azimuth(), for the first valid point in the trajectory.

Note
This is not equivalent to Azimuth(0), but instead to Azimuth(FirstValidPoint()).

Definition at line 453 of file TrackTrajectory.h.

454  { return AzimuthAngle(FirstValidPoint()); }
double AzimuthAngle() const
"Azimuth" angle of trajectory, with respect to the sky.
size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.
unsigned int recob::TrackTrajectory::CountValidPoints ( ) const

Computes and returns the number of points with valid location.

Returns
number of points in the trajectory with valid location

This method is slow, taking O(NPoints()) time.

Definition at line 42 of file TrackTrajectory.cxx.

42  {
43 
44  unsigned int count = 0;
45  for (size_t index = 0; index < NPoints(); ++index) {
46  if (HasValidPoint(index)) ++count;
47  } // for
48  return count;
49 
50 } // recob::TrackTrajectory::CountValidPoints()
size_t NPoints() const
Returns the number of stored trajectory points.
Definition: Trajectory.h:167
bool HasValidPoint(size_t i) const
Returns whether the specified point has NoPoint flag unset.
template<typename T >
std::pair<T,T> recob::TrackTrajectory::Direction ( ) const
inline

Fills the starting and ending direction of the trajectory.

Parameters
start(output) direction at the beginning of the trajectory
end(output) direction at the end of the trajectory

The two arguments are expected to point each one to an area with room for at least three double numbers. The two filled vectors have norm 1.

The labelling of start and end is consistent within the trajectory but is not guaranteed to be physically correct.

Definition at line 506 of file TrackTrajectory.h.

506 { return { VertexDirection<T>(), EndDirection<T>() }; }
std::pair<Vector_t, Vector_t> recob::TrackTrajectory::Direction ( ) const
inline

Returns the trajectory directions at first and last valid points.

Returns
a pair with the first and last direction

The two returned vectors have norm 1. The labelling of start and end is consistent within the trajectory but is not guaranteed to be physically correct.

Example:

recob::Trajectory::Vector_t startDir, endDir;
std::tie(startDir, endDir) = traj.Direction(); // assign start and end

Definition at line 526 of file TrackTrajectory.h.

527  { return { StartDirection(), EndDirection() }; }
Vector_t EndDirection() const
Returns the direction of the trajectory at the last point.
Vector_t StartDirection() const
Returns the direction of the trajectory at the first point.
template<typename T >
T recob::TrackTrajectory::DirectionAtPoint ( unsigned int  p) const
inline

Direction at point p. Use e.g. as:

TVector3 dir = tracktraj.DirectionAtPoint<TVector3>(p);

.

Definition at line 559 of file TrackTrajectory.h.

559 { auto dir = DirectionAtPoint(p); return T(dir.X(),dir.Y(),dir.Z()); }
T DirectionAtPoint(unsigned int p) const
Direction at point p. Use e.g. as:
string dir
p
Definition: test.py:223
template<typename Stream >
void recob::TrackTrajectory::Dump ( Stream &&  out,
unsigned int  verbosity,
std::string  indent,
std::string  indentFirst 
) const

Prints trajectory content into a stream.

Template Parameters
Streamtype of the output stream
Parameters
outstream to output the information into
verbosityverbosity level (default: 1)
indentindentation string (default: none)
indentFirstindentation for first output line (default: as indent)

The amount of information dumped to screen is regulated by the Indentation string is prepended to each line, and the first line has its own special indentation string (indentFirst).

The output can be multi-line, it ends with no end-of-line and it does not inserts an end-of-line at its beginning (unless that is explicitly inside indentFirst). The lowest verbosity is guaranteed to be on a single line.

Information printed out (verbosity argument)

  • level 0: start position, direction, momentum modulus and number of points
  • level 1: also end position, direction and momentum modulus
  • level 2: also trajectory length
  • level 3: also angles at start
  • level 4: also 9 intermediate valid trajectory points
  • level 5: also 10 more intermediate valid trajectory points (19 total)
  • level 6: all valid trajectory points
  • level 7: all trajectory points
template<typename Stream >
void recob::TrackTrajectory::Dump ( Stream &&  out,
unsigned int  verbosity = 1,
std::string  indent = {} 
) const
inline

Prints trajectory content into a stream.

Template Parameters
Streamtype of the output stream
Parameters
outstream to output the information into
verbosityverbosity level (default: 1)
indentindentation string (default: none)
See also
Dump(Stream&&, unsigned int, std::string, std::string)

Implementation detail for Dump(Stream&&, unsigned int, std::string).

Definition at line 641 of file TrackTrajectory.h.

641  {})
642  const
643  { Dump(std::forward<Stream>(out), verbosity, indent, indent); }
void Dump(Stream &&out, unsigned int verbosity, std::string indent, std::string indentFirst) const
Prints trajectory content into a stream.
Point_t const& recob::TrackTrajectory::End ( void  ) const
inline

Returns the position of the last valid point of the trajectory [cm].

Definition at line 257 of file TrackTrajectory.h.

258  { return LocationAtPoint(LastValidPoint()); }
size_t LastValidPoint() const
Returns the index of the last valid point in the trajectory.
T LocationAtPoint(unsigned int p) const
Position at point p. Use e.g. as:
template<typename T >
T recob::TrackTrajectory::End ( void  ) const
inline

End position. Use e.g. as:

TVector3 end = tracktraj.End<TVector3>();

.

Definition at line 544 of file TrackTrajectory.h.

544 { auto& loc = End(); return T(loc.X(),loc.Y(),loc.Z()); }
Point_t const & End() const
Returns the position of the last valid point of the trajectory [cm].
Vector_t recob::TrackTrajectory::EndDirection ( ) const
inline

Returns the direction of the trajectory at the last point.

Definition at line 321 of file TrackTrajectory.h.

322  { return DirectionAtPoint(LastValidPoint()); }
T DirectionAtPoint(unsigned int p) const
Direction at point p. Use e.g. as:
size_t LastValidPoint() const
Returns the index of the last valid point in the trajectory.
template<typename T >
T recob::TrackTrajectory::EndDirection ( ) const
inline

End direction. Use e.g. as:

TVector3 enddir = tracktraj.EndDirection<TVector3>();

.

Definition at line 556 of file TrackTrajectory.h.

556 { auto dir = EndDirection(); return T(dir.X(),dir.Y(),dir.Z()); }
string dir
Vector_t EndDirection() const
Returns the direction of the trajectory at the last point.
double recob::TrackTrajectory::EndMomentum ( ) const
inline

Computes and returns the modulus of momentum at the last point [GeV/c].

See also
EndMomentumVector()

Definition at line 482 of file TrackTrajectory.h.

483  { return EndMomentumVector().R(); }
Vector_t const & EndMomentumVector() const
Returns the momentum of the trajectory at the last valid point [GeV/c].
Vector_t const& recob::TrackTrajectory::EndMomentumVector ( ) const
inline

Returns the momentum of the trajectory at the last valid point [GeV/c].

Definition at line 466 of file TrackTrajectory.h.

size_t LastValidPoint() const
Returns the index of the last valid point in the trajectory.
T MomentumVectorAtPoint(unsigned int p) const
Momentum vector at point p. Use e.g. as:
template<typename T >
T recob::TrackTrajectory::EndMomentumVector ( ) const
inline

Momentum vector at end point. Use e.g. as:

TVector3 endmom = tracktraj.EndMomentumVector<TVector3>();

.

Definition at line 568 of file TrackTrajectory.h.

568 { auto mom = EndMomentumVector(); return T(mom.X(),mom.Y(),mom.Z()); }
Vector_t const & EndMomentumVector() const
Returns the momentum of the trajectory at the last valid point [GeV/c].
template<typename T >
std::pair<T,T> recob::TrackTrajectory::Extent ( ) const
inline

Fills the first and last valid point in the trajectory.

Parameters
start(output) position of the beginning of the trajectory
end(output) position of the end of the trajectory

The labelling of start and end is consistent within the trajectory but is not guaranteed to be physically correct.

Definition at line 270 of file TrackTrajectory.h.

270 { return { Vertex<T>(), End<T>() }; }
std::pair<Point_t, Point_t> recob::TrackTrajectory::Extent ( ) const
inline

Returns a copy of the first and last valid point in the trajectory.

Returns
a pair: the first and last point in the trajectory

The labelling of start and end is consistent within the trajectory but is not guaranteed to be physically correct.

Example:

std::tie(start, end) = traj.Extent(); // assign both start and end

Definition at line 289 of file TrackTrajectory.h.

290  { return { Start(), End() }; }
Point_t const & End() const
Returns the position of the last valid point of the trajectory [cm].
Point_t const & Start() const
Returns the position of the first valid point of the trajectory [cm].
size_t recob::TrackTrajectory::FirstValidPoint ( ) const
inline

Returns the index of the first valid point in the trajectory.

Returns
index of the first point in the trajectory, or InvalidIndex

Returns the index of the first point with the flag NoPoint unset. It never returns InvalidIndex unless the track trajectory is invalid.

Definition at line 197 of file TrackTrajectory.h.

198  { return NextValidPoint(0U); }
size_t NextValidPoint(size_t index) const
Returns the index of the next valid point in the trajectory.
Flags_t const& recob::TrackTrajectory::Flags ( ) const
inline

Returns all flags.

Definition at line 171 of file TrackTrajectory.h.

172  { return fFlags; }
Flags_t fFlags
Flags of each of the points in trajectory.
PointFlags_t const& recob::TrackTrajectory::FlagsAtPoint ( size_t  i) const
inline

Returns the flags for the specified trajectory point.

Parameters
iindex of the point in the trajectory
Returns
flags for the specified trajectory point [cm]

If the point index is invalid, the result is undefined.

Definition at line 165 of file TrackTrajectory.h.

166  { return fFlags[i]; }
Flags_t fFlags
Flags of each of the points in trajectory.
template<typename T >
T recob::TrackTrajectory::GlobalToLocalRotationAtPoint ( unsigned int  p) const
inline

Returns a rotation matrix that brings trajectory direction along z. Use e.g. as:

TMatrixD rot = tracktraj.GlobalToLocalRotationAtPoint<TMatrixD>(p);

.

Definition at line 574 of file TrackTrajectory.h.

574  {
575  T rot(3,3);
576  GlobalToLocalRotationAtPoint(p).GetRotationMatrix(rot);
577  return rot;
578  }
T GlobalToLocalRotationAtPoint(unsigned int p) const
Returns a rotation matrix that brings trajectory direction along z. Use e.g. as:
p
Definition: test.py:223
bool recob::TrackTrajectory::HasValidPoint ( size_t  i) const
inline

Returns whether the specified point has NoPoint flag unset.

Returns
whether the specified point has NoPoint flag unset

A point with flag NoPoint set is actually an invalid point, that the algorithm could not at all set, but it has still a hit associated with it.

If the point index is invalid, false is returned.

Definition at line 184 of file TrackTrajectory.h.

185  {
186  return Trajectory().HasPoint(i)
188  }
bool HasPoint(size_t i) const
Returns whether the specified trajectory point is available.
Definition: Trajectory.h:183
Trajectory_t const & Trajectory() const
Returns the plain trajectory of this object.
static constexpr Flag_t NoPoint
The trajectory point is not defined.
bool isSet(Flag_t flag) const
Returns true if the flag exists and is set.
PointFlags_t const & FlagsAtPoint(size_t i) const
Returns the flags for the specified trajectory point.
size_t recob::TrackTrajectory::LastValidPoint ( ) const
inline

Returns the index of the last valid point in the trajectory.

Returns
index of the last point in the trajectory, or InvalidIndex

Returns the index of the last point with the flag NoPoint unset. It never returns InvalidIndex unless the track trajectory is invalid.

Definition at line 235 of file TrackTrajectory.h.

236  { return PreviousValidPoint(LastPoint()); }
size_t LastPoint() const
Returns the index of the last point in the trajectory.
Definition: Trajectory.h:175
size_t PreviousValidPoint(size_t index) const
Returns the index of the previous valid point in the trajectory.
double recob::TrackTrajectory::Length ( size_t  startAt = 0) const

Returns the approximate length of the trajectory.

Parameters
startAt(default: 0, from beginning) point to start from
Returns
the approximate length of the trajectory [cm]

The residual length from the trajectory point startAt to the end of the trajectory is computed and returned. By default, the whole trajectory length is returned. All invalid points are skipped. If after skipping, less than two valid points are left, 0 is returned.

The length approximation is just the sum of Euclidean distances between each valid trajectory point and the next (starting from the first valid one with index startAt or larger).

This operation is slow, and the result should be stored in a variable.

Parameters
startAt(default: 0, from beginning) point to start from
Returns
the approximate length of the trajectory [cm]

The residual length from the trajectory point startAt to the end of the trajectory is computed and returned. By default, the whole trajectory length is returned. If a non-existing point is specified, 0 is returned.

The length approximation is just the sum of Euclidean distances between all consecutive trajectory points (starting from the one with index startAt).

This operation is slow, and the result should be stored in a variable.

Definition at line 70 of file TrackTrajectory.cxx.

70  {
71 
72  // sanity check
73  if (startAt >= LastPoint()) return 0.;
74 
75  // just sum the distance between all locations in the trajectory
76  size_t iCurr = ToValidPoint<+1>(startAt);
77  size_t iNext = iCurr;
78  size_t iLast = LastValidPoint();
79  Point_t const* curr = &(LocationAtPoint(iCurr));
80  Coord_t length = 0.0;
81  while ((iNext = ToValidPoint<+1>(++iNext)) <= iLast) {
82  Point_t const* next = &LocationAtPoint(iNext);
83  length += (*next - *curr).R();
84  curr = next;
85  } // while
86  return length;
87 } // recob::TrackTrajectory::Length()
size_t LastValidPoint() const
Returns the index of the last valid point in the trajectory.
ROOT::Math::PositionVector3D< ROOT::Math::Cartesian3D< double >> Point_t
size_t LastPoint() const
Returns the index of the last point in the trajectory.
Definition: Trajectory.h:175
T LocationAtPoint(unsigned int p) const
Position at point p. Use e.g. as:
tracking::Coord_t Coord_t
Type used for coordinates and values in general.
template<typename T >
T recob::TrackTrajectory::LocalToGlobalRotationAtPoint ( unsigned int  p) const
inline

Returns a rotation matrix bringing relative directions to global. Use e.g. as:

TMatrixD rot = tracktraj.LocalToGlobalRotationAtPoint<TMatrixD>(p);

.

Definition at line 581 of file TrackTrajectory.h.

581  {
582  T rot(3,3);
583  LocalToGlobalRotationAtPoint(p).GetRotationMatrix(rot);
584  return rot;
585  }
T LocalToGlobalRotationAtPoint(unsigned int p) const
Returns a rotation matrix bringing relative directions to global. Use e.g. as:
p
Definition: test.py:223
template<typename T >
T recob::TrackTrajectory::LocationAtPoint ( unsigned int  p) const
inline

Position at point p. Use e.g. as:

TVector3 pos = tracktraj.LocationAtPoint<TVector3>(p);

.

Definition at line 547 of file TrackTrajectory.h.

547 { auto& loc = LocationAtPoint(p); return T(loc.X(),loc.Y(),loc.Z()); }
T LocationAtPoint(unsigned int p) const
Position at point p. Use e.g. as:
p
Definition: test.py:223
template<typename Stream >
void recob::TrackTrajectory::LowLevelDump ( Stream &&  out,
std::string  indent,
std::string  indentFirst 
) const

Prints low-level trajectory content into a stream.

Template Parameters
Streamtype of the output stream
Parameters
outstream to output the information into
indentindentation string (default: none)
indentFirstindentation for first output line (default: as indent)
template<typename T >
T recob::TrackTrajectory::MomentumVectorAtPoint ( unsigned int  p) const
inline

Momentum vector at point p. Use e.g. as:

TVector3 mom = tracktraj.MomentumVectorAtPoint<TVector3>(p);

.

Definition at line 571 of file TrackTrajectory.h.

571 { auto mom = MomentumVectorAtPoint(p); return T(mom.X(),mom.Y(),mom.Z()); }
p
Definition: test.py:223
T MomentumVectorAtPoint(unsigned int p) const
Momentum vector at point p. Use e.g. as:
size_t recob::TrackTrajectory::NextValidPoint ( size_t  index) const
inline

Returns the index of the next valid point in the trajectory.

Parameters
indexstarting index
Returns
index of next valid point in the trajectory, or InvalidIndex

Returns the index of the first point with the flag NoPoint unset, starting with the point with the specified index (included), and moving forward toward the end of the trajectory. It returns InvalidIndex if point at index is invalid and there are no valid points left after it.

Definition at line 211 of file TrackTrajectory.h.

212  { return ToValidPoint<+1>(index); }
double recob::TrackTrajectory::Phi ( size_t  p) const
inline

Azimuthal angle at a point on the trajectory, with respect to z.

Parameters
pthe index point to extract the angle from (no default!)
Returns
the azimuthal angle, in $ [-\pi,\pi[ $ [radians]
See also
Phi(), Theta(size_t), ZenithAngle(size_t)

The angle $ \phi $ is returned, as defined in recob::Trajectory::Phi(), for point with the specified index p.

If the point is invalid, the behaviour is undefined.

Note
This function has no default value for p; if p is not specified at all, the method Phi() is called instead.

Definition at line 371 of file TrackTrajectory.h.

372  { return Trajectory().Phi(p); }
double Phi(size_t p=0) const
Azimuthal angle at a point on the trajectory, with respect to z.
Definition: Trajectory.h:337
Trajectory_t const & Trajectory() const
Returns the plain trajectory of this object.
p
Definition: test.py:223
double recob::TrackTrajectory::Phi ( ) const
inline

Azimuthal angle at a first valid point, with respect to z.

Returns
angle with respect to positive z, in $ [0,\pi] $ [radians]
See also
Phi(size_t), Theta(), ZenithAngle()

The angle $ \phi $ is returned, as defined in recob::Trajectory::Phi(), for the first valid point in the trajectory.

Note
This is not equivalent to Phi(0), but instead to Phi(FirstValidPoint()).

Definition at line 385 of file TrackTrajectory.h.

386  { return Phi(FirstValidPoint()); }
size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.
double Phi() const
Azimuthal angle at a first valid point, with respect to z.
size_t recob::TrackTrajectory::PreviousValidPoint ( size_t  index) const
inline

Returns the index of the previous valid point in the trajectory.

Parameters
indexstarting index
Returns
index of previous valid point in trajectory, or InvalidIndex

Returns the index of the first point with the flag NoPoint unset, starting with the point with the specified index (included), and moving backward toward the start of the trajectory. It returns InvalidIndex if point at index is invalid and there are no valid points before it.

Definition at line 225 of file TrackTrajectory.h.

226  { return ToValidPoint<-1>(index); }
size_t ToValidPoint(size_t index) const
Returns the index of the first valid point from index on.
Point_t const& recob::TrackTrajectory::Start ( ) const
inline

Returns the position of the first valid point of the trajectory [cm].

Definition at line 253 of file TrackTrajectory.h.

254  { return LocationAtPoint(FirstValidPoint()); }
T LocationAtPoint(unsigned int p) const
Position at point p. Use e.g. as:
size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.
template<typename T >
T recob::TrackTrajectory::Start ( ) const
inline

Start position. Use e.g. as:

TVector3 start = tracktraj.Start<TVector3>();

.

Definition at line 538 of file TrackTrajectory.h.

538 { auto& loc = Start(); return T(loc.X(),loc.Y(),loc.Z()); }
Point_t const & Start() const
Returns the position of the first valid point of the trajectory [cm].
Vector_t recob::TrackTrajectory::StartDirection ( ) const
inline

Returns the direction of the trajectory at the first point.

Definition at line 317 of file TrackTrajectory.h.

318  { return DirectionAtPoint(FirstValidPoint()); }
T DirectionAtPoint(unsigned int p) const
Direction at point p. Use e.g. as:
size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.
template<typename T >
T recob::TrackTrajectory::StartDirection ( ) const
inline

Start direction. Use e.g. as:

TVector3 startdir = tracktraj.StartDirection<TVector3>();

.

Definition at line 550 of file TrackTrajectory.h.

550 { auto dir = StartDirection(); return T(dir.X(),dir.Y(),dir.Z()); }
string dir
Vector_t StartDirection() const
Returns the direction of the trajectory at the first point.
double recob::TrackTrajectory::StartMomentum ( ) const
inline

Computes and returns the modulus of momentum at the first point [GeV/c].

See also
StartMomentumVector()

Definition at line 477 of file TrackTrajectory.h.

478  { return StartMomentumVector().R(); }
Vector_t const & StartMomentumVector() const
Returns the momentum of the trajectory at the first valid point [GeV/c].
Vector_t const& recob::TrackTrajectory::StartMomentumVector ( ) const
inline

Returns the momentum of the trajectory at the first valid point [GeV/c].

Definition at line 462 of file TrackTrajectory.h.

size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.
T MomentumVectorAtPoint(unsigned int p) const
Momentum vector at point p. Use e.g. as:
template<typename T >
T recob::TrackTrajectory::StartMomentumVector ( ) const
inline

Momentum vector at start point. Use e.g. as:

TVector3 startmom = tracktraj.StartMomentumVector<TVector3>();

.

Definition at line 562 of file TrackTrajectory.h.

562 { auto mom = StartMomentumVector(); return T(mom.X(),mom.Y(),mom.Z()); }
Vector_t const & StartMomentumVector() const
Returns the momentum of the trajectory at the first valid point [GeV/c].
double recob::TrackTrajectory::Theta ( size_t  p) const
inline

Trajectory angle at point, with respect to positive z direction.

Parameters
pthe index point to extract the angle from (no default!)
Returns
angle with respect to positive z, in $ [0,\pi] $ [radians]

The angle $ \vartheta $ is returned, as defined in recob::Trajectory::Theta(), for point with the specified index p.

If the point is invalid, the behaviour is undefined.

Note
This function has no default value for p; if p is not specified at all, the method Theta() is called instead.

Definition at line 339 of file TrackTrajectory.h.

340  { return Trajectory().Theta(p); }
Trajectory_t const & Trajectory() const
Returns the plain trajectory of this object.
p
Definition: test.py:223
double Theta(size_t p=0) const
Trajectory angle at point, with respect to positive z direction.
Definition: Trajectory.h:320
double recob::TrackTrajectory::Theta ( ) const
inline

Trajectory angle at start, with respect to positive z direction.

Returns
angle with respect to positive z, in $ [0,\pi] $ [radians]

The angle $ \vartheta $ is returned, as defined in recob::Trajectory::Theta(), for the first valid point in the trajectory.

Note
This is not equivalent to Theta(0), but instead to Theta(FirstValidPoint()).

Definition at line 353 of file TrackTrajectory.h.

354  { return Theta(FirstValidPoint()); }
size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.
double Theta() const
Trajectory angle at start, with respect to positive z direction.
template<int Dir>
size_t recob::TrackTrajectory::ToValidPoint ( size_t  index) const
private

Returns the index of the first valid point from index on.

Template Parameters
Dirthe direction to move when an index has an invalid point
Parameters
indexthe starting index
Returns
index of the first valid point from index on (or InvalidIndex)

The valid direction Dir values are only +1 and -1. The first point considered is always the one at index. If no valid point is found, InvalidIndex is returned. The invariant guarantees that all these calls return a valid index:

if (!(
(ToValidPoint<+1>(0) != InvalidIndex) // FirstValidPoint()
&& (ToValidPoint<-1>(LastPoint()) != InvalidIndex) // LastValidPoint()
&& (ToValidPoint<+1>(FirstValidPoint()) != InvalidIndex) // LastValidPoint()
&& (ToValidPoint<-1>(LastValidPoint()) != InvalidIndex) // FirstValidPoint()
)) throw std::logic_error("Invalid TrackTrajectory!");
Trajectory_t const& recob::TrackTrajectory::Trajectory ( ) const
inline

Returns the plain trajectory of this object.

Definition at line 144 of file TrackTrajectory.h.

145  { return static_cast<Trajectory_t const&>(*this); }
recob::Trajectory Trajectory_t
Point_t const& recob::TrackTrajectory::Vertex ( void  ) const
inline

Returns the position of the first valid point of the trajectory [cm].

Definition at line 249 of file TrackTrajectory.h.

250  { return Start(); }
Point_t const & Start() const
Returns the position of the first valid point of the trajectory [cm].
template<typename T >
T recob::TrackTrajectory::Vertex ( void  ) const
inline

Start position. Use e.g. as:

TVector3 vertex = tracktraj.Vertex<TVector3>();

.

Definition at line 541 of file TrackTrajectory.h.

541 { auto& loc = Vertex(); return T(loc.X(),loc.Y(),loc.Z()); }
Point_t const & Vertex() const
Returns the position of the first valid point of the trajectory [cm].
Vector_t recob::TrackTrajectory::VertexDirection ( ) const
inline

Returns the direction of the trajectory at the first point.

Definition at line 313 of file TrackTrajectory.h.

314  { return StartDirection(); }
Vector_t StartDirection() const
Returns the direction of the trajectory at the first point.
template<typename T >
T recob::TrackTrajectory::VertexDirection ( ) const
inline

Start direction. Use e.g. as:

TVector3 vertexdir = tracktraj.VertexDirection<TVector3>();

.

Definition at line 553 of file TrackTrajectory.h.

553 { auto dir = VertexDirection(); return T(dir.X(),dir.Y(),dir.Z()); }
string dir
Vector_t VertexDirection() const
Returns the direction of the trajectory at the first point.
double recob::TrackTrajectory::VertexMomentum ( ) const
inline

Computes and returns the modulus of momentum at the first point [GeV/c].

See also
StartMomentum()

Definition at line 472 of file TrackTrajectory.h.

473  { return StartMomentum(); }
double StartMomentum() const
Vector_t const& recob::TrackTrajectory::VertexMomentumVector ( ) const
inline

Returns the momentum of the trajectory at the first valid point [GeV/c].

Definition at line 458 of file TrackTrajectory.h.

459  { return StartMomentumVector(); }
Vector_t const & StartMomentumVector() const
Returns the momentum of the trajectory at the first valid point [GeV/c].
template<typename T >
T recob::TrackTrajectory::VertexMomentumVector ( ) const
inline

Momentum vector at start point. Use e.g. as:

TVector3 vertexmom = tracktraj.VertexMomentumVector<TVector3>();

.

Definition at line 565 of file TrackTrajectory.h.

565 { auto mom = VertexMomentumVector(); return T(mom.X(),mom.Y(),mom.Z()); }
Vector_t const & VertexMomentumVector() const
Returns the momentum of the trajectory at the first valid point [GeV/c].
double recob::TrackTrajectory::ZenithAngle ( size_t  p) const
inline

"Zenith" angle of trajectory, with respect to the vertical axis.

Parameters
pthe index point to extract the angle from (no default!)
Returns
opposite of the actual zenith angle, in $ [0,\pi] $ [radians]
See also
AzimuthAngle(size_t)

The zenith is returned, as defined in recob::Trajectory::Zenith(), for point with the specified index p.

If the point is invalid, the behaviour is undefined.

Note
This function has no default value for p; if p is not specified at all, the method Zenith() is called instead.

Definition at line 404 of file TrackTrajectory.h.

405  { return Trajectory().ZenithAngle(p); }
Trajectory_t const & Trajectory() const
Returns the plain trajectory of this object.
double ZenithAngle(size_t p=0) const
"Zenith" angle of trajectory, with respect to the vertical axis.
Definition: Trajectory.cxx:82
p
Definition: test.py:223
double recob::TrackTrajectory::ZenithAngle ( ) const
inline

"Zenith" angle of trajectory, with respect to the vertical axis.

Returns
opposite of the actual zenith angle, in $ [0,\pi] $ [radians]
See also
Zenith(size_t), Theta()

The zenith angle is returned, as defined in recob::Trajectory::Zenith(), for the first valid point in the trajectory.

Note
This is not equivalent to Zenith(0), but instead to Zenith(FirstValidPoint()).

Definition at line 419 of file TrackTrajectory.h.

420  { return ZenithAngle(FirstValidPoint()); }
double ZenithAngle() const
"Zenith" angle of trajectory, with respect to the vertical axis.
size_t FirstValidPoint() const
Returns the index of the first valid point in the trajectory.

Member Data Documentation

Flags_t recob::TrackTrajectory::fFlags
private

Flags of each of the points in trajectory.

Definition at line 665 of file TrackTrajectory.h.

constexpr size_t recob::TrackTrajectory::InvalidIndex = std::numeric_limits<size_t>::max()
static

Value returned on failed index queries.

Definition at line 661 of file TrackTrajectory.h.

constexpr unsigned int recob::TrackTrajectory::MaxDumpVerbosity = 7
static

Largest verbosity level supported by Dump().

Definition at line 658 of file TrackTrajectory.h.


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