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

RemoveLogs v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Remove logs from a workspace.

See Also

RenameLog, DeleteLog

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:  {}".format(ws.run().keys()))

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

# delete all logs
RemoveLogs(ws)
print("Logs left (should be empty):  {}".format(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: AlgorithmIndex | DataHandling\Logs

Source

C++ header: RemoveLogs.h

C++ source: RemoveLogs.cpp