.. This file content is autogenerated from ``xtrack.aperture.aperture.Aperture.__doc_groups__``.

Members - short description
--------------------------

.. raw:: html

   <style>
   table.line-api-summary-table { width: 100%; table-layout: fixed; }
   table.line-api-summary-table th,
   table.line-api-summary-table td {
     white-space: normal !important;
     overflow-wrap: anywhere;
     word-break: break-word;
   }
   table.line-api-summary-table caption {
     font-size: 1.10em !important;
     font-weight: 600 !important;
   }
   table.line-api-summary-table caption .caption-text,
   table.line-api-summary-table caption .caption-text a {
     font-size: 1.10em !important;
     font-weight: 600 !important;
     font-style: normal !important;
     line-height: 1.2 !important;
   }
   </style>

.. _line-api-loading-and-serialization-summary:

.. list-table:: :ref:`Loading and Serialization <line-api-loading-and-serialization>`
   :class: line-api-summary-table
   :header-rows: 1
   :width: 100%
   :widths: 40 60

   * - Member
     - Description
   * - :ref:`from_​json(...) <line-api-loading-and-serialization-method-from-json>`
     - Load an aperture from JSON and bind it to ``line``.
   * - :ref:`from_​line_​with_​associated_​apertures(...) <line-api-loading-and-serialization-method-from-line-with-associated-apertures>`
     - Build an aperture from Xsuite elements that reference associated apertures.
   * - :ref:`from_​line_​with_​limits(...) <line-api-loading-and-serialization-method-from-line-with-limits>`
     - Build an aperture from limit elements installed in the line.
   * - :ref:`from_​line_​with_​madx_​metadata(...) <line-api-loading-and-serialization-method-from-line-with-madx-metadata>`
     - Build an aperture from MAD-X layout metadata attached to a line.
   * - :ref:`to_​json(...) <line-api-loading-and-serialization-method-to-json>`
     - Serialize the aperture model and halo parameters to JSON.

.. _line-api-aperture-computations-summary:

.. list-table:: :ref:`Aperture Computations <line-api-aperture-computations>`
   :class: line-api-summary-table
   :header-rows: 1
   :width: 100%
   :widths: 40 60

   * - Member
     - Description
   * - :ref:`cross_​sections_​at_​element(...) <line-api-aperture-computations-method-cross-sections-at-element>`
     - Return aperture cross-sections sampled across an element.
   * - :ref:`cross_​sections_​at_​s(...) <line-api-aperture-computations-method-cross-sections-at-s>`
     - Return aperture cross-sections at the requested `s` positions.
   * - :ref:`get_​aperture_​sigmas_​at_​element(...) <line-api-aperture-computations-method-get-aperture-sigmas-at-element>`
     - Compute the maximum number of sigmas at which the beam fits in the aperture at element ``element_​name``.
   * - :ref:`get_​aperture_​sigmas_​at_​s(...) <line-api-aperture-computations-method-get-aperture-sigmas-at-s>`
     - Compute the maximum number of sigmas at which the beam fits in the aperture at the given ``s_​positions``.
   * - :ref:`get_​aperture_​sigmas_​for_​twiss(...) <line-api-aperture-computations-method-get-aperture-sigmas-for-twiss>`
     - Compute the maximum aperture sigmas from an already sampled Twiss table.
   * - :ref:`get_​envelope_​at_​element(...) <line-api-aperture-computations-method-get-envelope-at-element>`
     - Compute beam-envelope polygons at the cuts of ``element_​name`` for a fixed sigma value.
   * - :ref:`get_​envelope_​at_​s(...) <line-api-aperture-computations-method-get-envelope-at-s>`
     - Compute beam-envelope polygons at the requested ``s_​positions`` for a fixed sigma value.
   * - :ref:`get_​envelope_​for_​twiss(...) <line-api-aperture-computations-method-get-envelope-for-twiss>`
     - Compute beam envelopes from an already sampled Twiss table.
   * - :ref:`get_​hvd_​aperture_​sigmas_​at_​element(...) <line-api-aperture-computations-method-get-hvd-aperture-sigmas-at-element>`
     - Compute horizontal, vertical and diagonal (45°) max aperture sigmas at element ``element_​name``.
   * - :ref:`get_​hvd_​aperture_​sigmas_​at_​s(...) <line-api-aperture-computations-method-get-hvd-aperture-sigmas-at-s>`
     - Compute horizontal, vertical and diagonal (45°) max aperture sigmas at the given ``s_​positions``.
   * - :ref:`get_​limit_​elements(...) <line-api-aperture-computations-method-get-limit-elements>`
     - Obtain interpolated cross-sections as limit beam elements.
   * - :ref:`poses_​at_​s(...) <line-api-aperture-computations-method-poses-at-s>`
     - Return a local coordinate system (each represented by a homogeneous matrix) at all ``s_​positions``.

