diff --git a/docs/source/interfaces/Indirect Corrections.rst b/docs/source/interfaces/Indirect Corrections.rst index 92f43a7ab82bb974b2d162043334789502f289a2..ce486298600ddc1a36e652761e72e558bac54332 100644 --- a/docs/source/interfaces/Indirect Corrections.rst +++ b/docs/source/interfaces/Indirect Corrections.rst @@ -75,11 +75,11 @@ Plot Current Preview Run Runs the processing configured on the current tab. -Plot Spectrum - Gives the option to create a plot of the spectrum selected in the spin box for the corrected workspace. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. Plot Contour - Gives the option to create a contour plot of the corrected workspace. + If enabled, it will plot the selected output workspace as a contour plot. Save Result If enabled the result will be saved as a NeXus file in the default save directory. @@ -135,8 +135,11 @@ Cross Sections Run Runs the processing configured on the current tab. -Plot - Plots the parameter selected in the neighbouring combobox. +Plot Wavelength + If enabled, it will plot a wavelength spectrum represented by the selected workspace indices. + +Plot Angle + If enabled, it will plot an angle bin represented by the neighbouring bin indices. Save Result Saves the result in the default save directory. @@ -324,8 +327,11 @@ Cross Sections Run Runs the processing configured on the current tab. -Plot - Plots the parameter selected in the neighbouring combobox. +Plot Wavelength + If enabled, it will plot a wavelength spectrum represented by the selected workspace indices. + +Plot Angle + If enabled, it will plot an angle bin represented by the neighbouring bin indices. Save Result Saves the result in the default save directory. @@ -475,12 +481,11 @@ Plot Current Preview Run Runs the processing configured on the current tab. -Plot Spectrum - Gives the option to create a plot of the spectrum selected in the spin box for - the corrected workspace. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. Plot Contour - Gives the option to create a contour plot of the corrected workspace. + If enabled, it will plot the selected output workspace as a contour plot. Save Result If enabled the result will be saved as a NeXus file in the default save directory. diff --git a/docs/source/interfaces/Indirect Data Analysis.rst b/docs/source/interfaces/Indirect Data Analysis.rst index f67187c9211ba46a432bc81bbc09ed1763e4590b..e79dff52005819d8b5c4fb43c913b8a08e3e848d 100644 --- a/docs/source/interfaces/Indirect Data Analysis.rst +++ b/docs/source/interfaces/Indirect Data Analysis.rst @@ -111,10 +111,8 @@ Plot Current Preview Run Runs the processing configured on the current tab. -Plot Spectrum - If enabled it will plot the spectrum represented by the workspace index in the - neighbouring spin box. This workspace index is the index of the spectrum within the - workspace selected in the combobox. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. Save Result Saves the result in the default save directory. @@ -153,8 +151,8 @@ and the reflection is 002. 7. Click **Run** and wait for the interface to finish processing. This should generate four workspaces ending in _eq, _eq2, _elf and _elt. -8. In the **Output** section, select the workspace ending with _eq and then choose a workspace - index. Click **Plot Spectrum** to plot the spectrum from the selected workspace. +8. In the **Output** section, select the workspace ending with _eq and then choose some workspace + indices (e.g. 0-2,4). Click **Plot Spectra** to plot the spectrum from the selected workspace. 9. Choose a default save directory and then click **Save Result** to save the output workspaces. The workspace ending in _eq will be used in the :ref:`msdfit-example-workflow`. @@ -328,12 +326,12 @@ Number Of Iterations Run Runs the processing configured on the current tab. -Plot Spectrum - If enabled will plot the spectrum selected by the neighbouring spinbox. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. -Tiled Plot - Produces a tiled plot of spectra included within the range for the output workspaces - generated. There is a maximum of 18 spectra allowed for a tiled plot. +Plot Tiled + It will plot a tiled plot containing the selected workspace indices. It accessed via the down + arrow on the **Plot Spectra** button. Save Result Saves the result workspace in the default save directory. @@ -364,8 +362,8 @@ and the reflection is 002. 4. Click **Run** and wait for the interface to finish processing. This should generate a workspace ending with a suffix _iqt. -5. In the **Output** section, select a workspace index **Range** for a tiled plot and then click - **Tiled Plot**. Note that there is a maximum of 18 plots allowed for the tiled plot. +5. In the **Output** section, select some workspace indices (e.g.0-2,4,6) for a tiled plot and then click + the down arrow on the **Plot Spectra** button before clicking **Plot Tiled**. 6. Choose a default save directory and then click **Save Result** to save the _iqt workspace. This workspace will be used in the :ref:`iqtfit-example-workflow`. diff --git a/docs/source/interfaces/Indirect Diffraction.rst b/docs/source/interfaces/Indirect Diffraction.rst index d068d7d71598d072bc27bbfff49c1ea2c1c5222c..a4b49133227f06f922247a2b2f127fdba3392268 100644 --- a/docs/source/interfaces/Indirect Diffraction.rst +++ b/docs/source/interfaces/Indirect Diffraction.rst @@ -66,9 +66,11 @@ Spectra Min & Spectra Max Run Runs the processing configured on the current tab. -Plot Type - Specify the type of plot to be created when the reduction is complete, either - a contour or spectra plot can be created. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. + +Plot Contour + If enabled, it will plot the selected output workspace as a contour plot. Save Formats Select a range of save formats to save the reduced data as, in all cases the diff --git a/docs/source/interfaces/Indirect Simulation.rst b/docs/source/interfaces/Indirect Simulation.rst index 289d6d5463601dbf36b5edb914d783b80d1309ea..0a04c19c2bc749d68ba21cc7dc7b85c99e284641 100644 --- a/docs/source/interfaces/Indirect Simulation.rst +++ b/docs/source/interfaces/Indirect Simulation.rst @@ -65,8 +65,11 @@ Instrument Resolution Run Runs the processing configured on the current tab. -Plot - Plots either a spectra or contour plot (or both) of the output data. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. + +Plot Contour + If enabled, it will plot the selected output workspace as a contour plot. Save Result Saves the result in the default save directory. @@ -95,8 +98,8 @@ Sort by Q Vectors Run Runs the processing configured on the current tab. -Plot Result - If clicked will create a spectra plot of the output data. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. Save Result Saves the result in the default save directory. @@ -178,8 +181,8 @@ Other Options Run Runs the processing configured on the current tab. -Plot Result - If clicked will create a spectra plot of the outputted data. +Plot Spectra + If enabled, it will plot the selected workspace indices in the selected output workspace. Save Result Saves the result in the default save directory.