RunPythonScript v1

../_images/RunPythonScript-v1_dlg.png

RunPythonScript dialog.

Summary

Executes a snippet of Python code

Properties

Name Direction Type Default Description
InputWorkspace Input Workspace   An input workspace that the python code will modify.The workspace will be in the python variable named ‘input’.
Code Input string Mandatory Python code (can be on multiple lines).
OutputWorkspace Output Workspace   An output workspace to be produced by the python code.The workspace will be in the python variable named ‘output’.

Description

Algorithm that will run a snippet of python code. This is meant to be used by LoadLiveData v1 to perform some processing.

The input & output workspaces can be accessed from the Python code using the variable names ‘input’ & ‘output’ respectively.

Within your code “input” is an actual reference to the input workspace, while “output” is a string of the output workspace name. You are expected to create the output workspace yourself.

Usage

Example - Summing all the counts in a workspace

ws = CreateSampleWorkspace("Histogram","Multiple Peaks")

script = """
logger.notice('Logging from within the python script!')
wsOut = Integration(input,OutputWorkspace=output)
wsOut = SumSpectra(wsOut)
"""

RunPythonScript(script,ws,"wsOut")

wsOut = mtd["wsOut"]
print "The workspace contained a total of %i counts" % wsOut.readY(0)[0]

Output:

The workspace contained a total of 9599 counts

Categories: Algorithms | DataHandling\LiveData\Support