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

SANSSave v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Performs saving of reduced SANS data.

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

The workspace which is to be saved. This workspace needs to be the result of a SANS reduction, i.e. it can only be 1D or 2D if the second axis is numeric.

Filename

Input

string

Mandatory

The name of the file which needs to be stored. Note that the actual file type is selected below.

Transmission

Input

MatrixWorkspace

The sample transmission workspace. Optional.

TransmissionCan

Input

MatrixWorkspace

The can transmission workspace. Optional.

Nexus

Input

boolean

False

Save as nexus format. Note that if file formats of the same type, e.g. .xml are chosen, then the file format is appended to the file name.

CanSAS

Input

boolean

False

Save as CanSAS xml format.Note that if file formats of the same type, e.g. .xml are chosen, then the file format is appended to the file name.

NXcanSAS

Input

boolean

False

Save as NXcanSAS format.Note that if file formats of the same type, e.g. .xml are chosen, then the file format is appended to the file name.

NistQxy

Input

boolean

False

Save as Nist Qxy format.Note that if file formats of the same type, e.g. .xml are chosen, then the file format is appended to the file name.

RKH

Input

boolean

False

Save as RKH format.Note that if file formats of the same type, e.g. .xml are chosen, then the file format is appended to the file name.

CSV

Input

boolean

False

Save as CSV format.Note that if file formats of the same type, e.g. .xml are chosen, then the file format is appended to the file name.

UseZeroErrorFree

Input

boolean

True

This allows the user to artificially inflate zero error values.

SampleTransmissionRunNumber

Input

string

The run number for the Sample Transmission workspace used in the reduction. Can be blank.

SampleDirectRunNumber

Input

string

The run number for the Sample Direct workspace used in the reduction. Can be blank.

CanScatterRunNumber

Input

string

The run number for the Can Scatter workspace used in the reduction. Can be blank.

CanDirectRunNumber

Input

string

The run number for the Can Direct workspace used in the reduction. Can be blank.

Description

This algorithm saves a reduced SANS workspace in a variety of specified formats. The supported file formats are:

  • Nexus (1D/2D)

  • CanSAS (1D)

  • NXcanSAS (1D/2D)

  • NistQxy (2D)

  • RKH (1D/2D)

  • CSV (1D)

Note that using the UseZeroErrorFree will result in outputs where the error is inflated if it had been 0. This ensures that the particular data point with vanishing error has no significance when used during fitting.

Categories: AlgorithmIndex | SANS\Save

Source

Python: SANSSave.py