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

SavePAR v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Writes the detector geometry information of a workspace into a Tobyfit PAR format file.

See Also

SaveSPE

Properties

Name	Direction	Type	Default	Description
InputWorkspace	Input	MatrixWorkspace	Mandatory	The name of the workspace to save.
Filename	Input	string	Mandatory	The name to give to the saved file.

Description

Saves the geometry information of the detectors in a workspace into a PAR format ASCII file. The angular positions and linear sizes of the detectors are calculated using FindDetectorsPar v1 algorithm.

Tobyfit PAR file is an ASCII file consisting of the header and 5 or 6 text columns. Mantid generates 6-column files. Header contains the number of the rows in the phx file excluding the header (number of detectors). The column has the following information about a detector:

Column Number	Column Description
1st	sample-detector distance (secondary flight path)
2nd	scattering angle (deg)
3rd	azimuthal angle (deg) (west bank = 0 deg, north bank = -90 deg etc.) Note the reversed sign convention wrt the .phx files. For details, see: SavePHX v1
4th	width (m)
5th	height (m)
6th	detector ID   – this is Mantid specific value, which may not hold similar meaning in files written by different applications.

You should expect to find column 6 to be the detector ID in Mantid-generated par files only.

Usage

Example - Save PAR file

# import os functions to work with folders
import os
# create sample workspace
ws = CreateSampleWorkspace()
# test file name
file_name = os.path.join(config["defaultsave.directory"], "TestSavePar.par")
# save the file
SavePAR(ws,Filename=file_name);

print("target file exists? {0}".format(os.path.exists(file_name)))

Output:

target file exists? True

Categories: AlgorithmIndex | DataHandling\SPE | Inelastic\DataHandling

Source

C++ header: SavePAR.h

C++ source: SavePAR.cpp