Skip to content

Commit b2e3a45

Browse files
committed
typo in rst file
1 parent 87a1f45 commit b2e3a45

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

docs/source/techniques/ScriptingSANSReductions.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ On calling this function the experimental run is :ref:`loaded <algm-Load>` and c
108108
Currently only ``reload=true`` is supported.
109109

110110
TransmissionSample
111-
^^^^^^^^^^^^^^^^^
111+
^^^^^^^^^^^^^^^^^^
112112

113113
.. code-block :: python
114114
@@ -202,25 +202,26 @@ Assuming the mask file contains the correct analysis details one can proceed to
202202
The return value of ``WavRangeReduction()`` is the name of the final reduced workspace.
203203
This function calls many algorithms ending with a call to :ref:`algm-Q1D` or :ref:`algm-Qxy`.
204204
Several optional parameters can control different aspects of the reduction
205-
- ``wav_start``: the first wavelength to be in the output data.
206-
- ``wav_end``: the last wavelength in the output data.
207-
- ``full_trans_wav``: Whether to use default's instrument wavelength range for transmission correction calculation, default is false.
208-
- ``name_suffix``: Appends the created output workspace with this suffix
209-
- ``combineDet``: combineDet can be one of the following
210-
211-
- 'rear': runs one reduction for the 'rear' detector data
212-
- 'front': run one reduction for the 'front' detector data, and rescale+shift 'front' data
213-
- 'both': run both the above two reductions
214-
- 'merged': run the same reductions as 'both' and additionally create a merged data workspace
215-
- None: run one reduction for whatever detector has been set as the current detector before running this method. If front apply rescale+shift)
216-
- ``saveAlgs``: A dict of save algorithms containing the names of the algorithms as key and the extension as value(ex: ``saveAlgs={'SaveRKH':'txt'}``).
217-
- ``save_as_zero_error_free``: Should the reduced workspaces contain zero errors.
218-
- ``output_name``: Name of the output file. Default is sample run number.
219-
- ``output_mode``: Decides the output of the reduced data, whether to publish to the ads (``OutputMode.PUBLISH_TO_ADS``), save to file with the chosen algorithm
220-
in ``saveAlgs`` (``OutputMode.SAVE_TO_FILE``) or doing both(``OutputMode.BOTH``). ``OutputMode`` can be imported
221-
with ``from sans.common.enums import OutputMode``.
222-
If this parameter is omitted, the default behaviour will be to publish the output to the ads and save it in a file if there is a ``saveAlgs``.
223-
- ``use_reduction_mode_as_suffix``: If ``True``, appends second suffix to output name based on reduction mode.
205+
206+
- ``wav_start``: the first wavelength to be in the output data.
207+
- ``wav_end``: the last wavelength in the output data.
208+
- ``full_trans_wav``: Whether to use default's instrument wavelength range for transmission correction calculation, default is false.
209+
- ``name_suffix``: Appends the created output workspace with this suffix
210+
- ``combineDet``: combineDet can be one of the following
211+
212+
- 'rear': runs one reduction for the 'rear' detector data
213+
- 'front': run one reduction for the 'front' detector data, and rescale+shift 'front' data
214+
- 'both': run both the above two reductions
215+
- 'merged': run the same reductions as 'both' and additionally create a merged data workspace
216+
- None: run one reduction for whatever detector has been set as the current detector before running this method. If front apply rescale+shift)
217+
- ``saveAlgs``: A dict of save algorithms containing the names of the algorithms as key and the extension as value(ex: ``saveAlgs={'SaveRKH':'txt'}``).
218+
- ``save_as_zero_error_free``: Should the reduced workspaces contain zero errors.
219+
- ``output_name``: Name of the output file. Default is sample run number.
220+
- ``output_mode``: Decides the output of the reduced data, whether to publish to the ads (``OutputMode.PUBLISH_TO_ADS``), save to file with the chosen algorithm
221+
in ``saveAlgs`` (``OutputMode.SAVE_TO_FILE``) or doing both(``OutputMode.BOTH``). ``OutputMode`` can be imported
222+
with ``from sans.common.enums import OutputMode``.
223+
If this parameter is omitted, the default behaviour will be to publish the output to the ads and save it in a file if there is a ``saveAlgs``.
224+
- ``use_reduction_mode_as_suffix``: If ``True``, appends second suffix to output name based on reduction mode.
224225

225226

226227
BatchReduce

0 commit comments

Comments
 (0)