Skip to content
Snippets Groups Projects
Commit e026bfe5 authored by Pete Peterson's avatar Pete Peterson Committed by GitHub
Browse files

Merge pull request #19195 from mantidproject/fix_sphinx_warnings 

Fix sphinx warnings
parents dd1d9f7f 91988e19
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/source/algorithms/SANSMove-v1.rst
+ 96
− 87
View file @ e026bfe5
...@@ -23,101 +23,110 @@ specific to each instrument and to the specific IDF. ...@@ -23,101 +23,110 @@ specific to each instrument and to the specific IDF.
Common elements of the move state object are: Common elements of the move state object are:
+---------------------------+--------+------------------------------------------+--------------|---------------+
| Entry | Type | Description | Mandatory | Default value +---------------------------+---------------------------+-------------------------------------+------------+------------------------+
+===========================+========+==========================================+==============+================================+ | Entry | Type | Description | Mandatory | Default value |
| sample_offset | Float | The offset of the sample in m | No | 0.0 | +===========================+===========================+=====================================+============+========================+
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ | sample_offset | Float | The offset of the sample in m | No | 0.0 |
| sample_offset_direction | CanonicalCoordinates enum | The direction of the sample offset | No | CanonicalCoordinates.Z| +---------------------------+---------------------------+-------------------------------------+------------+------------------------+
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ | sample_offset_direction | CanonicalCoordinates enum | The direction of the sample offset | No | CanonicalCoordinates.Z |
| detectors | Dict | Dictionary of detectors. | auto setup | auto setup| +---------------------------+---------------------------+-------------------------------------+------------+------------------------+
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ | detectors | Dict | Dictionary of detectors. | auto setup | auto setup |
+---------------------------+---------------------------+-------------------------------------+------------+------------------------+
The detectors dictionary above maps to a state object for the individual detectors:
+---------------------------+--------+------------------------------------------+--------------|---------------+ The detectors dictionary above maps to a state object for the individual detectors.
| Entry | Type | Description | Mandatory | Default value
+===========================+========+==========================================+==============+================================+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| x_translation_correction | Float | X translation for the detector in m | No | 0.0 | | Entry | Type | Description | Mandatory | Default value |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +==========================+========+========================================================================+============+===============+
| y_translation_correction | Float | Y translation for the detector in m | No | 0.0 | | x_translation_correction | Float | X translation for the detector in m | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| z_translation_correction | Float | X translation for the detector in m | No | 0.0 | | y_translation_correction | Float | Y translation for the detector in m | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| rotation_correction | Float | Rotation correction for the detector in degrees | No | 0.0 | | z_translation_correction | Float | X translation for the detector in m | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| side_correction | Float | Side correction for the detector in m | No | 0.0 | | rotation_correction | Float | Rotation correction for the detector in degrees | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| radius_correction | Float | Radius correction for the detector in m | No | 0.0 | | side_correction | Float | Side correction for the detector in m | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| x_tilt_correction | Float | X tilt for the detector in degrees | No | 0.0 | | radius_correction | Float | Radius correction for the detector in m | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| y_tilt_correction | Float | Y translation for the detector in degrees | No | 0.0 | | x_tilt_correction | Float | X tilt correction for the detector in degrees | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| z_tilt_correction | Float | X translation for the detector in degrees | No | 0.0 | | y_tilt_correction | Float | Y tilt correction for the detector in degrees | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| sample_centre_pos1 | Float | Position 1 of the beam centre in m or degree, depending on the setting| No | 0.0 | | z_tilt_correction | Float | Z tilt correction for the detector in degrees | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| sample_centre_pos2 | Float | Position 2 of the beam centre in m | No | 0.0 | | sample_centre_pos1 | Float | Position 1 of the beam centre in m or degree, depending on the setting | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| detector_name | String | Detector name | auto setup | auto setup | | sample_centre_pos2 | Float | Position 2 of the beam centre in m | No | 0.0 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| detector_name_short | String | Short detector name | No | auto setup | | detector_name | String | Detector name | auto setup | auto setup |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
| detector_name_short | String | Short detector name | No | auto setup |
+--------------------------+--------+------------------------------------------------------------------------+------------+---------------+
The individual instruments have additional settings. The individual instruments have additional settings.
For LOQ:
+---------------------------+--------+------------------------------------------+--------------|---------------+ For LOQ
| Entry | Type | Description | Mandatory | Default value
+===========================+========+==========================================+==============+================================+ +-----------------+-------+-------------------------------------------------+--------------+---------------+
| monitor_names | Dict | A dictionary with monitor index vs monitor name | auto setup | auto setup | | Entry | Type | Description | Mandatory | Default value |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +=================+=======+=================================================+==============+===============+
| center_position | Float | The centre position | No | 317.5 / 1000.| | monitor_names | Dict | A dictionary with monitor index vs monitor name | auto setup | auto setup |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +-----------------+-------+-------------------------------------------------+--------------+---------------+
| center_position | Float | The centre position | No | 317.5 / 1000. |
For SANS2D: +-----------------+-------+-------------------------------------------------+--------------+---------------+
+---------------------------+--------+------------------------------------------+--------------|---------------+
| Entry | Type | Description | Mandatory | Default value
+===========================+========+==========================================+==============+================================+ For SANS2D
| monitor_names | Dict | A dictionary with monitor index vs monitor name | auto setup | auto setup |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| hab_detector_radius | Float | Radius for the front detector in m | auto setup (through IPF) | 306.0 / 1000.| | Entry | Type | Description | Mandatory | Default value |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +===========================+=======+=================================================+============+===============+
| hab_detector_default_sd_m | Float | Default sd for front detector in m | auto setup (through IPF) | 317.5 / 1000.| | monitor_names | Dict | A dictionary with monitor index vs monitor name | auto setup | auto setup |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| hab_detector_default_x_m | Float | Default x for the front detector in m | auto setup (through IPF) | 1.1| | hab_detector_radius | Float | Radius for the front detector in m | auto setup | 306.0 / 1000. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| lab_detector_default_sd_m | Float | Default sd for the rear detector in m | auto setup | 4.| | hab_detector_default_sd_m | Float | Default sd for front detector in m | auto setup | 317.5 / 1000. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| hab_detector_x | Float | X for the front detector in m | auto setup | 0.| | hab_detector_default_x_m | Float | Default x for the front detector in m | auto setup | 1.1 |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| hab_detector_z | Float | Z for the front detector in m | auto setup | 317.5 / 1000.| | lab_detector_default_sd_m | Float | Default sd for the rear detector in m | auto setup | 4. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| hab_detector_rotation | Float | Rotation for the front detector | auto setup | 0.| | hab_detector_x | Float | X for the front detector in m | auto setup | 0. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| lab_detector_x | Float | X for the rear detector in m | auto setup | 0.| | hab_detector_z | Float | Z for the front detector in m | auto setup | 317.5 / 1000. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| lab_detector_z | Float | Z for the rear detector in m | auto setup | 0.| | hab_detector_rotation | Float | Rotation for the front detector | auto setup | 0. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| monitor_4_offset | Float | Offset for monitor 4 | No | 0.| | lab_detector_x | Float | X for the rear detector in m | auto setup | 0. |
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| lab_detector_z | Float | Z for the rear detector in m | auto setup | 0. |
+---------------------------+-------+-------------------------------------------------+------------+---------------+
For LARMOR: | monitor_4_offset | Float | Offset for monitor 4 | No | 0. |
+---------------------------+--------+------------------------------------------+--------------|---------------+ +---------------------------+-------+-------------------------------------------------+------------+---------------+
| Entry | Type | Description | Mandatory | Default value
+===========================+========+==========================================+==============+================================+
| monitor_names | Dict | A dictionary with monitor index vs monitor name | auto setup | auto setup | For LARMOR
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+
| bench_rotation | Float | The angle for the bench rotation | No | 0.| +----------------+-------+-------------------------------------------------+------------+---------------+
+---------------------------+--------+------------------------------------------+--------------|-------------------------------+ | Entry | Type | Description | Mandatory | Default value |
+================+=======+=================================================+============+===============+
| monitor_names | Dict | A dictionary with monitor index vs monitor name | auto setup | auto setup |
+----------------+-------+-------------------------------------------------+------------+---------------+
| bench_rotation | Float | The angle for the bench rotation | No | 0. |
+----------------+-------+-------------------------------------------------+------------+---------------+
Note that these settings should be only populated via the GUI or the Python Interface of ISIS SANS. Note that these settings should be only populated via the GUI or the Python Interface of ISIS SANS.
Move options: *InitialMove*, *ElementaryDisplacement*, *SetToZero* Move options: *InitialMove*, *ElementaryDisplacement*, *SetToZero*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The *InitialMove* setting is relevant when loading data before a reduction. It will apply all corrections which are specified in the state object. The *InitialMove* setting is relevant when loading data before a reduction. It will apply all corrections which are specified in the state object.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment