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

SavePDFGui v1¶

../_images/ImageNotFound.png — Enable screenshots using DOCS_SCREENSHOTS in CMake¶

Summary ¶

Save files readable by PDFGui

Properties ¶

Name	Direction	Type	Default	Description
InputWorkspace	Input	MatrixWorkspace	Mandatory	An input workspace with units of Atomic Distance.
Filename	Input	string	Mandatory	The filename to use for the saved data. Allowed extensions: [‘.gr’]

Description ¶

This algorithm saves G(r) files consistent with PDFGui. The body of the file is of the form r Gr dr dGr.

Usage ¶

Example - SavePDFGui

# Create a host workspace
ws = CreateWorkspace(DataX=range(0,3), DataY=range(0,3), UnitX="Angstrom")

# Create a filename
import os
path = os.path.join(os.path.expanduser("~"), "savepdfgui.gr")

# Save as G(r) file
SavePDFGui(ws, path)

# Check that the file exists
print(os.path.isfile(path))