.. _line-api-introspection-summary:

.. list-table:: :ref:`Introspection <line-api-introspection>`
   :class: line-api-summary-table
   :header-rows: 1
   :width: 100%
   :widths: 40 60

   * - Member
     - Description
   * - :ref:`get_​bounds_​table(...) <line-api-introspection-method-get-bounds-table>`
     - Return per-profile aperture-bound information as a table.
   * - :ref:`get_​pipe_​table(...) <line-api-introspection-method-get-pipe-table>`
     - Return installed-pipe interval information as a table.
   * - :ref:`s_​around_​transitions(...) <line-api-introspection-method-s-around-transitions>`
     - Return sampling positions around aperture-profile transitions.
   * - :ref:`halo_​params <line-api-introspection-property-halo-params>`
     - Dictionary of halo parameters controlling beam-envelope and aperture-sigma computations.
   * - :ref:`pipe_​positions <line-api-introspection-property-pipe-positions>`
     - Return the pipe-position collection view.
   * - :ref:`pipes <line-api-introspection-property-pipes>`
     - Return the pipe collection view.
   * - :ref:`profiles <line-api-introspection-property-profiles>`
     - Return the profile collection view.

.. _line-api-visualization-summary:

.. list-table:: :ref:`Visualization <line-api-visualization>`
   :class: line-api-summary-table
   :header-rows: 1
   :width: 100%
   :widths: 40 60

   * - Member
     - Description
   * - :ref:`plot_​extents(...) <line-api-visualization-method-plot-extents>`
     - Plot beam-envelope and aperture extents along the beam line.
   * - :ref:`plot_​floor_​projection(...) <line-api-visualization-method-plot-floor-projection>`
     - Plot installed pipe segments projected onto the floor plane.
   * - :ref:`plot_​transverse(...) <line-api-visualization-method-plot-transverse>`
     - Display transverse aperture cross-sections and beam envelopes.


Members - full description
--------------------------

.. _line-api-loading-and-serialization:

Loading and Serialization
~~~~~~~~~~~~~~~~~~~~~~~~~

Go to :ref:`Summary table <line-api-loading-and-serialization-summary>`

.. _line-api-loading-and-serialization-methods:

.. _line-api-loading-and-serialization-method-from-json:

.. automethod:: xtrack.aperture.aperture.Aperture.from_json

.. _line-api-loading-and-serialization-method-from-line-with-associated-apertures:

.. automethod:: xtrack.aperture.aperture.Aperture.from_line_with_associated_apertures

.. _line-api-loading-and-serialization-method-from-line-with-limits:

.. automethod:: xtrack.aperture.aperture.Aperture.from_line_with_limits

.. _line-api-loading-and-serialization-method-from-line-with-madx-metadata:

.. automethod:: xtrack.aperture.aperture.Aperture.from_line_with_madx_metadata

.. _line-api-loading-and-serialization-method-to-json:

.. automethod:: xtrack.aperture.aperture.Aperture.to_json

.. _line-api-aperture-computations:

