Skip to content

Commit

Permalink
Added ragged workspace as concept Re #11810
Browse files Browse the repository at this point in the history
  • Loading branch information
Lottie Greenwood committed Jun 21, 2016
1 parent c68d794 commit c96a4f1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/algorithms/SaveAscii-v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Limitations
###########

The algorithm assumes that the workspace has common X values for all spectra
(i.e. is not a `ragged workspace <http://www.mantidproject.org/Ragged_Workspace>`__).
(i.e. is not a :ref:`ragged workspace <Ragged_Workspace>` )

Usage
-----
Expand Down
16 changes: 16 additions & 0 deletions docs/source/concepts/Ragged_Workspace.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _Ragged_Workspace:

Ragged Workspace
=================

What are they?
--------------

A ragged workspace is one where the spectra within it do not share a common set of x values. Ragged workspaces commonly occur after Converting the X units using ConvertUnits or after DiffractionFocussing.

Displaying the ragged data using 1D line plots or 2D colour or contour plots is fine, but the data will display incorrectly when using 3D plots. The instrument view is unaffected as it displays integrated data.

Many algorithms cannot operate on Ragged Workspaces, either due to logical or implementation restrictions. If you encounter these problems you may wish to run a Rebin algorithm first to map the data to a regular datagrid of X values.


.. categories:: Concepts

0 comments on commit c96a4f1

Please sign in to comment.