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
aa2725a0
Commit
aa2725a0
authored
5 years ago
by
Conor Finn
Browse files
Options
Downloads
Patches
Plain Diff
RE #26849 Add cropping info to documentation
parent
6efb1295
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/interfaces/Engineering Diffraction 2.rst
+26
-7
26 additions, 7 deletions
docs/source/interfaces/Engineering Diffraction 2.rst
with
26 additions
and
7 deletions
docs/source/interfaces/Engineering Diffraction 2.rst
+
26
−
7
View file @
aa2725a0
...
...
@@ -11,7 +11,9 @@ Interface Overview
This custom interface will integrate several tasks related to engineering
diffraction. In its current state it provides functionality for creating
new calibration files. This interface is under active development.
and loading calibration files, and focusing ENGINX run files.
This interface is under active development.
General Options
^^^^^^^^^^^^^^^
...
...
@@ -27,6 +29,11 @@ Instrument
?
Show this documentation page.
Settings
Provides a range of options that apply across the entire interface, currently
providing the option to change the default output directory and force the
recalculation of the vanadium correction files.
Close
Close the interface.
...
...
@@ -37,9 +44,10 @@ Red Stars
Calibration
-----------
This tab currently provides a graphical interface to create new calibrations
and visualise them. It also allows for the loading of GSAS parameter files created
by the calibration process to load a previously created calibration into the interface.
This tab currently provides a graphical interface to create new calibrations, using the
:ref:`EnggCalibrate<algm-EnggCalibrate>` algorithm, and visualise them.
It also allows for the loading of GSAS parameter files created by the calibration process
to load a previously created calibration into the interface.
When loading an existing calibration, the fields for creating a new calibration will be
automatically filled, allowing the recreation of the workspaces and plots generated by
...
...
@@ -52,14 +60,18 @@ Creating a new calibration file generates 3 GSAS instrument parameter files,
one covering all banks and separate ones for each individual bank. All 3 files are written
to the same directory:
`
Engineering_Mantid
/Calibration/`
`
<CHOSEN_OUTPUT_DIRECTORY>
/Calibration/`
If an RB number has been specified the files will also be saved to a user directory
in the base directory:
`Engineering_Mantid/User/RBNumber/Calibration/`
`<CHOSEN_OUTPUT_DIRECTORY>/User/RBNumber/Calibration/`
Cropping
^^^^^^^^
Currently, the `Engineering_Mantid` directory is created in the current user's home directory.
The interface also provides the ability to restrict a new calibration to one of the two banks
or to a custom list of spectra.
Parameters
^^^^^^^^^^
...
...
@@ -74,6 +86,13 @@ Calibration Sample Number
Path
The path to the GSAS parameter file to be loaded.
Bank/Spectra
Select a bank to crop to or specify a custom spectra will be entered.
Custom Spectra
A comma separated list of spectra to restrict the calibration to. Can be provided as single spectrum numbers
or ranges using hyphens (e.g. 14-150, 405, 500-600).
Focus
-----
...
...
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