.. This file content is autogenerated from ``xtrack.line.Line.__doc_groups__``. Members - short description -------------------------- .. raw:: html .. _line-api-line-editing-summary: .. list-table:: :ref:`Line Editing ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`append(...) ` - Append elements to the line. * - :ref:`clone(...) ` - Create a cloned copy of the line with renamed independent elements. * - :ref:`copy(...) ` - Return a copy of the line. * - :ref:`cut_​at_​s(...) ` - Slice the line so that positions in s never fall inside an element. * - :ref:`cycle(...) ` - Cycle the line to start from a given element. * - :ref:`extend_​knl_​ksl(...) ` - Extend the order of the knl and ksl attributes of the elements. * - :ref:`extend_​knl_​rel_​ksl_​rel(...) ` - Extend the order of the knl_​rel and ksl_​rel attributes of the elements. * - :ref:`insert(...) ` - Insert elements in the line. * - :ref:`mirror(...) ` - Reverse the order of elements in the line. * - :ref:`remove(...) ` - Remove an element from the line. If the element is thick, it is replaced by a drift. * - :ref:`replace(...) ` - Replace an element in the line with another element having the same length. * - :ref:`replace_​all_​repeated_​elements(...) ` - Replace repeated element occurrences with newly named elements. * - :ref:`replace_​all_​replicas(...) ` - Replace all replica elements found in the line with clones of their parent elements. Expressions on element attributes are preserved. * - :ref:`replace_​replica(...) ` - Replace a replica element a clone of its parent element. Expressions on element attributes are preserved. * - :ref:`replicate(...) ` - Create a replicated copy of the line with renamed elements. * - :ref:`select(...) ` - Select a part of the line and return it as a new line (shallow copy, i.e. the elements are in common with the original line). * - :ref:`slice_​thick_​elements(...) ` - Slice thick elements in the line. Slicing is done in place. * - :ref:`element_​dict ` - Dictionary-like container of elements in the line environment. * - :ref:`element_​names ` - Ordered list of element names defining the line sequence. * - :ref:`element_​refs ` - Dictionary-like container of xdeps element references. * - :ref:`elements ` - Tuple-like container of element-object views in line order. .. _line-api-compose-mode-summary: .. list-table:: :ref:`Compose Mode ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`end_​compose(...) ` - Resolve compose-mode placements and switch the line back to normal mode. * - :ref:`new(...) ` - Create a new element and append it to the compose-mode component list. * - :ref:`place(...) ` - Place an existing object or name in the compose-mode component list. * - :ref:`regenerate_​from_​composer(...) ` - Re-enter compose mode using the attached composer. * - :ref:`composer ` - Builder used when the line is in ``compose`` mode. * - :ref:`mode ` - Current line mode. .. _line-api-inspection-variables-and-configuration-summary: .. list-table:: :ref:`Inspection, Variables and Configuration ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`eval(...) ` - Get the value of an expression * - :ref:`get(...) ` - Get an element or the value of a variable. * - :ref:`get_​expr(...) ` - Get expression associated to a variable * - :ref:`get_​length(...) ` - Get total length of the line * - :ref:`get_​strengths(...) ` - Return integrated magnet strengths as a table. * - :ref:`get_​table(...) ` - Return a table with line element information and longitudinal positions. * - :ref:`info(...) ` - Get information about an element or a variable. * - :ref:`items(...) ` - Iterate over line elements in sequence. * - :ref:`new_​expr(...) ` - Create a new xdeps expression object. * - :ref:`set(...) ` - Set the values or expressions of variables or element properties. A single call can set one or multiple variables or elements. * - :ref:`attr ` - Line-attribute accessor. * - :ref:`env ` - Environment to which this line belongs. * - :ref:`functions ` - xdeps function container used in expressions. * - :ref:`metadata ` - User metadata associated with the line. * - :ref:`name ` - Name of the line (if it is part of a `MultiLine`) * - :ref:`ref ` - xdeps reference container for variables and element fields. * - :ref:`ref_​manager ` - xdeps dependency manager for variables, element references, and expressions. * - :ref:`vars ` - Variables container associated with the line environment. .. _line-api-reference-particle-and-particle-generation-summary: .. list-table:: :ref:`Reference Particle and Particle Generation ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`build_​particles(...) ` - Create a Particles object from arrays containing physical or normalized coordinates. * - :ref:`set_​particle_​ref(...) ` - Set the reference particle of the line. See `particle_​ref` property. * - :ref:`particle_​ref ` - Reference particle used by the line for optics and tracking defaults. .. _line-api-tracking-and-analysis-summary: .. list-table:: :ref:`Tracking and Analysis ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`find_​closed_​orbit(...) ` - Find the closed orbit of the beamline. * - :ref:`get_​R_​matrix(...) ` - Compute the one turn matrix using finite differences. * - :ref:`get_​T_​matrix(...) ` - Compute the second order tensor of the beamline. * - :ref:`get_​amplitude_​detuning_​coefficients(...) ` - Compute the amplitude detuning coefficients (det_​xx = dQx / dJx, det_​yy = dQy / dJy, det_​xy = dQx / dJy, det_​yx = dQy / dJx) using tracking. * - :ref:`get_​footprint(...) ` - Compute the tune footprint for a beam with given emittences using tracking. * - :ref:`get_​line_​with_​second_​order_​maps(...) ` - Return a new lines with segments definded by the elements in `split_​at` replaced by second order maps. * - :ref:`get_​non_​linear_​chromaticity(...) ` - Get non-linear chromaticity for given range of delta values * - :ref:`survey(...) ` - Compute the geometrical layout, i.e. the coordinates of all beam line elements in the global reference system. * - :ref:`track(...) ` - Track particles through the line. * - :ref:`twiss(...) ` - Compute the Twiss parameters of the beam line. If no initial conditions are provided, the periodic solution is computed. * - :ref:`twiss4d(...) ` - Compute the 4D Twiss parameters. Equivalent to `twiss` with `method='4d'`. * - :ref:`twiss6d(...) ` - Compute the 6D Twiss parameters. Equivalent to `twiss` with `method='6d'`. * - :ref:`dt_​update_​time_​dependent_​vars ` - Time interval between updates of time-dependent variables. * - :ref:`enable_​time_​dependent_​vars ` - Flag controlling updates of time-dependent variables during tracking. * - :ref:`energy_​program ` - Reference energy program to be followed during the simulation. * - :ref:`matrix_​responsiveness_​tol ` - Responsiveness tolerance used in finite-difference matrix computations. * - :ref:`matrix_​stability_​tol ` - Stability tolerance used in finite-difference matrix computations. * - :ref:`record_​last_​track ` - Particle coordinates recorded during the most recent ``track(...)`` call. * - :ref:`record_​multi_​element_​last_​track ` - Particle coordinates recorded for selected elements in the most recent ``track(...)`` call. * - :ref:`time_​last_​track ` - Execution time of the most recent ``track(...)`` call. * - :ref:`twiss_​default ` - Default options used by Twiss-related computations. .. _line-api-matching-and-corrections-summary: .. list-table:: :ref:`Matching and Corrections ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`correct_​trajectory(...) ` - Correct the beam trajectory using linearized response matrix from optics table. * - :ref:`match(...) ` - Change a set of knobs in the beamline in order to match assigned targets. * - :ref:`match_​knob(...) ` - Match a new knob in the beam line such that the specified targets are matched when the knob is set to the value `knob_​value_​end` and the state of the line before tha matching is recovered when the knob is set to the value `knob_​value_​start`. * - :ref:`target(...) ` - Create a target object for line-level matching expressions. * - :ref:`corrector_​limits_​x ` - Horizontal steering-corrector limits used by trajectory correction. * - :ref:`corrector_​limits_​y ` - Vertical steering-corrector limits used by trajectory correction. * - :ref:`steering_​correctors_​x ` - Names of horizontal steering correctors used by trajectory correction. * - :ref:`steering_​correctors_​y ` - Names of vertical steering correctors used by trajectory correction. * - :ref:`steering_​monitors_​x ` - Names of horizontal trajectory monitors used by trajectory correction. * - :ref:`steering_​monitors_​y ` - Names of vertical trajectory monitors used by trajectory correction. .. _line-api-magnet-model-configuration-summary: .. list-table:: :ref:`Magnet Model Configuration ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`configure_​bend_​model(...) ` - Configure the method used to track bends. * - :ref:`configure_​drift_​model(...) ` - Configure the method used to track drifts. * - :ref:`configure_​octupole_​model(...) ` - Configure the model for all octupoles in the line. * - :ref:`configure_​quadrupole_​model(...) ` - Configure the model for all quadrupoles in the line. * - :ref:`configure_​sextupole_​model(...) ` - Configure the model for all sextupoles in the line. .. _line-api-radiation-spin-and-intra-beam-scattering-summary: .. list-table:: :ref:`Radiation, Spin and Intra-Beam Scattering ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`compensate_​radiation_​energy_​loss(...) ` - Compensate beam energy loss from synchrotron radiation by configuring RF cavities and Multipole elements (tapering). * - :ref:`configure_​intrabeam_​scattering(...) ` - Configures the IBS kick element in the line for tracking. * - :ref:`configure_​radiation(...) ` - Configure radiation within the line. * - :ref:`configure_​spin(...) ` - Configure the spin model for the line. * - :ref:`xcoll ` - Xcoll-specific helpers associated with this line. .. _line-api-energy-longitudinal-state-summary: .. list-table:: :ref:`Energy & Longitudinal State ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`freeze_​energy(...) ` - Freeze energy in tracked Particles objects. * - :ref:`freeze_​longitudinal(...) ` - Freeze longitudinal coordinates in tracked Particles objects. .. _line-api-tracker-setup-summary: .. list-table:: :ref:`Tracker Setup ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`build_​tracker(...) ` - Build the tracker associated to the line. This freezes the line (elements cannot be inserted or removed anymore). Use `discard_​tracker` to unfreeze the line if needed. * - :ref:`discard_​tracker(...) ` - Discard the tracker associated to the line. This unfreezes the line (elements can be inserted or removed again). * - :ref:`config ` - Tracking configuration flags and options. * - :ref:`iscollective ` - Whether the built tracker runs in collective mode. * - :ref:`reset_​s_​at_​end_​turn ` - Whether longitudinal position ``s`` is reset at the end of each turn. * - :ref:`skip_​end_​turn_​actions ` - Whether end-turn actions are skipped during tracking. * - :ref:`tracker ` - Tracker associated with this line, if built. .. _line-api-constructors-and-serialization-summary: .. list-table:: :ref:`Constructors and Serialization ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`from_​dict(...) ` - Create a Line object from a dictionary. * - :ref:`from_​json(...) ` - Constructs a line from a JSON file. * - :ref:`from_​madx_​sequence(...) ` - Build a line from a MAD-X sequence. * - :ref:`from_​sequence(...) ` - Constructs a line from a sequence definition, inserting drift spaces as needed. * - :ref:`to_​dict(...) ` - Returns a dictionary representation of the line. * - :ref:`to_​json(...) ` - Save the line to a json file. * - :ref:`to_​madng(...) ` - Build a MAD NG instance from present state of the line. * - :ref:`to_​madx_​sequence(...) ` - Return a MAD-X sequence corresponding to the line. .. _line-api-element-internal-logging-summary: .. list-table:: :ref:`Element Internal Logging ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`start_​internal_​logging_​for_​elements_​of_​type(...) ` - Start internal logging for all elements of a given type. * - :ref:`stop_​internal_​logging_​for_​all_​elements(...) ` - Stop internal logging for all elements. * - :ref:`stop_​internal_​logging_​for_​elements_​of_​type(...) ` - Stop internal logging for all elements of a given type. .. _line-api-cleanup-and-simplification-summary: .. list-table:: :ref:`Cleanup and Simplification ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`merge_​consecutive_​drifts(...) ` - Merge consecutive drifts into a single drift * - :ref:`merge_​consecutive_​multipoles(...) ` - Merge consecutive multipoles into one multipole. * - :ref:`optimize_​for_​tracking(...) ` - Optimize the line for tracking by removing inactive elements and merging consecutive elements where possible. Deferred expressions are disabled. * - :ref:`remove_​inactive_​multipoles(...) ` - Remove inactive multipoles from the line * - :ref:`remove_​markers(...) ` - Remove markers from the line * - :ref:`remove_​redundant_​apertures(...) ` - Remove redundant apertures from the line * - :ref:`remove_​zero_​length_​drifts(...) ` - Remove zero length drifts from the line * - :ref:`use_​simple_​bends(...) ` - Replace multipoles having only the horizontal dipolar component with dipole elements. The element is not replaced when synchrotron radiation is active. * - :ref:`use_​simple_​quadrupoles(...) ` - Replace multipoles having only the normal quadrupolar component with quadrupole elements. The element is not replaced when synchrotron radiation is active. .. _line-api-mad-ng-integration-summary: .. list-table:: :ref:`MAD-NG Integration ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`build_​madng_​model(...) ` - Build and attach the MAD-NG model associated with this line. * - :ref:`discard_​madng_​model(...) ` - Discard the attached MAD-NG model for this line. * - :ref:`madng_​survey(...) ` - Run a survey using the MAD-NG model. * - :ref:`madng_​twiss(...) ` - Run a Twiss calculation using the MAD-NG model. * - :ref:`regen_​madng_​model(...) ` - Regenerate the MAD-NG model associated with this line. .. _line-api-deprecated-summary: .. list-table:: :ref:`Deprecated ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`append_​element(...) ` - Append element to the end of the lattice * - :ref:`compute_​R_​matrix(...) ` - Compute the one turn matrix using finite differences. * - :ref:`compute_​T_​matrix(...) ` - Compute the second order tensor of the beamline. * - :ref:`compute_​one_​turn_​matrix_​finite_​differences(...) ` - Deprecated. Compute the one turn matrix using finite differences. * - :ref:`from_​sixinput(...) ` - ``Line.from_​sixinput`` has been removed in favour of ``sixinput.generate_​xtrack_​line()``. * - :ref:`get_​elements_​of_​type(...) ` - Get all elements of given type(s) * - :ref:`get_​s_​elements(...) ` - Get s position for all elements * - :ref:`get_​s_​position(...) ` - Get s position for given elements * - :ref:`insert_​element(...) ` - Insert an element in the line. * - :ref:`to_​pandas(...) ` - Return a pandas DataFrame with the elements of the line. * - :ref:`unfreeze(...) ` - Use :meth:`Line.discard_​tracker` instead. * - :ref:`builder ` - Deprecated alias for ``line.composer``. * - :ref:`varval ` - Convenience accessor to variable values. * - :ref:`vv ` - Short alias for variable values. .. _line-api-upcoming-deprecations-summary: .. list-table:: :ref:`Upcoming Deprecations ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`check_​aperture(...) ` - Check that all active elements have an associated aperture. * - :ref:`extend(...) ` - Append existing element names to this line. * - :ref:`filter_​elements(...) ` - Return a new line with only the elements satisfying a given condition. Other elements are replaced with Drifts. * - :ref:`freeze_​vars(...) ` - Freeze variables in tracked Particles objects. * - :ref:`get_​aperture_​table(...) ` - Return a table with the horizontal and vertical aperture estimated at all elements of the line. The aperture is estimated by tracking a particle through the line and measuring the maximum and minumum horizontal and vertical position at which particles survive. For elements at which no lost particles are detected, the aperture is estimated by interpolating the values of the neighbouring elements. * - :ref:`unfreeze_​vars(...) ` - Unfreeze variables in tracked Particles objects. * - :ref:`collimators ` - Deprecated alias for ``line.xcoll.collimators``. * - :ref:`scattering ` - Deprecated alias for ``line.xcoll.scattering``. Members - full description -------------------------- .. _line-api-line-editing: Line Editing ~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-line-editing-methods: .. _line-api-line-editing-method-append: .. automethod:: xtrack.line.Line.append .. _line-api-line-editing-method-clone: .. automethod:: xtrack.line.Line.clone .. _line-api-line-editing-method-copy: .. automethod:: xtrack.line.Line.copy .. _line-api-line-editing-method-cut-at-s: .. automethod:: xtrack.line.Line.cut_at_s .. _line-api-line-editing-method-cycle: .. automethod:: xtrack.line.Line.cycle .. _line-api-line-editing-method-extend-knl-ksl: .. automethod:: xtrack.line.Line.extend_knl_ksl .. _line-api-line-editing-method-extend-knl-rel-ksl-rel: .. automethod:: xtrack.line.Line.extend_knl_rel_ksl_rel .. _line-api-line-editing-method-insert: .. automethod:: xtrack.line.Line.insert .. _line-api-line-editing-method-mirror: .. automethod:: xtrack.line.Line.mirror .. _line-api-line-editing-method-remove: .. automethod:: xtrack.line.Line.remove .. _line-api-line-editing-method-replace: .. automethod:: xtrack.line.Line.replace .. _line-api-line-editing-method-replace-all-repeated-elements: .. automethod:: xtrack.line.Line.replace_all_repeated_elements .. _line-api-line-editing-method-replace-all-replicas: .. automethod:: xtrack.line.Line.replace_all_replicas .. _line-api-line-editing-method-replace-replica: .. automethod:: xtrack.line.Line.replace_replica .. _line-api-line-editing-method-replicate: .. automethod:: xtrack.line.Line.replicate .. _line-api-line-editing-method-select: .. automethod:: xtrack.line.Line.select .. _line-api-line-editing-method-slice-thick-elements: .. automethod:: xtrack.line.Line.slice_thick_elements .. _line-api-line-editing-properties: .. _line-api-line-editing-property-element-dict: .. autoproperty:: xtrack.line.Line.element_dict .. _line-api-line-editing-property-element-names: .. autoproperty:: xtrack.line.Line.element_names .. _line-api-line-editing-property-element-refs: .. autoproperty:: xtrack.line.Line.element_refs .. _line-api-line-editing-property-elements: .. autoproperty:: xtrack.line.Line.elements .. _line-api-compose-mode: Compose Mode ~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-compose-mode-methods: .. _line-api-compose-mode-method-end-compose: .. automethod:: xtrack.line.Line.end_compose .. _line-api-compose-mode-method-new: .. automethod:: xtrack.line.Line.new .. _line-api-compose-mode-method-place: .. automethod:: xtrack.line.Line.place .. _line-api-compose-mode-method-regenerate-from-composer: .. automethod:: xtrack.line.Line.regenerate_from_composer .. _line-api-compose-mode-properties: .. _line-api-compose-mode-property-composer: .. autoproperty:: xtrack.line.Line.composer .. _line-api-compose-mode-property-mode: .. autoproperty:: xtrack.line.Line.mode .. _line-api-inspection-variables-and-configuration: Inspection, Variables and Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-inspection-variables-and-configuration-methods: .. _line-api-inspection-variables-and-configuration-method-eval: .. automethod:: xtrack.line.Line.eval .. _line-api-inspection-variables-and-configuration-method-get: .. automethod:: xtrack.line.Line.get .. _line-api-inspection-variables-and-configuration-method-get-expr: .. automethod:: xtrack.line.Line.get_expr .. _line-api-inspection-variables-and-configuration-method-get-length: .. automethod:: xtrack.line.Line.get_length .. _line-api-inspection-variables-and-configuration-method-get-strengths: .. automethod:: xtrack.line.Line.get_strengths .. _line-api-inspection-variables-and-configuration-method-get-table: .. automethod:: xtrack.line.Line.get_table .. _line-api-inspection-variables-and-configuration-method-info: .. automethod:: xtrack.line.Line.info .. _line-api-inspection-variables-and-configuration-method-items: .. automethod:: xtrack.line.Line.items .. _line-api-inspection-variables-and-configuration-method-new-expr: .. automethod:: xtrack.line.Line.new_expr .. _line-api-inspection-variables-and-configuration-method-set: .. automethod:: xtrack.line.Line.set .. _line-api-inspection-variables-and-configuration-properties: .. _line-api-inspection-variables-and-configuration-property-attr: .. autoproperty:: xtrack.line.Line.attr .. _line-api-inspection-variables-and-configuration-property-env: .. autoproperty:: xtrack.line.Line.env .. _line-api-inspection-variables-and-configuration-property-functions: .. autoproperty:: xtrack.line.Line.functions .. _line-api-inspection-variables-and-configuration-property-metadata: .. autoproperty:: xtrack.line.Line.metadata .. _line-api-inspection-variables-and-configuration-property-name: .. autoproperty:: xtrack.line.Line.name .. _line-api-inspection-variables-and-configuration-property-ref: .. autoproperty:: xtrack.line.Line.ref .. _line-api-inspection-variables-and-configuration-property-ref-manager: .. autoproperty:: xtrack.line.Line.ref_manager .. _line-api-inspection-variables-and-configuration-property-vars: .. autoproperty:: xtrack.line.Line.vars .. _line-api-reference-particle-and-particle-generation: Reference Particle and Particle Generation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-reference-particle-and-particle-generation-methods: .. _line-api-reference-particle-and-particle-generation-method-build-particles: .. automethod:: xtrack.line.Line.build_particles .. _line-api-reference-particle-and-particle-generation-method-set-particle-ref: .. automethod:: xtrack.line.Line.set_particle_ref .. _line-api-reference-particle-and-particle-generation-properties: .. _line-api-reference-particle-and-particle-generation-property-particle-ref: .. autoproperty:: xtrack.line.Line.particle_ref .. _line-api-tracking-and-analysis: Tracking and Analysis ~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-tracking-and-analysis-methods: .. _line-api-tracking-and-analysis-method-find-closed-orbit: .. automethod:: xtrack.line.Line.find_closed_orbit .. _line-api-tracking-and-analysis-method-get-r-matrix: .. automethod:: xtrack.line.Line.get_R_matrix .. _line-api-tracking-and-analysis-method-get-t-matrix: .. automethod:: xtrack.line.Line.get_T_matrix .. _line-api-tracking-and-analysis-method-get-amplitude-detuning-coefficients: .. automethod:: xtrack.line.Line.get_amplitude_detuning_coefficients .. _line-api-tracking-and-analysis-method-get-footprint: .. automethod:: xtrack.line.Line.get_footprint .. _line-api-tracking-and-analysis-method-get-line-with-second-order-maps: .. automethod:: xtrack.line.Line.get_line_with_second_order_maps .. _line-api-tracking-and-analysis-method-get-non-linear-chromaticity: .. automethod:: xtrack.line.Line.get_non_linear_chromaticity .. _line-api-tracking-and-analysis-method-survey: .. automethod:: xtrack.line.Line.survey .. _line-api-tracking-and-analysis-method-track: .. automethod:: xtrack.line.Line.track .. _line-api-tracking-and-analysis-method-twiss: .. automethod:: xtrack.line.Line.twiss .. _line-api-tracking-and-analysis-method-twiss4d: .. automethod:: xtrack.line.Line.twiss4d .. _line-api-tracking-and-analysis-method-twiss6d: .. automethod:: xtrack.line.Line.twiss6d .. _line-api-tracking-and-analysis-properties: .. _line-api-tracking-and-analysis-property-dt-update-time-dependent-vars: .. autoproperty:: xtrack.line.Line.dt_update_time_dependent_vars .. _line-api-tracking-and-analysis-property-enable-time-dependent-vars: .. autoproperty:: xtrack.line.Line.enable_time_dependent_vars .. _line-api-tracking-and-analysis-property-energy-program: .. autoproperty:: xtrack.line.Line.energy_program .. _line-api-tracking-and-analysis-property-matrix-responsiveness-tol: .. autoproperty:: xtrack.line.Line.matrix_responsiveness_tol .. _line-api-tracking-and-analysis-property-matrix-stability-tol: .. autoproperty:: xtrack.line.Line.matrix_stability_tol .. _line-api-tracking-and-analysis-property-record-last-track: .. autoproperty:: xtrack.line.Line.record_last_track .. _line-api-tracking-and-analysis-property-record-multi-element-last-track: .. autoproperty:: xtrack.line.Line.record_multi_element_last_track .. _line-api-tracking-and-analysis-property-time-last-track: .. autoproperty:: xtrack.line.Line.time_last_track .. _line-api-tracking-and-analysis-property-twiss-default: .. autoproperty:: xtrack.line.Line.twiss_default .. _line-api-matching-and-corrections: Matching and Corrections ~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-matching-and-corrections-methods: .. _line-api-matching-and-corrections-method-correct-trajectory: .. automethod:: xtrack.line.Line.correct_trajectory .. _line-api-matching-and-corrections-method-match: .. automethod:: xtrack.line.Line.match .. _line-api-matching-and-corrections-method-match-knob: .. automethod:: xtrack.line.Line.match_knob .. _line-api-matching-and-corrections-method-target: .. automethod:: xtrack.line.Line.target .. _line-api-matching-and-corrections-properties: .. _line-api-matching-and-corrections-property-corrector-limits-x: .. autoproperty:: xtrack.line.Line.corrector_limits_x .. _line-api-matching-and-corrections-property-corrector-limits-y: .. autoproperty:: xtrack.line.Line.corrector_limits_y .. _line-api-matching-and-corrections-property-steering-correctors-x: .. autoproperty:: xtrack.line.Line.steering_correctors_x .. _line-api-matching-and-corrections-property-steering-correctors-y: .. autoproperty:: xtrack.line.Line.steering_correctors_y .. _line-api-matching-and-corrections-property-steering-monitors-x: .. autoproperty:: xtrack.line.Line.steering_monitors_x .. _line-api-matching-and-corrections-property-steering-monitors-y: .. autoproperty:: xtrack.line.Line.steering_monitors_y .. _line-api-magnet-model-configuration: Magnet Model Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-magnet-model-configuration-methods: .. _line-api-magnet-model-configuration-method-configure-bend-model: .. automethod:: xtrack.line.Line.configure_bend_model .. _line-api-magnet-model-configuration-method-configure-drift-model: .. automethod:: xtrack.line.Line.configure_drift_model .. _line-api-magnet-model-configuration-method-configure-octupole-model: .. automethod:: xtrack.line.Line.configure_octupole_model .. _line-api-magnet-model-configuration-method-configure-quadrupole-model: .. automethod:: xtrack.line.Line.configure_quadrupole_model .. _line-api-magnet-model-configuration-method-configure-sextupole-model: .. automethod:: xtrack.line.Line.configure_sextupole_model .. _line-api-radiation-spin-and-intra-beam-scattering: Radiation, Spin and Intra-Beam Scattering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-radiation-spin-and-intra-beam-scattering-methods: .. _line-api-radiation-spin-and-intra-beam-scattering-method-compensate-radiation-energy-loss: .. automethod:: xtrack.line.Line.compensate_radiation_energy_loss .. _line-api-radiation-spin-and-intra-beam-scattering-method-configure-intrabeam-scattering: .. automethod:: xtrack.line.Line.configure_intrabeam_scattering .. _line-api-radiation-spin-and-intra-beam-scattering-method-configure-radiation: .. automethod:: xtrack.line.Line.configure_radiation .. _line-api-radiation-spin-and-intra-beam-scattering-method-configure-spin: .. automethod:: xtrack.line.Line.configure_spin .. _line-api-radiation-spin-and-intra-beam-scattering-properties: .. _line-api-radiation-spin-and-intra-beam-scattering-property-xcoll: .. autoproperty:: xtrack.line.Line.xcoll .. _line-api-energy-longitudinal-state: Energy & Longitudinal State ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-energy-longitudinal-state-methods: .. _line-api-energy-longitudinal-state-method-freeze-energy: .. automethod:: xtrack.line.Line.freeze_energy .. _line-api-energy-longitudinal-state-method-freeze-longitudinal: .. automethod:: xtrack.line.Line.freeze_longitudinal .. _line-api-tracker-setup: Tracker Setup ~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-tracker-setup-methods: .. _line-api-tracker-setup-method-build-tracker: .. automethod:: xtrack.line.Line.build_tracker .. _line-api-tracker-setup-method-discard-tracker: .. automethod:: xtrack.line.Line.discard_tracker .. _line-api-tracker-setup-properties: .. _line-api-tracker-setup-property-config: .. autoproperty:: xtrack.line.Line.config .. _line-api-tracker-setup-property-iscollective: .. autoproperty:: xtrack.line.Line.iscollective .. _line-api-tracker-setup-property-reset-s-at-end-turn: .. autoproperty:: xtrack.line.Line.reset_s_at_end_turn .. _line-api-tracker-setup-property-skip-end-turn-actions: .. autoproperty:: xtrack.line.Line.skip_end_turn_actions .. _line-api-tracker-setup-property-tracker: .. autoproperty:: xtrack.line.Line.tracker .. _line-api-constructors-and-serialization: Constructors and Serialization ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-constructors-and-serialization-methods: .. _line-api-constructors-and-serialization-method-from-dict: .. automethod:: xtrack.line.Line.from_dict .. _line-api-constructors-and-serialization-method-from-json: .. automethod:: xtrack.line.Line.from_json .. _line-api-constructors-and-serialization-method-from-madx-sequence: .. automethod:: xtrack.line.Line.from_madx_sequence .. _line-api-constructors-and-serialization-method-from-sequence: .. automethod:: xtrack.line.Line.from_sequence .. _line-api-constructors-and-serialization-method-to-dict: .. automethod:: xtrack.line.Line.to_dict .. _line-api-constructors-and-serialization-method-to-json: .. automethod:: xtrack.line.Line.to_json .. _line-api-constructors-and-serialization-method-to-madng: .. automethod:: xtrack.line.Line.to_madng .. _line-api-constructors-and-serialization-method-to-madx-sequence: .. automethod:: xtrack.line.Line.to_madx_sequence .. _line-api-element-internal-logging: Element Internal Logging ~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-element-internal-logging-methods: .. _line-api-element-internal-logging-method-start-internal-logging-for-elements-of-type: .. automethod:: xtrack.line.Line.start_internal_logging_for_elements_of_type .. _line-api-element-internal-logging-method-stop-internal-logging-for-all-elements: .. automethod:: xtrack.line.Line.stop_internal_logging_for_all_elements .. _line-api-element-internal-logging-method-stop-internal-logging-for-elements-of-type: .. automethod:: xtrack.line.Line.stop_internal_logging_for_elements_of_type .. _line-api-cleanup-and-simplification: Cleanup and Simplification ~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-cleanup-and-simplification-methods: .. _line-api-cleanup-and-simplification-method-merge-consecutive-drifts: .. automethod:: xtrack.line.Line.merge_consecutive_drifts .. _line-api-cleanup-and-simplification-method-merge-consecutive-multipoles: .. automethod:: xtrack.line.Line.merge_consecutive_multipoles .. _line-api-cleanup-and-simplification-method-optimize-for-tracking: .. automethod:: xtrack.line.Line.optimize_for_tracking .. _line-api-cleanup-and-simplification-method-remove-inactive-multipoles: .. automethod:: xtrack.line.Line.remove_inactive_multipoles .. _line-api-cleanup-and-simplification-method-remove-markers: .. automethod:: xtrack.line.Line.remove_markers .. _line-api-cleanup-and-simplification-method-remove-redundant-apertures: .. automethod:: xtrack.line.Line.remove_redundant_apertures .. _line-api-cleanup-and-simplification-method-remove-zero-length-drifts: .. automethod:: xtrack.line.Line.remove_zero_length_drifts .. _line-api-cleanup-and-simplification-method-use-simple-bends: .. automethod:: xtrack.line.Line.use_simple_bends .. _line-api-cleanup-and-simplification-method-use-simple-quadrupoles: .. automethod:: xtrack.line.Line.use_simple_quadrupoles .. _line-api-mad-ng-integration: MAD-NG Integration ~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-mad-ng-integration-methods: .. _line-api-mad-ng-integration-method-build-madng-model: .. automethod:: xtrack.line.Line.build_madng_model .. _line-api-mad-ng-integration-method-discard-madng-model: .. automethod:: xtrack.line.Line.discard_madng_model .. _line-api-mad-ng-integration-method-madng-survey: .. automethod:: xtrack.line.Line.madng_survey .. _line-api-mad-ng-integration-method-madng-twiss: .. automethod:: xtrack.line.Line.madng_twiss .. _line-api-mad-ng-integration-method-regen-madng-model: .. automethod:: xtrack.line.Line.regen_madng_model .. _line-api-deprecated: Deprecated ~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-deprecated-methods: .. _line-api-deprecated-method-append-element: .. automethod:: xtrack.line.Line.append_element .. _line-api-deprecated-method-compute-r-matrix: .. automethod:: xtrack.line.Line.compute_R_matrix .. _line-api-deprecated-method-compute-t-matrix: .. automethod:: xtrack.line.Line.compute_T_matrix .. _line-api-deprecated-method-compute-one-turn-matrix-finite-differences: .. automethod:: xtrack.line.Line.compute_one_turn_matrix_finite_differences .. _line-api-deprecated-method-from-sixinput: .. automethod:: xtrack.line.Line.from_sixinput .. _line-api-deprecated-method-get-elements-of-type: .. automethod:: xtrack.line.Line.get_elements_of_type .. _line-api-deprecated-method-get-s-elements: .. automethod:: xtrack.line.Line.get_s_elements .. _line-api-deprecated-method-get-s-position: .. automethod:: xtrack.line.Line.get_s_position .. _line-api-deprecated-method-insert-element: .. automethod:: xtrack.line.Line.insert_element .. _line-api-deprecated-method-to-pandas: .. automethod:: xtrack.line.Line.to_pandas .. _line-api-deprecated-method-unfreeze: .. automethod:: xtrack.line.Line.unfreeze .. _line-api-deprecated-properties: .. _line-api-deprecated-property-builder: .. autoproperty:: xtrack.line.Line.builder .. _line-api-deprecated-property-varval: .. autoproperty:: xtrack.line.Line.varval .. _line-api-deprecated-property-vv: .. autoproperty:: xtrack.line.Line.vv .. _line-api-upcoming-deprecations: Upcoming Deprecations ~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-upcoming-deprecations-methods: .. _line-api-upcoming-deprecations-method-check-aperture: .. automethod:: xtrack.line.Line.check_aperture .. _line-api-upcoming-deprecations-method-extend: .. automethod:: xtrack.line.Line.extend .. _line-api-upcoming-deprecations-method-filter-elements: .. automethod:: xtrack.line.Line.filter_elements .. _line-api-upcoming-deprecations-method-freeze-vars: .. automethod:: xtrack.line.Line.freeze_vars .. _line-api-upcoming-deprecations-method-get-aperture-table: .. automethod:: xtrack.line.Line.get_aperture_table .. _line-api-upcoming-deprecations-method-unfreeze-vars: .. automethod:: xtrack.line.Line.unfreeze_vars .. _line-api-upcoming-deprecations-properties: .. _line-api-upcoming-deprecations-property-collimators: .. autoproperty:: xtrack.line.Line.collimators .. _line-api-upcoming-deprecations-property-scattering: .. autoproperty:: xtrack.line.Line.scattering