Skip to content

Commit

Permalink
refs #9581 Usage for OneStepMDEW
Browse files Browse the repository at this point in the history
  • Loading branch information
abuts committed Jun 19, 2014
1 parent dd0022c commit 63ad8c4
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst
Expand Up @@ -11,15 +11,19 @@ Description

This algorithm is used in the Paraview event nexus loader to both load
an event nexus file and convert it into a
`MDEventWorkspace <MDEventWorkspace>`__ for use in visualization.
`MDEventWorkspace <MDEventWorkspace>`_ for use in visualization.

The :ref:`algm-LoadEventNexus` algorithm is called with default
parameters to load into an `EventWorkspace <EventWorkspace>`__.
parameters to load data into an `EventWorkspace <EventWorkspace>`_.

After, the
`MakeDiffractionMDEventWorkspace <MakeDiffractionMDEventWorkspace>`__
algorithm is called with the new EventWorkspace as input. The parameters
are set to convert to Q in the lab frame, with Lorentz correction, and
default size/splitting behavior parameters.
After, that, :ref:`algm-ConvertToDiffractionMDWorkspace` algorithm is called with the new
EventWorkspace as input. The parameters are set to convert to **Q** in the lab frame,
with Lorentz correction, and default size/splitting behavior parameters.

Usage
-----

Used internaly. See examples of :ref:`algm-LoadEventNexus` and :ref:`algm-ConvertToDiffractionMDWorkspace` algorithms
for the details of the usage of these algorithms

.. categories::

0 comments on commit 63ad8c4

Please sign in to comment.