ChessAnalysisPipeline 0.0.11__py3-none-any.whl → 0.0.13__py3-none-any.whl

CHAP/tomo/models.py

@@ -14,12 +14,11 @@ from pydantic import (
     constr,
 )
 
-# Local modules
-from CHAP.common.models.map import SpecScans
-
 class Detector(BaseModel):
     """
     Detector class to represent the detector used in the experiment.
+    The image origin is assumed to be in the top-left corner, with
+    rows down (-z in lab frame) and columns sideways (+x in lab frame).
 
     :ivar prefix: Prefix of the detector in the SPEC file.
     :type prefix: str
@@ -47,7 +46,8 @@ class TomoReduceConfig(BaseModel):
     Class representing the configuration for the tomography image
     reduction processor.
 
-    :ivar img_row_bounds: Detector image bounds in the row-direction.
+    :ivar img_row_bounds: Detector image bounds in the row-direction
+        (ignored for id1a3 and id3a).
     :type img_row_bounds: list[int], optional
     :ivar delta_theta: Rotation angle increment in image reduction
         in degrees.
@@ -66,14 +66,17 @@ class TomoFindCenterConfig(BaseModel):
     :ivar center_stack_index: Stack index of the tomography set to find
         the center axis.
     :type center_stack_index: int, optional
-    :ivar lower_row: Lower row index for the center finding processor.
-    :type lower_row: int, optional
-    :ivar lower_center_offset: Center at the lower row index.
-    :type lower_center_offset: float, optional
-    :ivar upper_row: Upper row index for the center finding processor.
-    :type upper_row: int, optional
-    :ivar upper_center_offset: Center at the upper row index.
-    :type upper_center_offset: float, optional
+    :ivar center_rows: Row indices for the center finding processor.
+    :type center_rows: list[int, int], optional
+    :ivar center_offsets: Centers at the center finding row indices in
+        pixels.
+    :type center_offsets: list[float, float], optional
+    :ivar center_offset_min: Minimum value of center_offset in center
+        axis finding search in pixels.
+    :type center_offset_min: float, optional
+    :ivar center_offset_max: Maximum value of center_offset in center
+        axis finding search in pixels.
+    :type center_offset_max: float, optional
     :ivar gaussian_sigma: Standard deviation for the Gaussian filter
         applied to image reconstruction visualizations, defaults to no
         filtering performed.
@@ -83,12 +86,13 @@ class TomoFindCenterConfig(BaseModel):
     :type ring_width: float, optional
     """
     center_stack_index: Optional[conint(ge=0)]
-    lower_row: Optional[conint(ge=-1)]
-    lower_center_offset: Optional[confloat(allow_inf_nan=False)]
-    upper_row: Optional[conint(ge=-1)]
-    upper_center_offset: Optional[confloat(allow_inf_nan=False)]
-    search_range: Optional[confloat(ge=0, allow_inf_nan=False)]
-    search_step: Optional[confloat(ge=0, allow_inf_nan=False)]
+    center_rows: Optional[conlist(
+        item_type=conint(ge=0), min_items=2, max_items=2)]
+    center_offsets: Optional[conlist(
+        item_type=confloat(allow_inf_nan=False),
+        min_items=2, max_items=2)]
+    center_offset_min: Optional[confloat(allow_inf_nan=False)]
+    center_offset_max: Optional[confloat(allow_inf_nan=False)]
     gaussian_sigma: Optional[confloat(ge=0, allow_inf_nan=False)]
     ring_width: Optional[confloat(ge=0, allow_inf_nan=False)]