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

EQSANSPatchSensitivity v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Patch EQSANS sensitivity correction.

Properties

Name

Direction

Type

Default

Description

Workspace

InOut

MatrixWorkspace

Mandatory

Input sensitivity workspace to be patched

PatchWorkspace

Input

MatrixWorkspace

Mandatory

Workspace defining the patch. Masked detectors will be patched.

UseLinearRegression

Input

boolean

True

If true, a linear regression will be used instead of computing the average

OutputMessage

Output

string

Description

Process a detector sensitivity workspace and patch the area defined by the masked pixels in the provided PatchWorkspace.

This algorithm is usually set up by ComputeSensitivity and executed by SANSSensitivityCorrection.

The InputWorkspace is a pre-calculated sensitivity workspace, usually computed using the SANSSensitivityCorrection algorithm. The PatchWorkspace is a workspace where the pixels to patch are marked as masked. The actual data of the PatchWorkspace is not used, only the masking information.

We consider each tube of the detector of the InputWorkspace. For each masked pixel along a given tube, that pixel’s sensitivity (Y-value) is set to:

  • [If UseLinearRegression=False] The average of the sensitivity of all the unmasked pixels along the same tube.

  • [If UseLinearRegression=True] The value found for that position along the tube by a linear regression performed using all unmasked pixels along that tube.

The output workspace is the patched version of the input workspace.

Categories: AlgorithmIndex | Workflow\SANS

Source

C++ header: EQSANSPatchSensitivity.h

C++ source: EQSANSPatchSensitivity.cpp