6.0

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

RefRoi v1

../_images/RefRoi-v1_dlg.png

RefRoi dialog.

Table of Contents

Summary

Workflow algorithm for reflectometry to sum up a region of interest on a 2D detector.

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory Workspace to calculate the ROI from
OutputWorkspace Output MatrixWorkspace Mandatory Workspace containing the summed up region of interest
NXPixel Input number 304 Number of pixels in the X direction
NYPixel Input number 256 Number of pixels in the Y direction
XPixelMin Input number Optional Lower bound of ROI in X
XPixelMax Input number Optional Upper bound of ROI in X
YPixelMin Input number Optional Lower bound of ROI in Y
YPixelMax Input number Optional Upper bound of ROI in Y
SumPixels Input boolean False If true, all the pixels will be summed, so that the resulting workspace will be a single histogram
NormalizeSum Input boolean False If true, and SumPixels is true, the resulting histogram will be divided by the number of pixels in the ROI
AverageOverIntegratedAxis Input boolean False If true, and SumPixels and NormalizeSum are true, the resulting histogram will also be divided by the number of pixels integrated over
ErrorWeighting Input boolean False If true, error weighting will be used when normalizing
IntegrateY Input boolean True If true, the Y direction will be considered the low-resolution direction and will be integrated over. If false, the X direction will be integrated over. The result will be a histogram for each of the pixels in the hi-resolution direction of the 2D detector
ConvertToQ Input boolean True If true, the X-axis will be converted to momentum transfer
ScatteringAngle Input number 0 Value of the scattering angle to use when converting to Q

Source

C++ header: RefRoi.h (last modified: 2020-06-22)

C++ source: RefRoi.cpp (last modified: 2020-06-22)

Python: RefRoi.py (last modified: 2020-10-08)