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
5c7d12ed
Commit
5c7d12ed
authored
10 years ago
by
Raquel Alvarez Banos
Browse files
Options
Downloads
Patches
Plain Diff
Re #11165 Update doc and add user examples
parent
5ec71a04
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
Code/Mantid/docs/source/algorithms/LoadMuonNexus-v1.rst
+39
-4
39 additions, 4 deletions
Code/Mantid/docs/source/algorithms/LoadMuonNexus-v1.rst
with
39 additions
and
4 deletions
Code/Mantid/docs/source/algorithms/LoadMuonNexus-v1.rst
+
39
−
4
View file @
5c7d12ed
...
...
@@ -15,11 +15,12 @@ be an absolute or relative path and should have the extension .nxs or
.NXS. If the file contains data for more than one period, a separate
workspace will be generated for each. After the first period the
workspace names will have "\_2", "\_3", and so on, appended to the given
workspace name.
For single period data, t
he optional parameters can be
workspace name.
T
he optional parameters can be
used to control which spectra are loaded into the workspace. If
spectrum\_min and spectrum\_max are given, then only that range to data
will be loaded. If a spectrum\_list is given than those values will be
loaded.
SpectrumMin and SpectrumMax are given, then only that range of data
will be loaded. If a SpectrumList is given, then those values will be
loaded. If a range and a list are supplied, the algorithm will
load all the specified spectra.
- TODO get XML descriptions of Muon instruments. This data is not in
existing Muon Nexus files.
...
...
@@ -78,4 +79,38 @@ The ChildAlgorithms used by LoadMuonNexus are:
LoadInstrument fails. As the Nexus file has limited instrument data,
this only populates a few fields.
Usage
-----
.. include:: ../usagedata-note.txt
**Example - Load ISIS muon MUSR dataset:**
.. testcode:: LoadMuonNexusOnePeriod
# Load MUSR dataset
ws = LoadMuonNexus(Filename="MUSR00015189.nxs",EntryNumber=1)
print "Workspace has ", ws[0].getNumberHistograms(), " spectra"
Output:
.. testoutput:: LoadMuonNexusOnePeriod
Workspace has 64 spectra
**Example - Load event nexus file with time filtering:**
.. testcode:: ExLoadMuonNexusSomeSpectra
# Load some spectra
ws = LoadMuonNexus(Filename="MUSR00015189.nxs",SpectrumMin=5,SpectrumMax=10,EntryNumber=1)
print "Workspace has ", ws[0].getNumberHistograms(), " spectra"
Output:
.. testoutput:: ExLoadMuonNexusSomeSpectra
Workspace has 6 spectra
.. categories::
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