LoadPLN dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| Filename | Input | string | Mandatory | The input filename of the stored data. Allowed extensions: [‘.hdf’] |
| BinaryEventPath | Input | string | Mandatory | Relative or absolute path to the compressed binary event file linked to the HDF file, eg /storage/data/ |
| Mask | Input | string | The input filename of the mask data. Allowed extensions: [‘.xml’] | |
| SelectDetectorTubes | Input | string | Comma separated range of detectors tubes to be loaded, eg 16,19-45,47 | |
| OutputWorkspace | Output | IEventWorkspace | Mandatory | |
| SelectDataset | Input | number | 0 | Select the index for the dataset to be loaded. |
| TimeOfFlightBias | Input | number | 0 | Time of flight correction in micro-sec. |
| CalibrateTOFBias | Input | boolean | False | Calibrate the TOF correction from the elastic pulse. |
| LambdaOnTwoMode | Input | boolean | False | Instrument is operating in Lambda on Two mode. |
| FilterByTimeStart | Input | number | 0 | Only include events after the provided start time, in seconds (relative to the start of the run). |
| FilterByTimeStop | Input | number | Optional | Only include events before the provided stop time, in seconds (relative to the start of the run). |
Load data from the Pelican beamline at ANSTO. The workspace generated is a TOF EventWorkspace.
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 Pelican dataset:
ws = LoadPLN('PLN0044464.hdf', BinaryEventPath='./PLN0044464.bin')
print("Number of spectra: {}".format(ws.getNumberHistograms()))
Output:
Number of spectra: 12808
Categories: AlgorithmIndex | DataHandling\ANSTO
C++ source: LoadPLN.cpp (last modified: 2019-08-06)
C++ header: LoadPLN.h (last modified: 2019-02-06)