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

CreatePolarizationEfficiencies v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Converts polynomial factors to histograms with polarization efficiencies.

See Also

JoinISISPolarizationEfficiencies, LoadISISPolarizationEfficiencies, PolarizationEfficiencyCor

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

An input workspace to use the x-values from.

Pp

Input

dbl list

Effective polarizing power of the polarizing system. Expressed as a ratio 0 < Pp < 1

Ap

Input

dbl list

Effective polarizing power of the analyzing system. Expressed as a ratio 0 < Ap < 1

Rho

Input

dbl list

Ratio of efficiencies of polarizer spin-down to polarizer spin-up. This is characteristic of the polarizer flipper. Values are constants for each term in a polynomial expression.

Alpha

Input

dbl list

Ratio of efficiencies of analyzer spin-down to analyzer spin-up. This is characteristic of the analyzer flipper. Values are factors for each term in a polynomial expression.

P1

Input

dbl list

Polarizer efficiency.

P2

Input

dbl list

Analyzer efficiency.

F1

Input

dbl list

Polarizer flipper efficiency.

F2

Input

dbl list

Analyzer flipper efficiency.

OutputWorkspace

Output

MatrixWorkspace

Mandatory

An output workspace.

Description

Creates a workspace in which the spectra contain the polarization efficiencies calculated from polynomial coefficients on the x-values of the input workspace.

Usage

Example

ws = CreateWorkspace([0, 1, 2, 3, 4], [0, 0, 0, 0, 0])
eff = CreatePolarizationEfficiencies(ws, Pp=[0, 1, 2, 3], Ap=[1, 2, 3], Rho=[3, 2, 1], Alpha=[4, 3, 2, 1])
print(eff.getAxis(1).label(0))
print(eff.getAxis(1).label(1))
print(eff.getAxis(1).label(2))
print(eff.getAxis(1).label(3))

Output:

Pp
Ap
Rho
Alpha

Categories: AlgorithmIndex | Reflectometry

Source

C++ header: CreatePolarizationEfficiencies.h

C++ source: CreatePolarizationEfficiencies.cpp