Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
mantid
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Code review analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mantidproject
mantid
Commits
c55259e5
Commit
c55259e5
authored
7 years ago
by
Joseph Ramsay
Browse files
Options
Downloads
Patches
Plain Diff
Re #21247 Updated docs for new engg fitting functionality
parent
030c5015
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/interfaces/Engineering Diffraction.rst
+12
-31
12 additions, 31 deletions
docs/source/interfaces/Engineering Diffraction.rst
with
12 additions
and
31 deletions
docs/source/interfaces/Engineering Diffraction.rst
+
12
−
31
View file @
c55259e5
...
@@ -335,24 +335,24 @@ Fitting
...
@@ -335,24 +335,24 @@ Fitting
.. warning:: The input workspace must be converted into a focused file
.. warning:: The input workspace must be converted into a focused file
first. The steps to complete this are found here: :ref:`focus-Engineering_Diffraction-ref`
first. The steps to complete this are found here: :ref:`focus-Engineering_Diffraction-ref`
The Fitting tab provides a graphical interface which fits an
expecte
d
The Fitting tab provides a graphical interface which fits and
diffraction pattern and visualises them
. The pattern is specified
by
visualises an expected diffraction pattern
. The pattern is specified
providing a list of dSpacing values where Bragg peaks are expected.
by
providing a list of dSpacing values where Bragg peaks are expected.
The algorithm :ref:`EnggFitPeaks<algm-EnggFitPeaks>` is used to
The algorithm :ref:`EnggFitPeaks<algm-EnggFitPeaks>` is used to
background fit peaks in those areas using a peak fitting function.
background fit peaks in those areas using a peak fitting function.
To use the Fitting tab, user is required to follow these steps:
To use the Fitting tab, user is required to follow these steps:
1.
A focused file as Focus Run input
by browsing or
entering single/multi
1.
Load run(s) to perform fitting on
by browsing
f
or
focused nexus
run number,
*User may click Load button to load the focused file to the
files
*User may click Load button to load the focused file to the
canvas*
canvas*
2. List of expected peaks which can be either by browsing a (*CSV*) file,
2. List of expected peaks which can be either by browsing a (*CSV*) file,
manually selecting peaks from the canvas using peak picker tool after
manually selecting peaks from the canvas using peak picker tool after
loading the focused file or by entering the peaks list within the text-field
loading the focused file or by entering the peaks list within the text-field
3. Next click on the *Fit* button if you would like to fit single focused
3. Next click on the *Fit* button if you would like to fit single focused
file or you can click *Fit All* button which will enable user to
file or you can click *Fit All* button which will enable user to
batch-process all the runs and banks when
a range of run number is given,
batch-process all the runs and banks when
several files are loaded.
*Fit All* process may also be used when
when
a single run number is given
*Fit All* process may also be used when a single run number is given
or a file is browsed
or a file is browsed
.. _ExpectedPeaks-Engineering_Diffraction-ref:
.. _ExpectedPeaks-Engineering_Diffraction-ref:
...
@@ -362,44 +362,25 @@ Parameters
...
@@ -362,44 +362,25 @@ Parameters
These parameters are required to process Fitting successfully:
These parameters are required to process Fitting successfully:
Focused Run #:
Focused Run files:
Focused workspace directory or selected using the browse button.
.nxs files containing focused diffraction data. These should be the result
Users may also select the file/s by simply entering the file run number
of focusing data with the :ref:`focus-Engineering_Diffraction-ref` tab.
or a range of consecutive run number separated by dash (`-`), for
example: "194547-194550" or "241391-241399".
It is compulsory for these file/s to be located within the focused output directory.
Focused workspace can be generated with the help of
:ref:`focus-Engineering_Diffraction-ref` tab, the output folder
directory can be set in the :ref:`setting-Engineering_Diffraction-ref`
tab under the *Focusing settings* section.
When a valid range of consecutive run numbers is given, the interface will
automatically import and add the run number/s to the list on the right side
of the graph, from where each run number can be selected from by click on it.
The interface will then automatically update the Plot Bank combo-box
according to the bank files found for each entered/selected run-number.
Peaks:
Peaks:
A list of dSpacing values to be translated into TOF to find expected
A list of dSpacing values to be translated into TOF to find expected
peaks. These peaks can be manually written or imported by selecting a
peaks. These peaks can be manually written or imported by selecting a
(*CSV*) file.
(*CSV*) file.
Plot Bank/Bank List:
These GUI widgets will only be enabled when multiple focused bank
files are found within the working directory or focused output directory.
This would enable user to select the desired bank which they would like to
plot with the help of Plot Bank combo-box or Bank List.
Output
Output
^^^^^^
^^^^^^
Once the Fit button has been clicked Mantid will process the data. Please wait
Once the Fit button has been clicked Mantid will process the data. Please wait
until the Fitting process has completed. Upon completion you should be able to
until the Fitting process has completed. Upon completion you should be able to
view
on
the Fitting tab which will contain:
view the Fitting tab which will contain:
- The focused workspace plotted in the background in gray crosses.
- The focused workspace plotted in the background in gray crosses.
- The expected peaks plotted in various colours over
lapping the
- The expected peaks plotted in various colours overlapping the
focused workspace peaks.
focused workspace peaks.
Within the :ref:`Preview-Engineering_Diffraction-ref` section a user is
Within the :ref:`Preview-Engineering_Diffraction-ref` section a user is
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment