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

LoadBBY v1¶

LoadBBY dialog.

Table of Contents

Summary ¶

Loads a Bilby data file into a workspace.

Name	Direction	Type	Default	Description
Filename	Input	string	Mandatory	The input filename of the stored data. Allowed extensions: [‘.tar’]
Mask	Input	string		The input filename of the mask data. Allowed extensions: [‘.xml’]
OutputWorkspace	Output	IEventWorkspace	Mandatory
FilterByTofMin	Input	number	0	Optional: To exclude events that do not fall within a range of times-of-flight. This is the minimum accepted value in microseconds. Keep blank to load all events.
FilterByTofMax	Input	number	Optional	Optional: To exclude events that do not fall within a range of times-of-flight. This is the maximum accepted value in microseconds. Keep blank to load all events.
FilterByTimeStart	Input	number	0	Optional: To only include events after the provided start time, in seconds (relative to the start of the run).
FilterByTimeStop	Input	number	Optional	Optional: To only include events before the provided stop time, in seconds (relative to the start of the run).

Load data from the Bilby beamline at ANSTO. The workspace generated is a TOF EventWorkspace.

Categories: AlgorithmIndex | DataHandling\ANSTO

C++ header: LoadBBY.h

C++ source: LoadBBY.cpp

Note

To run these usage examples please first download the usage data, and add these to your path. In Mantid this is done using Manage User Directories.

Example - Load a Bilby dataset:

ws = LoadBBY('BBY0000014.tar');

print("Number of spectra: {}".format(ws.getNumberHistograms()))

Output:

Number of spectra: 61440