Commit 5ab79bf8 authored by luz.paz's avatar luz.paz
Browse files

Fix whitespace errors

parent 7b9f0430
......@@ -48,7 +48,7 @@ The masking procedure proceeds as follows:
#. Repeat for the other half.
Default mask
###########
############
The default mask file is defined by the 'Workflow.MaskFile' instrument parameter.
......@@ -107,7 +107,7 @@ Usage
import numpy
import scipy.stats
# Create a fake IN4 workspace.
# We need an instrument and a template first.
empty_IN4 = LoadEmptyInstrument(InstrumentName='IN4')
......@@ -131,7 +131,7 @@ Usage
ys *= 0.0
ys = ws.dataY(101)
ys *= 0.0
# Manually correct monitor spectrum number as LoadEmptyInstrument does
# not know about such details.
SetInstrumentParameter(
......@@ -152,7 +152,7 @@ Usage
# Elastic channel information is missing in the sample logs.
# It can be given as single valued workspace, as well.
elasticChannelWS = CreateSingleValuedWorkspace(107)
DirectILLCollectData(
InputWorkspace=ws,
OutputWorkspace='preprocessed',
......@@ -160,7 +160,7 @@ Usage
IncidentEnergyCalibration='Energy Calibration OFF', # Normally we would do this for IN4.
OutputEPPWorkspace='epps' # Needed for the diagnostics.
)
diagnostics = DirectILLDiagnostics(
InputWorkspace='preprocessed',
OutputWorkspace='diagnosed',
......@@ -168,7 +168,7 @@ Usage
NoisyBkgLowThreshold=0.01,
OutputReportWorkspace='diagnostics_report'
)
print(diagnostics.OutputReport)
print('Some small-angle detectors got diagnosed as bad due to detector solid angle corrections.')
report = mtd['diagnostics_report']
......
......@@ -20,7 +20,7 @@ This algorithm is one of the workflow algorithms that helps
:ref:`algm-AlignAndFocusPowder`.
Determining Frequency and Wavelength
##################################
####################################
The frequency is found by inspecting the logs (in order)
``SpeedRequest1``, ``Speed1``, and ``frequency``. Whichever one has a
......
......@@ -37,7 +37,7 @@ General properties
| | algorithms that should be hidden in Mantid. | |
+----------------------------------+--------------------------------------------------+-------------------+
| ``algorithms.retained`` | The Number of algorithms properties to retain in | ``50`` |
| | memory for reference in scripts. | |
| | memory for reference in scripts. | |
+----------------------------------+--------------------------------------------------+-------------------+
| ``MultiThreaded.MaxCores`` | Sets the maximum number of cores available to be | ``0`` |
| | used for threads for | |
......@@ -52,7 +52,7 @@ Facility and instrument properties
|Property |Description |Example value |
+==============================+====================================================+=====================+
| ``default.facility`` | The name of the default facility. The facility | ``ISIS`` |
| | must be defined within the facilities.xml file to | |
| | must be defined within the facilities.xml file to | |
| | be considered valid. The file is described | |
| | :ref:`here <Facilities file>`. | |
+------------------------------+----------------------------------------------------+---------------------+
......@@ -181,7 +181,7 @@ Network Properties
| |operations (in seconds). | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``network.scriptrepo.timeout`` |The timeout for network operations in the script | ``5`` |
| |repository, this overrides the default timeout. | |
| |repository, this overrides the default timeout. | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``proxy.host`` | Allows the system proxy to be overridden, if not | ``http://www.proxy.org`` |
| | set mantid will use the system proxy | |
......
......@@ -17,7 +17,7 @@ accessed from the main menu of MantidPlot, in *Interfaces → Muon → Muon Anal
datasets, please visit `Muon - Downloads <http://www.isis.stfc.ac.uk/groups/muons/downloads/downloads4612.html>`_.#
If the :ref:`Frequency_Domain_Analysis-ref` interfaces is opened it will import all of the data available for the current run in Muon Analysis.
This will include any custom groupings/pairs.
This will include any custom groupings/pairs.
Home
----
......@@ -132,7 +132,7 @@ Plot Data
| | | - **AsymmetryCalc** For pairs- the result of |
| | | :ref:`AsymmetryCalc <algm-AsymmetryCalc>` for the pair groups. |
| | | For groups- the result of :ref:`RemoveExpDecay <algm-RemoveExpDecay>` applied |
| | | to the group. |
| | | to the group. |
| | | |
| | | - **Counts** *(groups only)*. Pure counts of the selected group. |
| | | |
......@@ -268,8 +268,8 @@ Data Analysis
This tab is designed for the user to make a fit against the data just plotted.
Since Mantid 3.8 (upgraded in 3.10), this tab has been enhanced to include fits of multiple datasets at once.
Since Mantid 3.10 a Transverse field (TF) Asymmetry mode has been added and from Mantid 3.11 it is also available in
multiple fitting mode.
Since Mantid 3.10 a Transverse field (TF) Asymmetry mode has been added and from Mantid 3.11 it is also available in
multiple fitting mode.
Default: multiple fitting disabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
......@@ -290,11 +290,11 @@ The intention is that this mode could be useful for users who are accustomed to
TF asymmetry enabled
^^^^^^^^^^^^^^^^^^^^^^^^
The TF asymmetry mode can be enabled by checking the "TF Asymmetry" checkbox in the Settings table of the data analysis tab. Leaving the tab will deactivate
The TF asymmetry mode can be enabled by checking the "TF Asymmetry" checkbox in the Settings table of the data analysis tab. Leaving the tab will deactivate
TF asymmetry.
When TF Asymmetry is activated the user's function is updated by using :ref:`ConvertFitFunctionForMuonTFAsymmetry <algm-ConvertFitFunctionForMuonTFAsymmetry>`
and populates the function browser. The ties and constraints are not preserved. The plot will also update. Running a fit will then use :ref:`CalculaterMuonAsymmetry <algm-CalculateMuonAsymmetry>`. This willupdate the normalized data.
It is advised that when using this feature to have no binning.
It is advised that when using this feature to have no binning.
When the user deactivates the "TF Asymmetry" checkbox the user function is returned with updated values.
......@@ -321,7 +321,7 @@ The function browser has three columns - property, value and global.
The values shown are those of the currently selected/plotted dataset.
The global column contains a checkbox for each function parameter which, when checked, sets this parameter to be shared between all fits.
Parameters can be fixed, tied and constrained by right-clicking.
Parameters can be fixed, tied and constrained by right-clicking.
In addition, just as in the general multi dataset fitting interface, when highlighting a non-global function parameter, a small button will appear next to its value.
This button will open the "Edit local parameter values" dialog, which offers greater control of function parameters for each dataset.
......@@ -346,15 +346,15 @@ Data Table
^^^^^^^^^^
The data table allows the user to modify the selected data for the fitting. This includes the start and end times, which can also
be updated by dragging the blue dashed lines in the plot. The "Groups/Pairs to fit" box provides a drop-down menu with three options (all groups, all pairs and custom).
Selecting custom will produce a pop-up box with tick boxes for each of the available groups and pairs. If a user wants to update the custom selection the
be updated by dragging the blue dashed lines in the plot. The "Groups/Pairs to fit" box provides a drop-down menu with three options (all groups, all pairs and custom).
Selecting custom will produce a pop-up box with tick boxes for each of the available groups and pairs. If a user wants to update the custom selection the
Groups/Pairs button can be pressed from the ReselectData_ section at the bottom of the tab (this is only enabled if a custom selection is set). Underneath displays the
"Selected Groups".
"Selected Groups".
The next row is the "Periods to fit" option, which is only displayed for multiple period data. This will automatically be populated with
each of the periods (e.g. 1,2,3) and a custom option. Selecting custom will produce a pop-up with checkboxes for all of the periods. Selecting custom will also enable the
each of the periods (e.g. 1,2,3) and a custom option. Selecting custom will produce a pop-up with checkboxes for all of the periods. Selecting custom will also enable the
"Periods" button in the ReselectData_ section
and pressing this button will allow the user to alter their custom selection.
and pressing this button will allow the user to alter their custom selection.
Examples/Use cases
""""""""""""""""""
......@@ -402,12 +402,12 @@ Reselect data
.. _ReselectData:
At the bottom of the tab is the "Reselect Data" section. This includes three buttons "Groups/Pairs", "Periods" and "Combine Periods". The "Groups/Pairs" and "Periods"
buttons are only when the relevant options in the data table are set to custom. Pressing the button will produce a pop-up that will allow the user to modify their selection.
At the bottom of the tab is the "Reselect Data" section. This includes three buttons "Groups/Pairs", "Periods" and "Combine Periods". The "Groups/Pairs" and "Periods"
buttons are only when the relevant options in the data table are set to custom. Pressing the button will produce a pop-up that will allow the user to modify their selection.
The "Combine Periods" button is only enabled if multiple periods are available. Pressing the button will generate a pop-up with two boxes. The top one is for adding periods
(as a comma separated list or with "+") and the bottom box is for subtraction (as a comma sepearted list). Everything in the top and bottom boxes are summed seperatley
and the results are then used in the subtraction.
The "Combine Periods" button is only enabled if multiple periods are available. Pressing the button will generate a pop-up with two boxes. The top one is for adding periods
(as a comma separated list or with "+") and the bottom box is for subtraction (as a comma sepearted list). Everything in the top and bottom boxes are summed seperatley
and the results are then used in the subtraction.
.. image:: ../images/MuonAnalysisCombinePeriods.png
:align: right
......@@ -427,14 +427,14 @@ The dialog can be opened from the Fit menu in *Fit* → *Sequential Fit*.
+-------+-----------------------+---------------------------------------------------------------------------+
| **1** | **Runs** | A list of run data files to fit. Two types of input are accepted: |
| | | |
| | | |
| | | - List of files on the disk separated by comma. These can be specified |
| | | using the *Browse* button. |
| | | |
| | | |
| | | - Run numbers separated by comma. Specific files will then be searched |
| | | in the archive for the instrument selected on the interface. Ranges |
| | | are allowed, e.g. "15189-15199". |
| | | |
| | | |
+-------+-----------------------+---------------------------------------------------------------------------+
| **2** | **Label** | Text label to use for the sequential fit. It is used to find the results |
| | | on the ResultsTable_ tab. The resulting workspace group and the |
......@@ -452,7 +452,7 @@ The dialog can be opened from the Fit menu in *Fit* → *Sequential Fit*.
| | | values of all the parameters. |
+-------+-----------------------+---------------------------------------------------------------------------+
After the options have been set and the *Start* button has been pressed, the dialog goes through **every**
After the options have been set and the *Start* button has been pressed, the dialog goes through **every**
data file and does the following:
1. Loads the file
......@@ -641,7 +641,7 @@ General
| | | |
| | | NOTE: This can can cause speed and stability problems once the |
| | | number of graphs managed by Mantidplot passes a few hundred |
| | | which can happen if you run Mantid for a few days on an |
| | | which can happen if you run Mantid for a few days on an |
| | | experiment. For long term stability we suggest you select |
| | | **Use previous window**. |
| | | |
......@@ -677,6 +677,6 @@ Feedback & Comments
If you have any questions or comments about this interface or this help page, please
contact the `Mantid team <http://www.mantidproject.org/Contact>`__ or the
`Muon group <http://www.isis.stfc.ac.uk/groups/muons/muons3385.html>`__.
`Muon group <http://www.isis.stfc.ac.uk/groups/muons/muons3385.html>`__.
.. categories:: Interfaces Muon
......@@ -20,7 +20,7 @@ User Interface
appropriately rather than being too small to be usable (Windows only).
- A new Print button has been added to the MantidPlot help window.
.. figure:: ../../images/maskedbins.jpg
.. figure:: ../../images/maskedbins.jpg
:class: screenshot
:width: 500px
:align: right
......@@ -49,12 +49,12 @@ Plotting Improvements
+ This allows a wider selection of plot types: Surface, Contour, Waterfall, 1D and Tiled plotting
+ If you have more than one workspace selected, either by using ctrl or shift, or by selecting a group workspace this enables multiple workspaces to be included in the plots
+ This interface also give you much better control over the labelling of the data in the plots
* Log values can be used as labels, which is good for temperature or pressure ramps
* Custom labels can be input if log data is not available
* For Waterfall and 1D plots, the labelling appears in the legend
* For Surface plots the labels form the Z axis
* For Surface plots the labels form the Z axis
- Curves where all(Y) <= 0 are now not plotted when the Y-scale is set to logarithmic.
The previous behaviour assigned an arbitrary value of 0.1 which was confusing.
......@@ -88,7 +88,7 @@ SliceViewer Improvements
- Fixed a bug where the normalization selection was not respected.
VSI Improvements
###############
################
- ParaView was updated to to `v5.3.0 <https://blog.kitware.com/paraview-5-3-0-release-notes/>`_.
- The mapped array vtkMDHWSignalArray has been refactored to use the new vtkGenericDataArray class template. This interface minimizes virtual indirection and allows advanced compiler optimizations such as vectorization.
- Minimize the number of times the workspace min and max values are calculated.
......
......@@ -65,7 +65,7 @@ Summary of impact
+-------+-----------------------------------------------------------------------------------------+---------------------------+--------------+
| 22194 | SofQW3 segfault no longer occurs | Indexing change | **medium** |
+-------+-----------------------------------------------------------------------------------------+---------------------------+--------------+
| 22190 | OSX Muon Interface data requirements fixed | GUI changes | **low** |
| 22190 | OSX Muon Interface data requirements fixed | GUI changes | **low** |
+-------+-----------------------------------------------------------------------------------------+---------------------------+--------------+
| 22182 | Update mslice to fix issue with matplotlib < 1.5 | Update sha1 | **medium** |
+-------+-----------------------------------------------------------------------------------------+---------------------------+--------------+
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment