diff --git a/docs/source/techniques/ISISPowder-Polaris-v1.rst b/docs/source/techniques/ISISPowder-Polaris-v1.rst index dddadd0b5756a0cbba0d27248623f2210107cd44..7aa90850adbaf06e9eb6c83ac66b399a5fed4086 100644 --- a/docs/source/techniques/ISISPowder-Polaris-v1.rst +++ b/docs/source/techniques/ISISPowder-Polaris-v1.rst @@ -117,12 +117,7 @@ above: The following parameters may also be optionally set: - :ref:`file_ext_polaris_isis-powder-diffraction-ref` -- :ref:`sample_empty_polaris_isis_powder-diffraction-ref` -If :ref:`sample_empty_polaris_isis_powder-diffraction-ref` is -set then the following parameter is also required: - -- :ref:`sample_empty_scale_polaris_isis-powder-diffraction-ref` Example ======= @@ -509,7 +504,7 @@ Please visit the above page for more details. *Note: If this parameter is set to* **True** :ref:`sample_empty_scale_polaris_isis-powder-diffraction-ref` -*must also be set.* +*must also be set.* This is set to 1.0 by default. Example Input: @@ -520,26 +515,6 @@ Example Input: # Or a range of numbers polaris_example.focus(sample_empty="100-110", ...) - -.. _sample_empty_scale_polaris_isis-powder-diffraction-ref: - -sample_empty_scale -^^^^^^^^^^^^^^^^^^ -Required if :ref:`sample_empty_polaris_isis_powder-diffraction-ref` -is set to **True** - -Sets a factor to scale the sample empty run(s) to before -subtracting. This value is multiplied after summing the -sample empty runs and before subtracting the empty from -the data set. For more details see: :ref:`Scale <algm-Scale-v1>`. - -Example Input: - -.. code-block:: python - - # Scale sample empty to 90% of original - polaris_example.focus(sample_empty_scale=0.9, ...) - .. _user_name_polaris_isis-powder-diffraction-ref: user_name @@ -627,6 +602,25 @@ On POLARIS this is set to the following: vanadium_peaks_masking_file: "VanaPeaks.dat" +.. _sample_empty_scale_polaris_isis-powder-diffraction-ref: + +sample_empty_scale +^^^^^^^^^^^^^^^^^^ +Required if :ref:`sample_empty_polaris_isis_powder-diffraction-ref` +is set to **True** + +Sets a factor to scale the sample empty run(s) to before +subtracting. This value is multiplied after summing the +sample empty runs and before subtracting the empty from +the data set. For more details see: :ref:`Scale <algm-Scale-v1>`. + +Example Input: + +.. code-block:: python + + # Scale sample empty to 90% of original + polaris_example.focus(sample_empty_scale=0.9, ...) + .. _raw_data_cropping_values_polaris_isis-powder-diffraction-ref: raw_data_cropping_values diff --git a/scripts/Diffraction/isis_powder/polaris_routines/polaris_advanced_config.py b/scripts/Diffraction/isis_powder/polaris_routines/polaris_advanced_config.py index 8d6122f390e6513d8e0e17b7a9bf96235fcaddfb..e81ef098a24ebedbd497dd218fc38a996909b37c 100644 --- a/scripts/Diffraction/isis_powder/polaris_routines/polaris_advanced_config.py +++ b/scripts/Diffraction/isis_powder/polaris_routines/polaris_advanced_config.py @@ -48,6 +48,8 @@ vanadium_cropping_values = [ (800, 19995), # Bank 5 ] +sample_empty_scale = 1.0 + variable_help = { "file_names": { "vanadium_peaks_masking_file": "Specifies the name of the of the file containing the positions of the vanadium " @@ -79,4 +81,5 @@ variables = { "focused_cropping_values": focused_cropping_values, "vanadium_cropping_values": vanadium_cropping_values, "focused_bin_widths": focused_bin_widths, + "sample_empty_scale": sample_empty_scale }