ReadGroupsFromFile
From MantidProject
Contents |
Summary
Read a diffraction calibration file (*.cal) and an instrument name, and output a 2D workspace containing on the Y-axis the values of the Group each detector belongs to.
This is used to visualise the grouping scheme for powder diffractometers, where a large number of detectors are grouped together. The output 2D workspace can be visualize using the show instrument method.
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | InstrumentName | Input | String | Mandatory | The name of the instrument. This needs to be have been loaded during this Mantid session either by loading a dataset from that instrument or calling LoadEmptyInstrument. |
| 2 | GroupingFilename | Input | File (.cal extension) | Mandatory | The CalFile containing the grouping you want to visualize. |
| 3 | ShowUnselected | Input | Boolean | True | Whether to show detectors that are not in any group |
| 4 | OutputWorkspace | Output | Workspace | Mandatory | The name of the output workspace |
Description
All of the detectors in each group are given the a value equal to that of the group number. Unselected detectors are given a value of 0 if ShowUnselected is true.
The instrumentView is the best way to visualize the grouping using the "show Instrument" context menu option on the output workspace.
Source Code
Header ReadGroupsFromFile.h
Source ReadGroupsFromFile.cpp
