 xboa | XBOA - Cross-Platform Beam Optics Analysis A multiparticle tracking postprocessor library for accelerator physicists |
  algorithms | The algorithms module provides algorithms for performing common accelerator physics tasks |
   closed_orbit | The closed_orbit module provides algorithms for finding closed_orbits |
    _ellipse_closed_orbit_finder | |
     EllipseClosedOrbitFinder | Find the closed orbit given an ellipse |
     EllipseClosedOrbitFinderIteration | Data following a single pass of the closed orbit finder |
   peak_finder | Algorithms to find peaks in potentially noisy data |
    _refine_peak_finder | |
     RefinePeakFinder | Find peaks in a list of data points when you have an estimate of the peaks position already, using a quadratic fit (in ROOT) to the peak |
    _uphill_downhill_peak_finder | |
     UphillDownhillPeakFinder | Find peaks in a list of data by looking at first derivative |
    _window_peak_finder | |
     WindowPeakFinder | Find peaks in a list of data points by looking for the peak within a window |
   smoothing | Algorithms to clean up noisy data by averaging over nearby points |
    _fit_smoothing | |
     FitSmoothing | |
    _gaussian_smoothing | |
     GaussianSmoothing | Gaussian smoothing class applies a smoothing by summing nearby data and weighting according to a truncated Gaussian distribution |
    _hanning_smoothing | |
     HanningSmoothing | |
   tune | The tune module provides algorithms for finding the tune |
    _fft_tune | |
     FFTTuneFinder | Find the tune using the fast fourier transform technique |
  bunch | Implemented within this module: |
   _bunch | |
    Bunch | Represents a bunch of particles |
   weighting | The weighting module provides algorithms for performing statistical weighting of bunches |
    _bounding_ellipse | |
     BoundingEllipse | Defines an arbitrary dimensional ellipse that can be taken as a boundary for VoronoiWeighting |
    _voronoi_weighting | |
     VoronoiWeighting | VoronoiWeighting class enables the user to set statistical weights of Hits in a Bunch based on how close they are to neighbouring Hits |
  Bunch | |
  common | Common module defines common utility data and functions that are used elsewhere |
   _common | |
    rg | Root globals line_color_int=1, line_style_int=1, line_width_int=2, fill_color_int=None, stats_bool=False, hist_title_string='' |
  Common | Deprecated accessor to xboa.common module |
  examples | A set of examples for using the xboa package |
   closed_orbit | Example code to find a closed orbit |
   Example_1 | Example code to read a file and perform some data access operations |
   Example_2 | Example code to read a file and make some plots |
   Example_3 | Example code to read a file, make some cuts and then plot |
   Example_4 | Example code to read a file, apply a transformation and plot before and after |
   File_Convert | |
  hit | Implemented within this module: |
   _hit | |
    BadEventError | BadEventError is raised if Hit reads a bad |
    Hit | Represents a particle at a point in some phase space |
   factory | The hit factory module defines a number of factory classes used for generating hit objects |
    _builtin_hit_factory | |
     BuiltinHitFactory | Factory class for line by line reads of output files |
    _hit_factory_base | |
     HitFactoryBase | Base factory class for making hits |
    _line_factory_base | |
     LineFactoryBase | Base factory class for line by line reads |
    _maus_json_hit_factory | |
     MausJsonHitFactory | MausJsonHitFactory strips hits of a specified type from a json_document and returns to the user |
    _maus_root_hit_factory | |
     MausRootHitFactory | MausRootHitFactory reads hits of a specified type from a root spill |
    _opal_hit_factory | |
     OpalHitFactory | Factory class for line by line reads of OPAL output files |
    _user_hit_factory | |
     UserHitFactory | Factory class for line by line reads of output files using a user-defined format |
  Hit | Deprecated accessor to xboa.hit module |
  tracking | The tracking module holds classes related to tracking interfaces for various Monte Carlo codes |
   _matrix_tracking | Should be imported directly from the xboa::tracking namespace |
    MatrixTracking | Class to mimic tracking using simple, user-supplied transfer matrices Each transfer matrix M_i0 must be of type numpy.matrix, where M is defined by u_i = M_i*(u_in-v_in) + v_i and u, v are matrices with shape (1, 6) going like (x, px, y, py, t, energy) |
   _maus_tracking | Should be imported directly from the xboa::tracking namespace |
    MAUSTracking | Provides an interface to MAUS tracking routines for use by xboa.algorithms |
   _tracking_base | Should be imported directly from the xboa::tracking namespace |
    TrackingBase | Base class provides an interface to particle tracking routines for use by xboa.algorithms |