Skip to content
Snippets Groups Projects
Commit 3cc931ba authored by David Fairbrother's avatar David Fairbrother
Browse files

Re #19575 Added reference for POLARIS

parent 7eb549d7
No related branches found
No related tags found
No related merge requests found
.. _isis-powder-diffraction-gem-ref: .. _isis-powder-diffraction-gem-ref:
======================================= ================================================
ISIS Powder Diffraction Scripts - GEM ISIS Powder Diffraction Scripts - GEM Reference
======================================= ================================================
.. contents:: Table of Contents .. contents:: Table of Contents
:local: :local:
...@@ -144,7 +144,7 @@ set_sample ...@@ -144,7 +144,7 @@ set_sample
The *set_sample* method allows a user to specify a SampleDetails The *set_sample* method allows a user to specify a SampleDetails
object which contains the sample properties used when object which contains the sample properties used when
:ref:`do_absorb_corrections_gem_isis-powder-diffraction-ref` is **True** :ref:`do_absorb_corrections_gem_isis-powder-diffraction-ref` is **True**
whilst focussing. whilst focusing.
For more details on the SampleDetails object and how to set For more details on the SampleDetails object and how to set
it see: TODO it see: TODO
...@@ -152,7 +152,7 @@ it see: TODO ...@@ -152,7 +152,7 @@ it see: TODO
The following parameter is required when calling *set_sample* The following parameter is required when calling *set_sample*
- *sample* - This must be a SampleDetails object with the - *sample* - This must be a SampleDetails object with the
material set already. material set already.
Example Example
======= =======
...@@ -192,7 +192,7 @@ substituting the below values for appropriate values: ...@@ -192,7 +192,7 @@ substituting the below values for appropriate values:
empty_run_numbers: "40" empty_run_numbers: "40"
Lines 5 and 6 in this example set the vanadium and empty run numbers for Lines 5 and 6 in this example set the vanadium and empty run numbers for
PDF mode respectively. Lines 8 and 9 set the vanadium and empty for PDF mode. Lines 8 and 9 set the vanadium and empty for
Rietveld mode. Rietveld mode.
Example Example
...@@ -229,9 +229,9 @@ when using the ISIS Powder scripts. ...@@ -229,9 +229,9 @@ when using the ISIS Powder scripts.
calibration_directory calibration_directory
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
This parameter should be the full path to the calibration folder. This parameter should be the full path to the calibration folder.
Within the folder the following should be present Within the folder the following should be present:
- Grouping .cal file - Grouping .cal file (see: :ref:`grouping_file_name_gem_isis-powder-diffraction-ref`)
- Folder(s) with the label name specified in mapping file (e.g. "1_1") - Folder(s) with the label name specified in mapping file (e.g. "1_1")
- Inside each folder should be the offset file with name specified in mapping file - Inside each folder should be the offset file with name specified in mapping file
...@@ -441,6 +441,9 @@ of values with the following syntax: ...@@ -441,6 +441,9 @@ of values with the following syntax:
These can be combined like so: These can be combined like so:
*1-3, 5, 8-10* would process run numbers 1, 2, 3, 5, 8, 9, 10. *1-3, 5, 8-10* would process run numbers 1, 2, 3, 5, 8, 9, 10.
In addition the :ref:`input_mode_gem_isis-powder-diffraction-ref`
parameter determines what effect a range of inputs has
on the data to be processed
Example Input: Example Input:
...@@ -611,7 +614,7 @@ On GEM this is set to the following: ...@@ -611,7 +614,7 @@ On GEM this is set to the following:
.. code-block:: Python .. code-block:: Python
"grouping_file_name": "GEM_Instrument_grouping.cal", grouping_file_name: "GEM_Instrument_grouping.cal"
.. _raw_tof_cropping_values_gem_isis-powder-diffraction-ref: .. _raw_tof_cropping_values_gem_isis-powder-diffraction-ref:
...@@ -629,7 +632,7 @@ On GEM this is set to the following: ...@@ -629,7 +632,7 @@ On GEM this is set to the following:
.. code-block:: Python .. code-block:: Python
"raw_tof_cropping_values": (500, 20000) raw_tof_cropping_values: (500, 20000)
.. _spline_coefficient_gem_isis-powder-diffraction-ref: .. _spline_coefficient_gem_isis-powder-diffraction-ref:
...@@ -646,7 +649,7 @@ On GEM this is set to the following: ...@@ -646,7 +649,7 @@ On GEM this is set to the following:
.. code-block:: Python .. code-block:: Python
"spline_coefficient": 30 spline_coefficient: 30
.. _vanadium_cropping_values_gem_isis-powder-diffraction-ref: .. _vanadium_cropping_values_gem_isis-powder-diffraction-ref:
......
This diff is collapsed.
...@@ -327,6 +327,7 @@ def subtract_summed_runs(ws_to_correct, empty_sample_ws_string, instrument, scal ...@@ -327,6 +327,7 @@ def subtract_summed_runs(ws_to_correct, empty_sample_ws_string, instrument, scal
:param ws_to_correct: The workspace to subtract the empty instrument runs from :param ws_to_correct: The workspace to subtract the empty instrument runs from
:param empty_sample_ws_string: The empty run numbers to subtract from the workspace :param empty_sample_ws_string: The empty run numbers to subtract from the workspace
:param instrument: The instrument object these runs belong to :param instrument: The instrument object these runs belong to
:param scale_factor: The percentage to scale the loaded runs by
:return: The workspace with the empty runs subtracted :return: The workspace with the empty runs subtracted
""" """
# If an empty string was not specified just return to skip this step # If an empty string was not specified just return to skip this step
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment