PolarizationEfficiencyCor dialog.
Table of Contents
Corrects a group of polarization analysis workspaces for polarizer and analyzer efficiencies.
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| InputWorkspaces | Input | str list | A list of names of workspaces to be corrected. | |
| InputWorkspaceGroup | Input | WorkspaceGroup | A group of workspaces to be corrected. | |
| CorrectionMethod | Input | string | Wildes | Correction method. Allowed values: [‘Wildes’, ‘Fredrikze’] |
| Efficiencies | Input | MatrixWorkspace | Mandatory | A workspace containing the efficiency factors as histograms: P1, P2, F1 and F2 in the Wildes method and Pp, Ap, Rho and Alpha for Fredrikze. |
| Flippers | Input | string | Flipper configurations of the input workspaces (Wildes method only). Allowed values: [‘’, ‘00, 01, 10, 11’, ‘00, 10, 11’, ‘00, 01, 11’, ‘00, 11’, ‘0, 1’, ‘0’] | |
| PolarizationAnalysis | Input | string | What Polarization mode will be used? PNR: Polarized Neutron Reflectivity mode PA: Full Polarization Analysis PNR-PA (Fredrikze method only). Allowed values: [‘’, ‘PA’, ‘PNR’] | |
| OutputWorkspace | Output | WorkspaceGroup | Mandatory | A group of polarization efficiency corrected workspaces. |
This is a wrapper around the algorithms PolarizationCorrectionWildes v1 and PolarizationCorrectionFredrikze v1. Use CorrectionMethod property to select between the two. The default is Wildes.
The input workspaces can be passed in either via InputWorkspaces or InputWorkspaceGroup property but not both. An attempt to set both properties will result in an error.
The default values for the Flippers and PolarizationAnalysis properties are empty strings and correspond to the actual defaults of the child algorithms: 00, 01, 10, 11 for Wildes and PA for Fredrikze.
Categories: AlgorithmIndex | Reflectometry
C++ source: PolarizationEfficiencyCor.cpp (last modified: 2019-06-04)
C++ header: PolarizationEfficiencyCor.h (last modified: 2018-10-05)