\(\renewcommand\AA{\unicode{x212B}}\)
LoadNGEM v1¶
Summary¶
Load a file or range of files created by the nGEM detector into a workspace.
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
Filename |
Input |
list of str lists |
Mandatory |
The name of the nGEM file to load. Selecting multiple files will combine them into one workspace. Allowed extensions: [‘.edb’] |
OutputWorkspace |
Output |
Mandatory |
The output workspace |
|
BinWidth |
Input |
number |
10 |
The width of the time bins in the output. |
MinEventsPerFrame |
Input |
number |
0 |
The minimum number of events required in a frame before a it is considered ‘good’. |
MaxEventsPerFrame |
Input |
number |
Optional |
The maximum number of events allowed in a frame to be considered ‘good’. |
GenerateEventsPerFrame |
Input |
boolean |
False |
Generate a workspace to show the number of events captured by each frame. (optional, default False). |
Description¶
The LoadNGEM algorithm will read .edb files generated by the nGEM detector.
The detector produces files that are up to 1GB in size, so if the collection produces more than 1GB of data, it will create a new file to write the rest of the data to. When all of the files are selected they are loaded into a single workspace containing all of the events.
The loading process allows the option to include a count of the number of events in each frame (begun by a T0 event), which is loaded as a plottable workspace. This can then be used to determine what is considered a “good frame” so that only good frames are included in the final data.
Child Algorithms used¶
The ChildAlgorithms used by LoadNGEM are:
AddSampleLog v1 - Adds data to the Sample Log of the workspace
LoadInstrument v1 - Loads the instrument associated with the data
Categories: AlgorithmIndex | DataHandling\NGEM
Source¶
C++ header: LoadNGEM.h
C++ source: LoadNGEM.cpp