Aperture Computations
~~~~~~~~~~~~~~~~~~~~~

Go to :ref:`Summary table <line-api-aperture-computations-summary>`

.. _line-api-aperture-computations-methods:

.. _line-api-aperture-computations-method-cross-sections-at-element:

.. automethod:: xtrack.aperture.aperture.Aperture.cross_sections_at_element

.. _line-api-aperture-computations-method-cross-sections-at-s:

.. automethod:: xtrack.aperture.aperture.Aperture.cross_sections_at_s

.. _line-api-aperture-computations-method-get-aperture-sigmas-at-element:

.. automethod:: xtrack.aperture.aperture.Aperture.get_aperture_sigmas_at_element

.. _line-api-aperture-computations-method-get-aperture-sigmas-at-s:

.. automethod:: xtrack.aperture.aperture.Aperture.get_aperture_sigmas_at_s

.. _line-api-aperture-computations-method-get-aperture-sigmas-for-twiss:

.. automethod:: xtrack.aperture.aperture.Aperture.get_aperture_sigmas_for_twiss

.. _line-api-aperture-computations-method-get-envelope-at-element:

.. automethod:: xtrack.aperture.aperture.Aperture.get_envelope_at_element

.. _line-api-aperture-computations-method-get-envelope-at-s:

.. automethod:: xtrack.aperture.aperture.Aperture.get_envelope_at_s

.. _line-api-aperture-computations-method-get-envelope-for-twiss:

.. automethod:: xtrack.aperture.aperture.Aperture.get_envelope_for_twiss

.. _line-api-aperture-computations-method-get-hvd-aperture-sigmas-at-element:

.. automethod:: xtrack.aperture.aperture.Aperture.get_hvd_aperture_sigmas_at_element

.. _line-api-aperture-computations-method-get-hvd-aperture-sigmas-at-s:

.. automethod:: xtrack.aperture.aperture.Aperture.get_hvd_aperture_sigmas_at_s

.. _line-api-aperture-computations-method-get-limit-elements:

.. automethod:: xtrack.aperture.aperture.Aperture.get_limit_elements

.. _line-api-aperture-computations-method-poses-at-s:

.. automethod:: xtrack.aperture.aperture.Aperture.poses_at_s

.. _line-api-introspection:

Introspection
~~~~~~~~~~~~~

Go to :ref:`Summary table <line-api-introspection-summary>`

.. _line-api-introspection-methods:

.. _line-api-introspection-method-get-bounds-table:

.. automethod:: xtrack.aperture.aperture.Aperture.get_bounds_table

.. _line-api-introspection-method-get-pipe-table:

.. automethod:: xtrack.aperture.aperture.Aperture.get_pipe_table

.. _line-api-introspection-method-s-around-transitions:

.. automethod:: xtrack.aperture.aperture.Aperture.s_around_transitions

.. _line-api-introspection-properties:

.. _line-api-introspection-property-halo-params:

.. autoproperty:: xtrack.aperture.aperture.Aperture.halo_params

.. _line-api-introspection-property-pipe-positions:

.. autoproperty:: xtrack.aperture.aperture.Aperture.pipe_positions

.. _line-api-introspection-property-pipes:

.. autoproperty:: xtrack.aperture.aperture.Aperture.pipes

.. _line-api-introspection-property-profiles:

.. autoproperty:: xtrack.aperture.aperture.Aperture.profiles

.. _line-api-visualization:

Visualization
~~~~~~~~~~~~~

Go to :ref:`Summary table <line-api-visualization-summary>`

.. _line-api-visualization-methods:

.. _line-api-visualization-method-plot-extents:

.. automethod:: xtrack.aperture.aperture.Aperture.plot_extents

.. _line-api-visualization-method-plot-floor-projection:

.. automethod:: xtrack.aperture.aperture.Aperture.plot_floor_projection

.. _line-api-visualization-method-plot-transverse:

.. automethod:: xtrack.aperture.aperture.Aperture.plot_transverse