apixtrack.rst

Xtrack API

Table of Contents

• Line
• Tracker
• Beam elements
  • Drift
  • Multipole
  • Cavity
  • RFMultipole
  • DipoleEdge
  • XYShift
  • SRotation
  • LimitEllipse
  • LimitRect
  • LimitRectEllipse
  • LimitRectPolygon
• Monitors
• Beam interaction
• BeamElement base class
• Loss location refinement

Line

.. autoclass:: xtrack.Line
    :members:
    :undoc-members:
    :member-order: bysource

Tracker

.. autoclass:: xtrack.Tracker
    :members:
    :undoc-members:
    :member-order: bysource

Beam elements

Drift

.. autoclass:: xtrack.Drift
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

Multipole

.. autoclass:: xtrack.Multipole
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

Cavity

.. autoclass:: xtrack.Cavity
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

RFMultipole

.. autoclass:: xtrack.RFMultipole
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

DipoleEdge

.. autoclass:: xtrack.DipoleEdge
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

XYShift

.. autoclass:: xtrack.XYShift
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

SRotation

.. autoclass:: xtrack.SRotation
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

LimitEllipse

.. autoclass:: xtrack.LimitEllipse
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

LimitRect

.. autoclass:: xtrack.LimitRect
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

LimitRectEllipse

.. autoclass:: xtrack.LimitRectEllipse
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

LimitRectPolygon

.. autoclass:: xtrack.LimitPolygon
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

Monitors

.. autoclass:: xtrack.ParticlesMonitor
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

Beam interaction

.. autoclass:: xtrack.BeamInteraction
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance:

BeamElement base class

.. autoclass:: xtrack.base_element.BeamElement
    :members:
    :undoc-members:
    :inherited-members:
    :exclude-members: track_kernel_source, track_kernel_description, compile_custom_kernels, _XoStruct
    :member-order: bysource

Loss location refinement

.. autoclass:: xtrack.LossLocationRefinement
    :members:
    :undoc-members:
    :member-order: bysource
    :show-inheritance: