Skip to content

Commit

Permalink
more info on ParentWorkspace, re #10587
Browse files Browse the repository at this point in the history
  • Loading branch information
FedeMPouzols committed Jun 3, 2015
1 parent dcc8329 commit ae07929
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions Code/Mantid/docs/source/algorithms/CreateWorkspace-v1.rst
Expand Up @@ -9,12 +9,21 @@
Description
-----------

This algorithm constructs a MatrixWorkspace when passed a vector for each
of the X, Y, and E data values. The unit for the X Axis can optionally be
specified as any of the units in the Kernel's UnitFactory. Multiple spectra
may be created by supplying the NSpec Property (integer, default 1). When
this is provided the vectors are split into equal-sized spectra (all X, Y,
E values must still be in a single vector for input).
This algorithm constructs a :ref:`MatrixWorkspace <MatrixWorkspace>`
when passed a vector for each of the X, Y, and E data values. The unit
for the X Axis can optionally be specified as any of the units in the
Mantid `Unit Factory <http://www.mantidproject.org/Units>`__ (see `the
list of units currently available
<http://www.mantidproject.org/Units>`__). Multiple spectra may be
created by supplying the NSpec Property (integer, default 1). When
this is provided the vectors are split into equal-sized spectra (all
X, Y, E values must still be in a single vector for input).

When you use the input property ParentWorkspace, the new workspace is
created with the same instrument (including its parameters), sample
and run information, and comment field as the parent. The Y units and
title are also copied from the parent workspace unless they are
provided in the input properties passed to the algorithm.

Usage
-----
Expand Down

0 comments on commit ae07929

Please sign in to comment.