Commit 99ea59ff authored by Gigg, Martyn Anthony's avatar Gigg, Martyn Anthony
Browse files

Standardize heading characters

Uses # to denote a html h3 heading.
Refs #9562
parent 00e2d374
......@@ -45,7 +45,7 @@ sample, using a method imported from ISAW). Also, HRPD users can use the
calculations of the effects of the sample holder. |AbsorptionFlow.png|
Assumptions
^^^^^^^^^^^
###########
This algorithm assumes that the (parallel) beam illuminates the entire
sample **unless** a 'gauge volume' has been defined using the
......@@ -61,7 +61,7 @@ the sample then you will get a more accurate result from the
algorithm.)
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
The input workspace must have units of wavelength. The
`instrument <instrument>`__ associated with the workspace must be fully
......
......@@ -22,7 +22,7 @@ the offset; or a .cal file (in the form created by the ARIEL software).
Workspace <Ragged Workspace>`__.
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
The input workspace must contain histogram or event data where the X
unit is time-of-flight and the Y data is raw counts. The
......
......@@ -20,7 +20,7 @@ be copied from the first input workspace (but if they're not identical
anyway, then you probably shouldn't be using this algorithm!).
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
For `EventWorkspaces <EventWorkspace>`__, there are no restrictions on
the input workspaces if ValidateInputs=false.
......@@ -35,14 +35,14 @@ If ValidateInputs is selected, then the input workspaces must also:
- Have common bin boundaries
Spectrum Numbers
^^^^^^^^^^^^^^^^
################
If there is an overlap in the spectrum numbers of both inputs, then the
output workspace will have its spectrum numbers reset starting at 0 and
increasing by 1 for each spectrum.
See Also
^^^^^^^^
########
- :ref:`_algm-ConjoinWorkspaces` for joining parts of the
same workspace.
......
......@@ -23,7 +23,7 @@ parameter; any points NOT belonging inside of the ImplicitFunction will
be set as NaN (not-a-number).
Axis-Aligned Binning
~~~~~~~~~~~~~~~~~~~~
####################
This is binning where the output axes are aligned with the original
workspace. Specify each of the AlignedDim0, etc. parameters with these
......@@ -39,7 +39,7 @@ only within a range, then specify the start and end points, with only 1
bin.
Non-Axis Aligned Binning
~~~~~~~~~~~~~~~~~~~~~~~~
########################
This allows rebinning to a new arbitrary space, with rotations,
translations, or skewing. This is given by a set of basis vectors and
......@@ -87,7 +87,7 @@ vectors if needed to make them orthogonal to each other. Only works in 3
dimensions!
Binning a MDHistoWorkspace
~~~~~~~~~~~~~~~~~~~~~~~~~~
##########################
It is possible to rebin a `MDHistoWorkspace <MDHistoWorkspace>`__. Each
MDHistoWorkspace holds a reference to the
......
......@@ -28,7 +28,7 @@ in quadrature divided by the number of bins. This background error value
is added in quadrature to the errors in each bin.
ChildAlgorithms used
^^^^^^^^^^^^^^^^^^^^
####################
The `Linear <Linear>`__ algorithm is used when the Mode = Linear Fit.
From the resulting line of best fit a constant value taken as the value
......
......@@ -34,7 +34,7 @@ of wavelengths passed to CalculateTransmission is different from that of
the data to be corrected.
ChildAlgorithms used
~~~~~~~~~~~~~~~~~~~~
####################
Uses the algorithm `linear <linear>`__ to fit to the calculated
transmission fraction.
......
......@@ -36,7 +36,7 @@ Features to improve performance of peak finding
-----------------------------------------------
Define peak fit-window
~~~~~~~~~~~~~~~~~~~~~~
######################
There are two exclusive approaches to define peak's fit-window.
......@@ -47,7 +47,7 @@ fitting range.
peak will have its individual fit window defined.
Define accepted range of peak's width
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#####################################
Optional input property *DetectorResolutionWorkspace* is a matrix
workspace containing the detector resolution :math:`\Delta(d)/d` for
......
......@@ -15,7 +15,7 @@ the same point. This is useful if your raw files contain multiple
frames.
Identifying Extended Frames
~~~~~~~~~~~~~~~~~~~~~~~~~~~
###########################
.. figure:: /images/ChopDataIntegrationExplanation.png
:alt: Figure 1: Example Monitor Spectrum with Extended Frames
......
......@@ -24,7 +24,7 @@ of the first input workspace. Workspace data members other than the data
using this algorithm!). Both input workspaces will be deleted.
Conflict Spectrum IDs
^^^^^^^^^^^^^^^^^^^^^
#####################
The algorithm adds the spectra from the first workspace and then the
second workspace.
......@@ -41,7 +41,7 @@ second workspace.
non-negative integer.
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
The input workspaces must come from the same instrument, have common
units and bins and no detectors that contribute to spectra should
......
......@@ -13,7 +13,7 @@ Converts a histogram workspace from a distribution i.e. multiplies by
the bin width to take out the bin width dependency.
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
The workspace to convert must contain histogram data which is flagged as
being a distribution.
......
......@@ -38,7 +38,7 @@ screenshot for example:
SliceViewer-DetectorFace.png
BankNumbers Parameter
^^^^^^^^^^^^^^^^^^^^^
#####################
If your instrument has several
`RectangularDetectors <RectangularDetectors>`__, you can use the
......
......@@ -24,7 +24,7 @@ In order to define more precisely the parameters of the
:ref:`_algm-CreateMDWorkspace` algorithm first.
Types of Conversion
^^^^^^^^^^^^^^^^^^^
###################
- **Q (lab frame)**: this calculates the momentum transfer (ki-kf) for
each event is calculated in the experimental lab frame.
......@@ -37,7 +37,7 @@ Types of Conversion
Miller indices of each event.
Lorentz Correction
^^^^^^^^^^^^^^^^^^
##################
If selected, the following Lorentz correction factor is applied on each
event by multiplying its weight by L:
......@@ -53,7 +53,7 @@ This correction is also done by the
false if that algorithm has been run on the input workspace.
OneEventPerBin option
^^^^^^^^^^^^^^^^^^^^^
#####################
If you specify *OneEventPerBin*, then the **histogram** representation
of the input workspace is used, with one MDEvent generated for each bin
......@@ -80,7 +80,7 @@ If your input is a `Workspace2D <Workspace2D>`__ and you do NOT check
`EventWorkspace <EventWorkspace>`__ but with no events for empty bins.
Performance Notes
^^^^^^^^^^^^^^^^^
#################
- 8-core Intel Xeon 3.2 GHz computer: measured between 4 and 5.5
million events per second (100-200 million event workspace).
......
......@@ -24,7 +24,7 @@ In order to define more precisely the parameters of the
:ref:`_algm-CreateMDWorkspace` algorithm first.
Types of Conversion
^^^^^^^^^^^^^^^^^^^
###################
- **Q (lab frame)**: this calculates the momentum transfer (ki-kf) for
each event is calculated in the experimental lab frame.
......@@ -37,7 +37,7 @@ Types of Conversion
Miller indices of each event.
Lorentz Correction
^^^^^^^^^^^^^^^^^^
##################
If selected, the following Lorentz correction factor is applied on each
event by multiplying its weight by L:
......@@ -53,7 +53,7 @@ This correction is also done by the
false if that algorithm has been run on the input workspace.
OneEventPerBin option
^^^^^^^^^^^^^^^^^^^^^
#####################
If you specify *OneEventPerBin*, then the **histogram** representation
of the input workspace is used, with one MDEvent generated for each bin
......@@ -80,7 +80,7 @@ If your input is a `Workspace2D <Workspace2D>`__ and you do NOT check
`EventWorkspace <EventWorkspace>`__ but with no events for empty bins.
Performance Notes
^^^^^^^^^^^^^^^^^
#################
- 8-core Intel Xeon 3.2 GHz computer: measured between 4 and 5.5
million events per second (100-200 million event workspace).
......
......@@ -13,7 +13,7 @@ Makes a histogram workspace a distribution i.e. divides by the bin
width.
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
The workspace to convert must contain histogram data which is not
already flagged as a distribution.
......
......@@ -68,7 +68,7 @@ common situations. They work with the data files which already used by
Mantid for different testing tasks.
Convert re-binned MARI 2D workspace to 3D MD workspace for further analysis/merging with data at different temperatures
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#######################################################################################################################
.. code:: python
......@@ -84,7 +84,7 @@ Output **MD3** workspace can be viewed in slice-viewer as 3D workspace
with T-axis having single value.
Convert Set of Event Workspaces (Horace scan) to 4D MD workspace, direct mode:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##############################################################################
This example is based on CNCS\_7860\_event.nxs file, available in Mantid
test folder. The same script without any changes would produce similar
......@@ -137,7 +137,7 @@ and stored in nxspe files.
plotSlice(RezWS, xydim=["[H,0,0]","[0,K,0]"], slicepoint=[0,0] )
Convert set of inelastic results obtained in Powder mode (direct) as function of temperature to a 3D workspace:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
###############################################################################################################
The test example is based on MAR1011.nxspe data file, obtained by
reducing test data from the MARI experiment. The data for the experiment
......
......@@ -10,7 +10,7 @@ Description
-----------
Prerequisites
~~~~~~~~~~~~~
#############
The workspace spectrum axis should be converted to signed\_theta using
:ref:`_algm-ConvertSpectrumAxis` and the x axis should be
......@@ -24,7 +24,7 @@ value you can do so by providing your own *IncidentTheta* property and
enabling *OverrideIncidentTheta*.
Transformations
~~~~~~~~~~~~~~~
###############
Output workspaces are always 2D MD Histogram workspaces, but the
algorithm will perform one of three possible transformations.
......@@ -49,7 +49,7 @@ where
{{AlgorithmLinks|ConvertToReflectometryQ}}
After Transformation
~~~~~~~~~~~~~~~~~~~~
####################
You will usually want to rebin using :ref:`_algm-BinMD` or
:ref:`_algm-SliceMD` after transformation because the output workspaces
......
......@@ -32,7 +32,7 @@ value of EFixed will be taken, if available, from the instrument
definition file.
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
- Naturally, the X values must have a unit set, and that unit must be
known to the `Unit Factory <Unit Factory>`__.
......
......@@ -14,7 +14,7 @@ This algorithm is to import Fullprof .irf file (peak parameters) and
which serve as the inputs for algorithm LeBailFit.
Format of Instrument parameter TableWorkspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#############################################
Instrument parameter TableWorkspace contains all the peak profile
parameters imported from Fullprof .irf file.
......@@ -28,7 +28,7 @@ Each row in TableWorkspace corresponds to one profile parameter.
Columns include Name, Value, FitOrTie, Min, Max and StepSize.
Format of reflection TableWorkspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
Each row of this workspace corresponds to one diffraction peak. The
information contains the peak's Miller index and (local) peak profile
......
......@@ -15,7 +15,7 @@ values for each of the specified properties, for each of the specified
workspaces.
LogPropertyNames
~~~~~~~~~~~~~~~~
################
The list of log property names provided must consist of properties that
actually appear in the workspace(s). You can check which properties are
......@@ -24,19 +24,19 @@ the "Sample Logs..." dialog window. All acceptable properties have names
that appear in the "Name" column of the dialog table.
GroupPolicy
~~~~~~~~~~~
###########
GroupWorkspaces can be handled in various ways, depending on the
GroupPolicy input:
"All"
^^^^^
#####
All children of any GroupWorkspaces will be included in the table. This
should be used when each child workspace contains different data.
"First"
^^^^^^^
#######
Only the first child of any GroupWorkspaces will be included in the
table. This is useful for instruments that produce groups of workspaces
......@@ -44,7 +44,7 @@ for a single run, and specifying "All" would populate the table with
duplicate data.
"None"
^^^^^^
######
Excludes GroupWorkspaces altogether.
......
......@@ -17,7 +17,7 @@ equatorial region, are counting above this threshold then the entire
tube is masked.
Restrictions on the input workspace
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
###################################
- The workspace must contain either raw counts or counts/us.
......
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