RemoveLogs v1

../_images/RemoveLogs-v1_dlg.png

RemoveLogs dialog.

Summary

Remove logs from a workspace.

Properties

Name Direction Type Default Description
Workspace InOut MatrixWorkspace Mandatory The name of the workspace to which the log data will be removed
KeepLogs Input str list   List(comma separated) of logs to be kept

Description

Removes all logs from workspace, except those that are specified

Usage

# create some workspace with an instrument
ws = CreateSampleWorkspace()
print "Original logs: ", ws.run().keys()

# remove logs, but keep some
RemoveLogs(ws,KeepLogs="run_start, run_title")
print "Logs left: ", ws.run().keys()

# delete all logs
RemoveLogs(ws)
print "Logs left (should be empty): ", ws.run().keys()

Output:

Original logs:  ['run_title', 'start_time', 'end_time', 'run_start', 'run_end']
Logs left:  ['run_title', 'run_start']
Logs left (should be empty):  []

Categories: Algorithms | DataHandling\Logs

Source

C++ source: RemoveLogs.cpp

C++ header: RemoveLogs.h