SaveANSTOAscii v1

../_images/SaveANSTOAscii-v1_dlg.png

SaveANSTOAscii dialog.

Warning

SaveANSTOAscii is deprecated (on 2018-06-29). Use SaveReflectometryAscii instead.

Summary

Saves a 2D workspace to a ascii file.

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory The name of the workspace containing the data you want to save.
Filename Input string Mandatory The filename of the output file. Allowed extensions: [‘.txt’]
Separator Input string tab The separator used for splitting data columns. Allowed values: [‘comma’, ‘space’, ‘tab’]

Description

SaveANSTOAscii is an export-only Ascii-based save format with no associated loader. It is based on a python script by Maximilian Skoda, written for the ISIS Reflectometry GUI.

Limitations

While Files saved with SaveANSTOAscii can be loaded back into mantid using LoadAscii, the resulting workspaces won’t be useful as the data written by SaveANSTOAscii is not in the normal X,Y,E,DX format.

Usage

Example - Save a Workspace in ANSTO ASCII format

#import the os path libraries for directory functions
import os

# create histogram workspace
dataX1 = [0,1,2,3,4,5,6,7,8,9] # or use dataX1=range(0,10)
dataY1 = [0,1,2,3,4,5,6,7,8] # or use dataY1=range(0,9)
dataE1 = [1,1,1,1,1,1,1,1,1] # or use dataE1=[1]*9

ws1 = CreateWorkspace(dataX1, dataY1, dataE1)

#Create an absolute path by joining the proposed filename to a directory
#os.path.expanduser("~") used in this case returns the home directory of the current user
savefile = os.path.join(os.path.expanduser("~"), "ANSTOAsciiFile.txt")

# perform the algorithm
SaveANSTOAscii(InputWorkspace=ws1,Filename=savefile)

print("File Exists: {}".format(os.path.exists(savefile)))

Output:

File Exists: True

Categories: AlgorithmIndex | DataHandling\Text | Deprecated

Source

C++ source: SaveANSTOAscii.cpp (last modified: 2018-10-05)

C++ header: SaveANSTOAscii.h (last modified: 2018-10-05)