Matrix Workspace¶

What information is in a MatrixWorkspace¶

Mandatory:

• Measured or derived data with associated errors

Optionally:

• Axes with Units
• Sample and sample environment data
• Run logs
• A full instrument geometric definition, along with an instrument parameter map
• A spectra - detector map
• A distribution flag
• A list of ‘masked’ bins

Documentation on the CreateWorkspace algorithm may also be useful.

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.

More information on working with them: Interacting with Matrix Workspaces.

Category: Concepts