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

DiffractionFocussing v1

Warning

DiffractionFocussing is deprecated. Use DiffractionFocussing version 2 instead.

Summary

Algorithm to focus powder diffraction data into a number of histograms according to a grouping scheme defined in a CalFile.

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

The input workspace

OutputWorkspace

Output

MatrixWorkspace

Mandatory

The result of diffraction focussing of InputWorkspace

GroupingFileName

Input

string

Mandatory

The name of the CalFile with grouping data. Allowed extensions: [‘.cal’]

Description

Example of RAW GEM data focused across the 5 detector banks Given an InputWorkspace and a Grouping filename, the algorithm performs the following:

  1. The calibration file is read and a map of corresponding udet-group is created.

  2. The algorithm determine the X boundaries for each group as the upper and lower limits of all contributing detectors to this group and determine a logarithmic step that will ensure preserving the number of bins in the initial workspace.

  3. All histograms are read and rebinned to the new grid for their group.

  4. A new workspace with N histograms is created.

Within the CalFile any detectors with the ‘select’ flag can be set to zero or with a group number of 0 or -ve groups are not included in the analysis.

Since the new X boundaries depend on the group and not the entire workspace, this focusing algorithm does not create overestimated X ranges for multi-group instruments. However it is important to remember that this means that this algorithm outputs a ragged workspace. Some 2D and 3D plots will not display the data correctly.

The DiffractionFocussing algorithm uses GroupDetectors algorithm to combine data from several spectra according to GroupingFileName file which is a CalFile.

For EventWorkspaces

The algorithm can be used with an EventWorkspace input, and will create an EventWorkspace output if a different workspace is specified.

The main difference vs. using a Workspace2D is that the event lists from all the incoming pixels are simply appended in the grouped spectra; this means that you can rebin the resulting spectra to finer bins with no loss of data. In fact, it is unnecessary to bin your incoming data at all; binning can be performed as the very last step.

Categories: AlgorithmIndex | Diffraction\Focussing | Deprecated

Source

C++ header: DiffractionFocussing.h

C++ source: DiffractionFocussing.cpp