LoadBBY v1

../_images/LoadBBY-v1_dlg.png

LoadBBY dialog.

Summary

Loads a BilBy data file into an workspace.

Properties

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 Optional 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).
PeriodMaster Input number Optional Optional
PeriodSlave Input number Optional Optional
PhaseSlave Input number Optional Optional

Description

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

Categories: Algorithms | DataHandling\Nexus

Source

C++ source: LoadBBY.cpp

C++ header: LoadBBY.h

Usage

Note

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

Example - Load a Bilby dataset:

ws = LoadBBY('BBY0000014.tar');

print "Number of spectra:", ws.getNumberHistograms()

Output:

Number of spectra: 61440