Skip to main content
Ctrl+K

PyORBIT3

Site Navigation

  • Installation Guide
  • Contributor Guide
  • Python API Reference
  • C++ API Reference

Site Navigation

  • Installation Guide
  • Contributor Guide
  • Python API Reference
  • C++ API Reference

Section Navigation

  • orbit.aperture
    • Aperture
  • orbit.bumps
    • addTeapotBumpNode
    • TeapotSimpleBumpNode
    • TDTeapotSimpleBumpNode
    • simpleBump
    • close_orbit_bumps
    • TDsimpleBump
  • orbit.bunch_generators
    • TwissContainer
    • TwissAnalysis
    • GaussDist1D
    • GaussDist2D
    • GaussDist3D
    • KVDist1D
    • KVDist2D
    • KVDist3D
    • WaterBagDist1D
    • WaterBagDist2D
    • WaterBagDist3D
  • orbit.bunch_utils
    • collect_bunch
    • save_bunch
    • load_bunch
    • ParticleIdNumber
    • BunchDict
    • FileHandler
    • NumPyHandler
  • orbit.collimation
    • addTeapotCollimatorNode
    • TeapotCollimatorNode
  • orbit.core
  • orbit.diagnostics
    • addTeapotDiagnosticsNode
    • addTeapotDiagnosticsNodeAsChild
    • addTeapotStatLatsNodeSet
    • addTeapotMomentsNodeSet
    • profiles
    • StatLats
    • StatLatsSetMember
    • TeapotStatLatsNode
    • TeapotStatLatsNodeSetMember
    • Moments
    • MomentsSetMember
    • TeapotMomentsNode
    • TeapotMomentsNodeSetMember
    • TeapotTuneAnalysisNode
  • orbit.errors
    • addErrorNode
    • addErrorNodeAsChild
    • addErrorNodeAsChild_I
    • addErrorNodeAsChild_F
  • orbit.fieldtracker
    • FieldTracker
  • orbit.foils
    • addTeapotFoilNode
    • TeapotFoilNode
  • orbit.impedances
    • addImpedanceNode
    • addImpedanceNodeAsChild
  • orbit.injection
    • addTeapotInjectionNode
    • TeapotInjectionNode
    • InjectParts
    • JohoTransverse
    • JohoLongitudinal
    • UniformLongDist
    • UniformLongDistPaint
    • GULongDist
    • SNSESpreadDist
    • SNSESpreadDistPaint
    • ArbitraryLongDist
  • orbit.kickernodes
    • addTeapotKickerNode
    • TeapotXKickerNode
    • TeapotYKickerNode
    • rootTWaveform
    • flatTopWaveform
    • SquareRootWaveform
    • XKicker
    • YKicker
  • orbit.lattice
    • AccActionsContainer
    • AccNode
    • AccLattice
    • AccNodeBunchTracker
  • orbit.matching
    • Optics
    • EnvelopeSolver
  • orbit.matrix_lattice
    • MATRIX_Lattice
    • BaseMATRIX
  • orbit.orbit_correction
    • orbit
    • correction
  • orbit.parsers
    • MAD_Parser
    • MAD_LattElement
    • MAD_LattLine
    • MADX_Parser
    • MADX_LattElement
    • SAD_Parser
    • SAD_LattElement
    • SAD_LattLine
    • Field_Parser3D
  • orbit.py_linac
    • AccErrorNode
    • ErrorLongitudinalDisplacementNode
    • ErrorCoordDisplacementNode
    • ErrorBendFieldNode
    • ErrorStraightRotationZNode
    • ErrorStraightRotationXNode
    • ErrorStraightRotationYNode
    • BaseErrorController
    • ErrorCntrlLongitudinalDisplacement
    • ErrorCntrlCoordDisplacement
    • ErrorCntrlBendField
    • ErrorCntrlStraightRotationZ
    • ErrorCntrlStraightRotationX
    • ErrorCntrlStraightRotationY
    • GetGlobalQuadGradient
    • GetGlobalQuadGradientDerivative
    • GetGlobalRF_AxisField
    • getNodeForNameFromWholeLattice
    • getNodePosDictForWholeLattice
    • getAllNodesInLattice
    • getAllMagnetsInLattice
    • LinacAccLattice
    • BaseLinacNode
    • LinacNode
    • LinacMagnetNode
    • MarkerLinacNode
    • Drift
    • Quad
    • AbstractRF_Gap
    • DCorrectorH
    • DCorrectorV
    • ThickKick
    • Bend
    • Solenoid
    • LinacApertureNode
    • CircleLinacApertureNode
    • EllipseLinacApertureNode
    • RectangleLinacApertureNode
    • LinacPhaseApertureNode
    • LinacEnergyApertureNode
    • RF_Cavity
    • Sequence
    • BaseRF_Gap
    • AxisFieldRF_Gap
    • RF_AxisFieldsStore
    • AxisField_and_Quad_RF_Gap
    • OverlappingQuadsNode
    • LinacTrMatrixGenNode
    • LinacTrMatricesController
    • LinacBPM
    • Add_quad_apertures_to_lattice
    • Add_bend_apertures_to_lattice
    • Add_rfgap_apertures_to_lattice
    • GetLostDistributionArr
    • AddScrapersAperturesToLattice
    • Add_drift_apertures_to_lattice
    • AddMEBTChopperPlatesAperturesToSNS_Lattice
    • Replace_BaseRF_Gap_to_AxisField_Nodes
    • Replace_BaseRF_Gap_and_Quads_to_Overlapping_Nodes
    • Replace_Quads_to_OverlappingQuads_Nodes
    • ErrorForNodesModification
    • CoordinateDisplacementNodesModification
    • BendFieldNodesModification
    • LongitudinalDisplacementNodesModification
    • StraightRotationZ_NodesModification
    • StraightRotationX_NodesModification
    • StraightRotationY_NodesModification
    • QuadFieldsErrorsDeployment
    • SNS_LinacLatticeFactory
    • JPARC_LinacLatticeFactory
    • VacuumWindowNode
    • TransverseBPM
    • TrajectoryCorrection
    • SNS_EngeFunctionFactory
    • JPARC_EngeFunctionFactory
    • EngeFunction
    • AbstractQuadFieldSourceFunction
    • SimpleQuadFieldFunc
    • PMQ_Trace3D_Function
    • RF_AxisFieldAnalysis
    • SuperFish_3D_RF_FieldReader
  • orbit.rf_cavities
    • addRFNode
    • Frequency_RFNode
    • Harmonic_RFNode
    • BRhoDep_Harmonic_RFNode
    • SyncPhaseDep_Harmonic_RFNode
    • Barrier_RFNode
  • orbit.space_charge
    • setSC_General_AccNodes
    • setSC_Centered_AccNodes
    • SC_Base_AccNode
  • orbit.teapot
    • TEAPOT_Lattice
    • TEAPOT_Ring
    • BaseTEAPOT
    • DriftTEAPOT
    • BunchWrapTEAPOT
    • BendTEAPOT
    • QuadTEAPOT
    • MultipoleTEAPOT
    • SolenoidTEAPOT
    • KickTEAPOT
    • RingRFTEAPOT
    • FringeFieldTEAPOT
    • TiltTEAPOT
    • NodeTEAPOT
    • TEAPOT_MATRIX_Lattice
  • orbit.teapot_base
    • MatrixGenerator
  • orbit.time_dep
    • TIME_DEP_Lattice
  • orbit.utils
    • multiDimDoubleArray
    • multiDimIntArray
    • orbitFinalize
    • phaseNearTargetPhase
    • phaseNearTargetPhaseDeg
    • NamedObject
    • TypedObject
    • ParamsDictObject
  • Python API Reference
  • orbit.matching
  • Optics

Optics#

class orbit.matching.Optics[source]#

Bases: object

Methods Summary

add(x)

get_element(s)

get_length()

print_line()

readtwiss_teapot(lattice, bunch)

Methods Documentation

add(x)[source]#
get_element(s)[source]#
get_length()[source]#
print_line()[source]#
readtwiss_teapot(lattice, bunch)[source]#

previous

orbit.matching

next

EnvelopeSolver

Show Source

© Copyright 2025, PyORBIT Collaboration.

Created using Sphinx 4.5.0.

Built with the PyData Sphinx Theme 0.13.3.