Tristan flatfield name change (#287)

* New name for tristan flafield file * fix docs * Fix some docs errors * mode docs fixes
DiamondLightSource · Aug 27, 2024 · 79e610c · 79e610c
1 parent 610a69e
commit 79e610c
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 9 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -102,7 +102,7 @@ NXclass writers
 
 All the NXclass writers available can be found in:
 
-.. automodule:: nexgen.nxs_write.NXclassWriters
+.. automodule:: nexgen.nxs_write.nxclass_writers
     :members:
 
 
@@ -204,16 +204,21 @@ data type using the information stored in the `meta` file.
 Reader for Singla detector master file
 --------------------------------------
 
-.. autoclass:: nexgen.tools.ED_tools.SinglaMaster
+.. autoclass:: nexgen.tools.ed_tools.SinglaMaster
     :members:
 
-.. autofunction:: nexgen.tools.ED_tools.extract_from_SINGLA_master
+.. autofunction:: nexgen.tools.ed_tools.extract_exposure_time_from_master
+
+.. autofunction:: nexgen.tools.ed_tools.extract_start_time_from_master
+
+.. autofunction:: nexgen.tools.ed_tools.extract_detector_info_from_master
+
 
 Tools to calculate the beam center of an Electron Diffraction experiment:
 
-.. autofunction:: nexgen.tools.ED_tools.centroid_max
+.. autofunction:: nexgen.tools.ed_tools.centroid_max
 
-.. autofunction:: nexgen.tools.ED_tools.find_beam_centre
+.. autofunction:: nexgen.tools.ed_tools.find_beam_centre
 
 
 Logging configuration

diff --git a/docs/api_beamlines.rst b/docs/api_beamlines.rst
@@ -23,6 +23,7 @@ I19-2
 
 The function
 
+
 .. autofunction:: nexgen.beamlines.I19_2_nxs.nexus_writer
 
 
@@ -31,11 +32,13 @@ can be called from python and depending on the specified detector type will run:
 
 .. autofunction:: nexgen.beamlines.I19_2_nxs.tristan_writer
 
+
 .. autofunction:: nexgen.beamlines.I19_2_nxs.eiger_writer
 
 
 Some useful type definitions to use with these methods:
 
+
 .. autoclass:: nexgen.beamlines.I19_2_nxs.axes
     :members:
 
@@ -46,35 +49,42 @@ Some useful type definitions to use with these methods:
 
 Collection parameters schema for I19-2
 
+
 .. autopydantic_model:: nexgen.beamlines.I19_2_nxs.CollectionParams
     :model-show-config-summary: False
 
 
 
 2. Interface with GDA ...
 
+
 .. autoclass:: nexgen.beamlines.I19_2_gda_nxs.tr_collect
     :members:
 
+
 .. autofunction:: nexgen.beamlines.I19_2_gda_nxs.tristan_writer
 
+
 .. autofunction:: nexgen.beamlines.I19_2_gda_nxs.eiger_writer
 
 
 Collection parameters schema for I19-2 from GDA
 
+
 .. autopydantic_model:: nexgen.beamlines.I19_2_gda_nxs.GDACollectionParams
     :model-show-config-summary: False
 
 
 Serial crystallography: Eiger writers
 -------------------------------------
 
+
 .. autofunction:: nexgen.beamlines.SSX_Eiger_nxs.ssx_eiger_writer
 
 
 Collection parameters schema for SSX
 
+
 .. autopydantic_model:: nexgen.beamlines.SSX_Eiger_nxs.SerialParams
     :model-show-config-summary: False
 
@@ -83,11 +93,13 @@ Collection parameters schema for SSX
 Serial crystallography: Tristan writers
 ---------------------------------------
 
+
 .. autofunction:: nexgen.beamlines.SSX_Tristan_nxs.ssx_tristan_writer
 
 
 Collection parameters schema for SSX using Tristan
 
+
 .. autopydantic_model:: nexgen.beamlines.SSX_Tristan_nxs.TimeResolvedSerialParams
     :model-show-config-summary: False
 

diff --git a/docs/authors.rst b/docs/authors.rst
@@ -1 +1 @@
-.. include:: ../AUTHORS.rst
+
diff --git a/src/nexgen/beamlines/SSX_chip.py b/src/nexgen/beamlines/SSX_chip.py
@@ -173,8 +173,8 @@ def compute_goniometer(
         ax2 (str, optional): Axis name corrsponding to fast varying axis. Defaults to "sam_x".
 
     Returns:
-        Dict[Dict[str | Tuple, float | int]]: Axes start coordinates and scan direction of each block. \
-            eg. \
+        Dict[Dict[str | Tuple, float | int]]: Axes start coordinates and scan direction of each block.
+            eg.
                 {
                     '01'/(0,0): {
                         'ax1': 0.0,

diff --git a/src/nexgen/nxs_utils/detector.py b/src/nexgen/nxs_utils/detector.py
@@ -35,7 +35,7 @@ class UnknownDetectorTypeError(Exception):
 }
 
 TRISTAN_CONST = {
-    "flatfield": "Tristan10M_flat_field_coeff_with_Mo_17.479keV.h5",
+    "flatfield": "Tristan10M_flat_field_coff_gap_filled_1_with_Mo_17.479keV.h5",  # "Tristan10M_flat_field_coeff_with_Mo_17.479keV.h5",
     "flatfield_applied": False,
     "pixel_mask": "Tristan10M_mask_with_spec.h5",
     "pixel_mask_applied": False,