Skip to content

Commit

Permalink
bring doc up-to-date re support of spectra filters, re #7523
Browse files Browse the repository at this point in the history
  • Loading branch information
FedeMPouzols committed Jan 9, 2015
1 parent a7b5479 commit 74821fa
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions Code/Mantid/docs/source/algorithms/LoadNexusProcessed-v1.rst
Expand Up @@ -9,14 +9,19 @@
Description
-----------

The algorithm LoadNexusProcessed will read a Nexus data file created by
:ref:`algm-SaveNexusProcessed` and place the data into the
named workspace. The file name can be an absolute or relative path and
should have the extension .nxs, .nx5 or .xml. Warning - using XML format
can be extremely slow for large data sets and generate very large files.
The optional parameters can be used to control which spectra are loaded
into the workspace (not yet implemented). If spectrum\_min and
spectrum\_max are given, then only that range to data will be loaded.
The algorithm LoadNexusProcessed will read a Nexus data file created
by :ref:`algm-SaveNexusProcessed` and place the data into the named
workspace. The file name can be an absolute or relative path and
should have the extension .nxs, .nx5 or .xml. Warning - using XML
format can be extremely slow for large data sets and generate very
large files.

The optional parameters can be used to control which spectra are
loaded into the workspace. If SpectrumMin and SpectrumMax are given,
then only that range to data will be loaded. A specific list of
spectra to load can also be given (SpectrumList). Filtering of spectra
is supported when loading into workspaces of type :ref:`Workspace2Ds
<Workspace2D>` and also :ref:`EventWorkspaces <EventWorkspace>`.

A Mantid Nexus file may contain several workspace entries each labelled
with an integer starting at 1. By default the highest number workspace
Expand Down

0 comments on commit 74821fa

Please sign in to comment.