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

JoinISISPolarizationEfficiencies v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Joins workspaces containing ISIS reflectometry polarization efficiency factors into a single workspace ready to be used with PolarizationEfficiencyCor.

See Also

CreatePolarizationEfficiencies, LoadISISPolarizationEfficiencies, PolarizationEfficiencyCor

Properties

Name	Direction	Type	Default	Description
Pp	Input	MatrixWorkspace		A matrix workspaces containing the Pp polarization efficiency.
Ap	Input	MatrixWorkspace		A matrix workspaces containing the Ap polarization efficiency.
Rho	Input	MatrixWorkspace		A matrix workspaces containing the Rho polarization efficiency.
Alpha	Input	MatrixWorkspace		A matrix workspaces containing the Alpha polarization efficiency.
P1	Input	MatrixWorkspace		A matrix workspaces containing the P1 polarization efficiency.
P2	Input	MatrixWorkspace		A matrix workspaces containing the P2 polarization efficiency.
F1	Input	MatrixWorkspace		A matrix workspaces containing the F1 polarization efficiency.
F2	Input	MatrixWorkspace		A matrix workspaces containing the F2 polarization efficiency.
OutputWorkspace	Output	MatrixWorkspace	Mandatory	An output workspace.

Description

The inputs to this algorithm are single-spectra workspaces containing polarization efficiencies. They are combined and interpolated if necessary to form a valid matrix workspace. The spectra of the output workspace are labeled with the names of the corresponding input properties.

Usage

# Create input workspaces which can have different sizes
ws1 = CreateWorkspace([1, 2, 3], [1, 1])
ws2 = CreateWorkspace([2, 3, 4, 5], [1, 1, 1])

# Combine them in a single workspace
efficiencies = JoinISISPolarizationEfficiencies(Pp=ws1, Ap=ws2)
print('Number of spectra = {}'.format(efficiencies.getNumberHistograms()))
print('Number of bins    = {}'.format(efficiencies.blocksize()))
print('Label of first  spectrum: {}'.format(efficiencies.getAxis(1).label(0)))
print('Label of second spectrum: {}'.format(efficiencies.getAxis(1).label(1)))

Output:

Number of spectra = 2
Number of bins    = 3
Label of first  spectrum: Pp
Label of second spectrum: Ap

Categories: AlgorithmIndex | Reflectometry

Source

C++ header: JoinISISPolarizationEfficiencies.h

C++ source: JoinISISPolarizationEfficiencies.cpp