Skip to content
Snippets Groups Projects
Commit c1240f92 authored by Alex Buts's avatar Alex Buts
Browse files

refs #9581 LoadDetectorInfo description

and small changes to number of other files.
parent ae2118ed
No related merge requests found
...@@ -40,7 +40,7 @@ namespace Mantid ...@@ -40,7 +40,7 @@ namespace Mantid
/// Algorithm's name for identification overriding a virtual method /// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "LoadDetectorInfo"; } virtual const std::string name() const { return "LoadDetectorInfo"; }
///Summary of algorithms purpose ///Summary of algorithms purpose
virtual const std::string summary() const {return "Loads delay times, tube pressures and tube wall thicknesses from a given file.";} virtual const std::string summary() const {return "Loads delay times, tube pressures, tube wall thicknesses and, if necessary, the detectors positions from a given special format file";}
/// Algorithm's version for identification overriding a virtual method /// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; } virtual int version() const { return 1; }
......
...@@ -42,7 +42,7 @@ namespace Mantid ...@@ -42,7 +42,7 @@ namespace Mantid
{ {
declareProperty(new WorkspaceProperty<>("Workspace","",Direction::InOut), declareProperty(new WorkspaceProperty<>("Workspace","",Direction::InOut),
"The name of the workspace to that the detector information will be loaded into"); "The name of the workspace to that the detector information will be loaded into.");
std::vector<std::string> exts; std::vector<std::string> exts;
// each of these allowed extensions must be dealt with in exec() below // each of these allowed extensions must be dealt with in exec() below
exts.push_back(".dat"); exts.push_back(".dat");
...@@ -50,11 +50,11 @@ namespace Mantid ...@@ -50,11 +50,11 @@ namespace Mantid
exts.push_back(".sca"); exts.push_back(".sca");
exts.push_back(".nxs"); exts.push_back(".nxs");
declareProperty(new FileProperty("DataFilename","", FileProperty::Load, exts), declareProperty(new FileProperty("DataFilename","", FileProperty::Load, exts),
"A .raw,.dat,.nxs or .sca file that contains information about the detectors in the " "A **raw, dat, nxs** or **sca** file that contains information about the detectors in the "
"workspace. The description of Dat and nxs file format is provided below."); "workspace. The description of **dat** and **nxs** file format is provided below.");
declareProperty("RelocateDets", false, declareProperty("RelocateDets", false,
"If true then the detectors are moved to the positions specified in the raw/dat/nxs file.", "If true, the detectors are moved to the positions specified in the file defined by the field above.",
Direction::Input); Direction::Input);
} }
......
...@@ -10,8 +10,8 @@ Description ...@@ -10,8 +10,8 @@ Description
----------- -----------
This algorithm is used in the Paraview event nexus loader to both load This algorithm is used in the Paraview event nexus loader to both load
an event nexus file and convert it into a an event nexus file and convert it into a `MDEventWorkspace <http://www.mantidproject.org/MDEventWorkspace>`_
`MDEventWorkspace <http://www.mantidproject.org/MDEventWorkspace>`_ for use in visualization. for use in visualization.
The :ref:`algm-LoadEventNexus` algorithm is called with default The :ref:`algm-LoadEventNexus` algorithm is called with default
parameters to load into an `EventWorkspace <http://www.mantidproject.org/EventWorkspace>`_. parameters to load into an `EventWorkspace <http://www.mantidproject.org/EventWorkspace>`_.
...@@ -26,4 +26,5 @@ Usage ...@@ -26,4 +26,5 @@ Usage
Used internaly. See examples of :ref:`algm-LoadEventNexus` and :ref:`algm-ConvertToDiffractionMDWorkspace` algorithms Used internaly. See examples of :ref:`algm-LoadEventNexus` and :ref:`algm-ConvertToDiffractionMDWorkspace` algorithms
for the details of the usage of these algorithms for the details of the usage of these algorithms
.. categories:: .. categories::
...@@ -21,6 +21,12 @@ position. Note that this algorithm moves the detectors without ...@@ -21,6 +21,12 @@ position. Note that this algorithm moves the detectors without
subsequent rotation, hence this means that detectors may not for example subsequent rotation, hence this means that detectors may not for example
face the sample perfectly after this algorithm has been applied. face the sample perfectly after this algorithm has been applied.
Related or similar algorithms
##############################
See :ref:`algm-LoadDetectorInfo` which can do similar job modifying the detector parameters and positions and working with special format ASCII files or ISIS raw or special nexus files.
Additional Detector Parameters Using ASCII File Additional Detector Parameters Using ASCII File
############################################### ###############################################
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment