4.2

ConvertEmptyToTof v1

../_images/ConvertEmptyToTof-v1_dlg.png

ConvertEmptyToTof dialog.

Table of Contents

Warning

ConvertEmptyToTof is deprecated and has no replacement.

Summary

Converts the channel number to time of flight.

Properties

Name Direction Type Default Description
InputWorkspace Input Workspace2D Mandatory Name of the input workspace
OutputWorkspace Output MatrixWorkspace Mandatory Name of the output workspace, can be the same as the input
ListOfSpectraIndices Input int list   A list of spectra workspace indices as a string with ranges; e.g. 5-10,15,20-23. Optional: if not specified, then the Start/EndIndex fields are used alone. If specified, the range and the list are combined (without duplicating indices). For example, a range of 10 to 20 and a list ‘12,15,26,28’ gives ‘10-20,26,28’.
ListOfChannelIndices Input int list   A list of spectra indices as a string with ranges; e.g. 5-10,15,20-23. Optional: if not specified, then the Start/EndIndex fields are used alone. If specified, the range and the list are combined (without duplicating indices). For example, a range of 10 to 20 and a list ‘12,15,26,28’ gives ‘10-20,26,28’.
ElasticPeakPosition Input number Optional Value of elastic peak position if none of the above are filled in.
ElasticPeakPositionSpectrum Input number Optional Workspace Index used for elastic peak position above.

Description

Only for ILL usage. In the future, ILL plans to load data in raw format (no units used). The X-axis represent the time channel number. This algorithm converts the channel number to time of flight using the distances source-sample-detectors defined in the IDF. In addition, the user has to input the fields:

  • ListOfSpectraIndices - Spectrum or list of spectra to look for the elastic peak. Note that the spectra chosen must be at the same distance.
  • ListOfChannelIndices - Elastic peak channels - For the selected spetra above, the list/range of channels to look for the elastic peak (e.g. range).

Note that the Input Workspace must have the following properties:

  • wavelength
  • channel_width

Instead of using the fields above (ListOfSpectraIndices and ListOfChannelIndices), the user can specify the Elastic Peak Position (channel number) and the respective spectrum, using the following fields:

  • ElasticPeakPosition
  • ElasticPeakPositionSpectrum

Categories: AlgorithmIndex | Transforms\Units | Deprecated

Source

C++ source: ConvertEmptyToTof.cpp (last modified: 2019-06-04)

C++ header: ConvertEmptyToTof.h (last modified: 2018-10-05)