3.6

Workspace2D

The Workspace2D is a Mantid data type for a MatrixWorkspace.

It consists of a workspace with 1 or more spectra. Typically, each spectrum will be a histogram. For example, you might have 10 bins, and so have 11 X-value, 10 Y-values and 10 E-values in a workspace.

In contrast to an EventWorkspace, a Workspace2D only contains bin information and does not contain the underlying event data. The EventWorkspace presents itself as a histogram (with X,Y,E values) but preserves the underlying event data.

For more information on what a Workspace2D contains, see MatrixWorkspace.

Working with Workspace2Ds in Python

Workspace2D is a MatrixWorkspace and does not offer any functionality above that of a Matrix Workspace.

Accessing Workspaces

The methods for getting a variable to an EventWorkspace is the same as shown in the Workspace help page.

If you want to check if a variable points to something that is a Workspace2D you can use this:

histoWS = CreateSampleWorkspace()

if histoWS.id() == "Workspace2D":
    print histoWS.getName() + " is an " + histoWS.id()

Output:

histoWS is an Workspace2D

Other Information on Workspaces

  • Workspace - Overview of workspaces, which include the following classes:
    • MatrixWorkspace - A base class that contains among others:
      • WorkspaceSingleValue - Holds a single number (and X & error value, if desired). Mainly used for workspace algebra, e.g. to divide all bins in a 2D workspace by a single value.
      • Workspace2D - A workspace for holding two dimensional data in memory, this is the most commonly used workspace.
      • EventWorkspace - A workspace that retains the individual neutron event data.
    • TableWorkspace - A workspace holding data in rows of columns having a particular type (e.g. text, integer, ...).
    • WorkspaceGroup - A container for a collection of workspaces. Algorithms given a group as input run sequentially on each member of the group.

Category: Concepts