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

LoadErrorEventsNexus v1

Summary

Load error events from NeXus file

See Also

LoadEventNexus

Properties

Name

Direction

Type

Default

Description

Filename

Input

string

Mandatory

The name of the Event NeXus file to read, including its full or relative path. Allowed extensions: [‘.nxs.h5’, ‘.nxs’, ‘_event.nxs’]

OutputWorkspace

Output

EventWorkspace

Mandatory

An output workspace.

Description

Load the events from the bank_error_events entry in the NeXus file. All events will be loaded, regardless of detector ID, into a single event spectrum.

Usage

Example - LoadErrorEventsNexus

ws = LoadErrorEventsNexus("REF_L_183110.nxs.h5")
print(f"The output workspace has {ws.getNumberEvents()} events in {ws.getNumberHistograms()} spectra")

Output:

The output workspace has 82980 events in 1 spectra

Categories: AlgorithmIndex | DataHandling\Nexus

Source

C++ header: LoadErrorEventsNexus.h

C++ source: LoadErrorEventsNexus.cpp