Add sample to source distance to Beam (cctbx#622)

* Add sample_to_source_distance to Beam --------- Co-authored-by: DiamondLightSource-build-server <[email protected]> Co-authored-by: Nicholas Devenish <[email protected]>
toastisme · Jul 11, 2024 · 5319c5a · 5319c5a
1 parent 94a8e3b
commit 5319c5a
Show file tree

Hide file tree

Showing 6 changed files with 326 additions and 17 deletions.
diff --git a/newsfragments/622.misc b/newsfragments/622.misc
@@ -0,0 +1 @@
+Add sample_to_source_distance to Beam
diff --git a/src/dxtbx/dxtbx_model_ext.pyi b/src/dxtbx/dxtbx_model_ext.pyi
@@ -57,6 +57,10 @@ class BeamBase:
         self, points: Union[Tuple[Vec3Float], List[Vec3Float]]
     ) -> None: ...
     def get_sample_to_source_direction(self) -> Vec3Float: ...
+    def get_sample_to_source_distance(self) -> float: ...
+    def set_sample_to_source_distance(
+        self, sample_to_source_distance: float
+    ) -> None: ...
     def get_sigma_divergence(self) -> float: ...
     def set_sigma_divergence(self, sigma_divergence: float) -> None: ...
     def get_transmission(self) -> float: ...
@@ -110,6 +114,22 @@ class Beam(BeamBase):
         polarization_fraction: float,
         flux: float,
         transmission: float,
+        probe: Probe = ...,
+        deg: bool = ...,
+    ) -> None: ...
+    @overload
+    def __init__(
+        self,
+        direction: Vec3Float,
+        wavelength: float,
+        divergence: float,
+        sigma_divergence: float,
+        polarization_normal: Vec3Float,
+        polarization_fraction: float,
+        flux: float,
+        transmission: float,
+        probe: Probe = ...,
+        sample_to_source_distance: float = ...,
         deg: bool = ...,
     ) -> None: ...
     @staticmethod
@@ -141,6 +161,8 @@ class PolychromaticBeam(Beam):
         polarization_fraction: float,
         flux: float,
         transmission: float,
+        probe: Probe = ...,
+        sample_to_source_distance: float = ...,
         deg: bool = ...,
     ) -> None: ...
     @staticmethod