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

PolarizationEfficiencyCor v1

Summary

Corrects a group of polarization analysis workspaces for polarizer and analyzer efficiencies.

See Also

PolarizationCorrectionWildes, PolarizationCorrectionFredrikze

Properties

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’]

SpinStatesOutWildes

Input

string

The order of the spin states in the output workspace. (Wildes method only).

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’]

SpinStatesInFredrikze

Input

string

The order of spin states in the input workspace group. The possible values are ‘pp,pa,ap,aa’ or ‘p,a’. (Fredrikze method only).

SpinStatesOutFredrikze

Input

string

The order of spin states in the output workspace group. The possible values are ‘pp,pa,ap,aa’ or ‘p,a’. (Fredrikze method only).

OutputWorkspace

Output

WorkspaceGroup

Mandatory

A group of polarization efficiency corrected workspaces.

Description

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, SpinStates, and PolarizationAnalysis properties are empty strings and correspond to the actual defaults of the child algorithms.

Categories: AlgorithmIndex | Reflectometry

Source

C++ header: PolarizationEfficiencyCor.h

C++ source: PolarizationEfficiencyCor.cpp