\(\renewcommand\AA{\unicode{x212B}}\)

ExtractMonitorWorkspace v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Retrieves a workspace of monitor data held within the input workspace, if present.

See Also

ExtractMonitors

Properties

Name	Direction	Type	Default	Description
InputWorkspace	Input	MatrixWorkspace	Mandatory	A data workspace that holds a monitor workspace within.
MonitorWorkspace	Output	MatrixWorkspace	Mandatory	The workspace containing only monitor data relating to the main data in the InputWorkspace.
ClearFromInputWorkspace	Input	boolean	True	Whether to hold onto the monitor workspace within the input workspace. The default is not to, but if you are running this algorithm in the post-processing step of a live data run then you will need this to be false.

Description

This algorithm looks for an internally-stored monitor workspace on the input workspace and sets it as the output workspace if found. The input workspace will no longer hold a reference to the monitor workspace after this algorithm has been run on it. If no monitor workspace is present the algorithm will fail.

This does not extract monitor data that is stored with the detector data in the workspace.

Usage

Example: Extracting an internally stored monitor workspace

#If no monitor workspace is present the algorithm will fail.
wsMonitor = ExtractMonitorWorkspace(ws)

Categories: AlgorithmIndex | Utility\Workspaces

Source

C++ header: ExtractMonitorWorkspace.h

C++ source: ExtractMonitorWorkspace.cpp