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

SaveRMCProfile v1

../_images/SaveRMCProfile-v1_dlg.png

SaveRMCProfile dialog.

Summary

Save files readable by RMCProfile

See Also

SaveRMCProfile

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

An input workspace to be saved.

InputType

Input

string

To identify what input function is being used.

Title

Input

string

The title line for the output file.

Filename

Input

string

Mandatory

The filename to use for the saved data. Allowed extensions: [‘.fq’]

Description

This algorithm saves files consistent with RMCProfile. The header of the file contains the number of data points in the file, the function type, and a title for the data. The body of the file is of the form x y.

Usage

Example - SaveRMCProfile

# 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("~"), "SaveRMCProfile.fq")

# Save as G(r) file
SaveRMCProfile(InputWorkspace=ws, InputType="G(r)", Title="Data_title", Filename=path)

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

Output:

True

Categories: AlgorithmIndex | DataHandling\Text

Source

C++ header: SaveRMCProfile.h

C++ source: SaveRMCProfile.cpp