ReflectometryISISCalculatePolEff v1

Summary

A wrapper algorithm that calculates polarization efficiencies using ReflectometryISISCreateTransmission, PolarizationEfficienciesWildes and JoinISISPolarizationEfficiencies.

See Also

ReflectometryISISCreateTransmission, PolarizationEfficienciesWildes, JoinISISPolarizationEfficiencies

Properties

Name

Direction

Type

Default

Description

NonMagInputRuns

Input

str list

Mandatory

A list of input run numbers. Multiple runs will be summed after loading

ProcessingInstructions

Input

int list

Grouping pattern of spectrum numbers to yield only the detectors of interest. See group detectors for syntax.

BackgroundProcessingInstructions

Input

int list

A set of workspace indices to be passed as the ProcessingInstructions property when calculating the transmission workspace. If this property is not set then no background subtraction is performed.

MagInputRuns

Input

str list

A list of magnetic input run numbers. Multiple runs will be summed after loading

MagProcessingInstructions

Input

int list

Grouping pattern of magnetic spectrum numbers to yield only the detectors of interest. See group detectors for syntax.

MagBackgroundProcessingInstructions

Input

int list

A set of workspace indices to be passed as the ProcessingInstructions property when calculating the magnetic transmission workspace. If this property is not set then no background subtraction is performed.

OutputWorkspace

Output

MatrixWorkspace

calc_pol_eff_out

The name of the workspace to be output as a result of the algorithm.

I0MonitorIndex

Input

number

Optional

I0 monitor workspace index

MonitorIntegrationWavelengthMin

Input

number

Optional

Wavelength minimum for integration in angstroms.

MonitorIntegrationWavelengthMax

Input

number

Optional

Wavelength maximum for integration in angstroms.

FloodWorkspace

Input

MatrixWorkspace

The workspace to be used for the flood correction. If this property is not set then no flood correction is performed.

Flippers

Input

string

00,01,10,11

Flipper configurations of the input group workspace(s).

InputPolarizerEfficiency

Input

MatrixWorkspace

Workspace containing the known wavelength-dependent efficiency for the polarizer.

InputAnalyserEfficiency

Input

MatrixWorkspace

Workspace containing the known wavelength-dependent efficiency for the analyser.

IncludeDiagnosticOutputs

Input

boolean

False

Whether to include additional diagnostic outputs.

OutputPhi

Output

MatrixWorkspace

phi

Output workspace containing the values for Phi.

OutputRho

Output

MatrixWorkspace

rho

Output workspace containing the values for Rho.

OutputAlpha

Output

MatrixWorkspace

alpha

Output workspace containing the values for Alpha.

OutputTwoAMinusOne

Output

MatrixWorkspace

two_a_minus_one

Output workspace containing the values for the term (2a-1).

OutputTwoPMinusOne

Output

MatrixWorkspace

two_p_minus_one

Output workspace containing the values for the term (2p-1).

Description

This algorithm calculates the instrument component efficiencies in a polarized analysis experiment. The algorithm is a wrapper algorithm around the ReflectometryISISCreateTransmission v1, PolarizationEfficienciesWildes v1, and JoinISISPolarizationEfficiencies v1 algorithms. See the linked documentation for the individual algorithms for detail on implementation.

The NonMagInputRuns property takes a list of one or more run numbers related to non-magnetic runs. This list is passed to ReflectometryISISCreateTransmission v1, in which they are loaded and summed (if more than one) using LoadAndMerge v1.

Likewise, the MagInputRuns property takes a list of one or more run numbers related to magnetic runs.

If workspace indices are provided to the either of the BackgroundProcessingInstructions or MagBackgroundProcessingInstructions properties then a background subtraction is performed as part of ReflectometryISISCreateTransmission v1 for the relevant input runs.

If both non-magnetic and magnetic inputs runs are provided, they must have the same number of spectra. If this is not the case then a sub-section of the spectra can be specified for processing through the ProcessingInstructions and MagProcessingInstructions properties.

The following parameters are passed directly to the child algorithms. See documentation for the relevant algorithm for detail on each.

ReflectometryISISCreateTransmission v1 for both magnetic and non-magnetic runs:

  • FloodWorkspace

  • IOMonitorIndex

  • MonitorIntegrationWavelengthMin

  • MonitorIntegrationWavelengthMax

PolarizationEfficienciesWildes v1:

  • IncludeDiagnosticOutputs

  • Flippers

  • InputPolariserEfficiency

  • InputAnalyserEfficiency

Usage

Example - ReflectometryISISCreateTransmission

pol_eff = ReflectometryISISCalculatePolEff(NonMagInputRuns="POLREF32130", ProcessingInstructions="270-292", MagInputRuns="POLREF32131", MagProcessingInstructions="270-292")
print(f"Output workspace contains {pol_eff.getNumberHistograms()} spectrum related to the calculated efficiencies for the two polarizers, analyzers and flippers.")

Output:

Output workspace contains 4 spectrum related to the calculated efficiencies for the two polarizers, analyzers and flippers.

Categories: AlgorithmIndex | Reflectometry\ISIS | Workflow\Reflectometry

Source

Python: ReflectometryISISCalculatePolEff.py