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

LoadPLN v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Loads a PLN Hdf and linked event file into a workspace.

See Also

Load, LoadEMU

Properties

Name

Direction

Type

Default

Description

Filename

Input

string

Mandatory

The input filename of the stored data. Allowed extensions: [‘.hdf’]

BinaryEventPath

Input

string

./

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).

Description

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

Usage

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 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

Source

C++ header: LoadPLN.h

C++ source: LoadPLN.cpp