Skip to content
Snippets Groups Projects
Commit 9fe906bd authored by Joseph Ramsay's avatar Joseph Ramsay
Browse files

Re #20603 Made sample_empty_scale default to 1.0 in polaris

parent dc4f864a
No related branches found
No related tags found
No related merge requests found
...@@ -117,12 +117,7 @@ above: ...@@ -117,12 +117,7 @@ above:
The following parameters may also be optionally set: The following parameters may also be optionally set:
- :ref:`file_ext_polaris_isis-powder-diffraction-ref` - :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 Example
======= =======
...@@ -509,7 +504,7 @@ Please visit the above page for more details. ...@@ -509,7 +504,7 @@ Please visit the above page for more details.
*Note: If this parameter is set to* **True** *Note: If this parameter is set to* **True**
:ref:`sample_empty_scale_polaris_isis-powder-diffraction-ref` :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: Example Input:
...@@ -520,26 +515,6 @@ Example Input: ...@@ -520,26 +515,6 @@ Example Input:
# Or a range of numbers # Or a range of numbers
polaris_example.focus(sample_empty="100-110", ...) 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_polaris_isis-powder-diffraction-ref:
user_name user_name
...@@ -627,6 +602,25 @@ On POLARIS this is set to the following: ...@@ -627,6 +602,25 @@ On POLARIS this is set to the following:
vanadium_peaks_masking_file: "VanaPeaks.dat" 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_polaris_isis-powder-diffraction-ref:
raw_data_cropping_values raw_data_cropping_values
......
...@@ -48,6 +48,8 @@ vanadium_cropping_values = [ ...@@ -48,6 +48,8 @@ vanadium_cropping_values = [
(800, 19995), # Bank 5 (800, 19995), # Bank 5
] ]
sample_empty_scale = 1.0
variable_help = { variable_help = {
"file_names": { "file_names": {
"vanadium_peaks_masking_file": "Specifies the name of the of the file containing the positions of the vanadium " "vanadium_peaks_masking_file": "Specifies the name of the of the file containing the positions of the vanadium "
...@@ -79,4 +81,5 @@ variables = { ...@@ -79,4 +81,5 @@ variables = {
"focused_cropping_values": focused_cropping_values, "focused_cropping_values": focused_cropping_values,
"vanadium_cropping_values": vanadium_cropping_values, "vanadium_cropping_values": vanadium_cropping_values,
"focused_bin_widths": focused_bin_widths, "focused_bin_widths": focused_bin_widths,
"sample_empty_scale": sample_empty_scale
} }
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