Merge pull request #326 from European-XFEL/motors-docs

MotorTracker reference
European-XFEL · Jan 27, 2025 · 9967ce6 · 9967ce6
2 parents fa8b303 + e1144aa
commit 9967ce6
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/docs/geometry.rst b/docs/geometry.rst
@@ -417,3 +417,27 @@ Generic detector may represent an unconstrained detector of your choice.
    .. automethod:: inspect
 
    .. automethod:: compare
+
+
+Motor-based geometry
+--------------------
+
+The geometry of some motorized multimodule detectors may be updated according to motor positions by corresponding `MotorTracker`.
+
+.. autoclass:: extra_geom.motors::AGIPD_1MMotors
+   :class-doc-from: init
+
+   .. automethod:: with_motor_axes
+
+   .. automethod:: geom_at
+
+   .. automethod:: move_geom_by
+
+.. autoclass:: extra_geom.motors::JF4MMotors
+   :class-doc-from: init
+
+   .. automethod:: with_motor_axes
+
+   .. automethod:: geom_at
+
+   .. automethod:: move_geom_by
diff --git a/extra_geom/motors.py b/extra_geom/motors.py
@@ -92,6 +92,7 @@ def with_motor_axes(self, new_motor_axes):
         of motor positions in the positions of detector panels.
 
         ::
+
             (h, v) - local motor coordinates
             (x, y) - laboratory cooridnates (looking downstream)
             (hx, hy) - the axis of horizontal motor in laboratory coordinates
@@ -212,9 +213,6 @@ class AGIPD_1MMotors(BaseMotorTracker):
 
 
 class JF4MMotors(BaseMotorTracker):
-    # Caution! The assignment of modules to motors and
-    # motors' axes sign are not verified yet.
-
     # groups of modules driven by motors together
     # H1, H2
     groups = [