6.0

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

DeleteLog v1

../_images/DeleteLog-v1_dlg.png

DeleteLog dialog.

Summary

Removes a named log from a run

Properties

Name Direction Type Default Description
Workspace InOut MatrixWorkspace Mandatory In/out workspace containing the logs. The workspace is modified in place
Name Input string Mandatory  

Description

Removes a named log from the run attached to the input workspace. If the log does not exist then the algorithm simply emits a warning and does not fail.

Usage

Example - Deleting a log

# Create a host workspace
demo_ws = CreateWorkspace(DataX=range(0,3), DataY=(0,2))

# Add  a sample log
AddSampleLog(Workspace=demo_ws, LogName='my_log', LogText='1', LogType='Number')
print('Log is present before deletion: {}'.format(demo_ws.getRun().hasProperty('my_log')))

# Now delete it
DeleteLog(demo_ws,'my_log')
print('Log is present after deletion: {}'.format(demo_ws.getRun().hasProperty('my_log')))

Output:

Log is present before deletion: True
Log is present after deletion: False

Categories: AlgorithmIndex | DataHandling\Logs

Source

C++ header: DeleteLog.h (last modified: 2020-03-20)

C++ source: DeleteLog.cpp (last modified: 2020-04-07)