xboa
Public Member Functions | List of all members
TrackingBase Class Reference

Base class provides an interface to particle tracking routines for use by xboa.algorithms. More...

Inherits object.

Public Member Functions

def __init__
 
def track_one
 Track a hit and return a list of output hits. More...
 
def track_many
 Track many hits and return a list of list of output hits. More...
 

Detailed Description

Base class provides an interface to particle tracking routines for use by xboa.algorithms.

Definition at line 29 of file _tracking_base.py.

Constructor & Destructor Documentation

def __init__ (   self)

Definition at line 30 of file _tracking_base.py.

Member Function Documentation

def track_one (   self,
  hit 
)

Track a hit and return a list of output hits.

  • hit initial particle coordinates to be tracked

Track a hit and return a list of output hits. The output hits should corresponds to e.g. particle crossings over cell ends, depending on the usage of the Tracking object. The first item in the list should be the input hit.

Definition at line 43 of file _tracking_base.py.

Referenced by TrackingBase.track_many().

def track_many (   self,
  list_of_hits 
)

Track many hits and return a list of list of output hits.

  • list_of_hits list of initial particle corodinates to be tracked

Track many hits and return a list containing a list of output hits, one for each track. This provides a hook for tracking codes that have significant set up and tear down times, or which simulate collective effects that need to be taken into account by the algorithm

By default this calls track_one for each hit; but can be overloaded by a base class

Definition at line 59 of file _tracking_base.py.

References TrackingBase.track_one(), MAUSTracking.track_one(), and MatrixTracking.track_one().


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