From 02cb3230bdfe781064d62048f66fa508eb8f53f1 Mon Sep 17 00:00:00 2001 From: Chad Mitchell Date: Mon, 18 Nov 2024 17:35:55 -0800 Subject: [PATCH] Update documentation. --- docs/source/usage/parameters.rst | 1 + docs/source/usage/python.rst | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/docs/source/usage/parameters.rst b/docs/source/usage/parameters.rst index 7a654075d..3d391093c 100644 --- a/docs/source/usage/parameters.rst +++ b/docs/source/usage/parameters.rst @@ -411,6 +411,7 @@ Lattice Elements * ``.repeat_x`` (``float``, in meters) horizontal period for repeated aperture masking (inactive by default) * ``.repeat_y`` (``float``, in meters) vertical period for repeated aperture masking (inactive by default) * ``.shape`` (``string``) shape of the aperture boundary: ``rectangular`` (default) or ``elliptical`` + * ``.action`` (``string``) action of the aperture domain: ``transmit`` (default) or ``absorb`` * ``.dx`` (``float``, in meters) horizontal translation error * ``.dy`` (``float``, in meters) vertical translation error * ``.rotation`` (``float``, in degrees) rotation error in the transverse plane diff --git a/docs/source/usage/python.rst b/docs/source/usage/python.rst index 2e24c86fb..ddda0a0d0 100644 --- a/docs/source/usage/python.rst +++ b/docs/source/usage/python.rst @@ -953,6 +953,7 @@ This module provides elements for the accelerator lattice. :param repeat_x: horizontal period for repeated aperture masking (inactive by default) (meter) :param repeat_y: vertical period for repeated aperture masking (inactive by default) (meter) :param shape: aperture boundary shape: ``"rectangular"`` (default) or ``"elliptical"`` + :param action: aperture domain action: ``"transmit"`` (default) or ``"absorb"`` :param dx: horizontal translation error in m :param dy: vertical translation error in m :param rotation: rotation error in the transverse plane [degrees] @@ -962,6 +963,10 @@ This module provides elements for the accelerator lattice. aperture type (rectangular, elliptical) + .. py:property:: action + + aperture type (transmit, absorb) + .. py:property:: xmax maximum horizontal coordinate