ReflectometryReductionOneLiveData dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| Instrument | Input | string | CRISP | Instrument to find live value for. Allowed values: [‘CRISP’, ‘INTER’, ‘OFFSPEC’, ‘POLREF’, ‘SURF’] |
| GetLiveValueAlgorithm | Input | string | GetLiveInstrumentValue | The algorithm to use to get live values from the instrument |
| InputWorkspace | Input | MatrixWorkspace | Mandatory | Input run in TOF or wavelength |
| SummationType | Input | string | SumInLambda | The type of summation to perform. Allowed values: [‘SumInLambda’, ‘SumInQ’] |
| ReductionType | Input | string | Normal | The type of reduction to perform when summing in Q. Allowed values: [‘Normal’, ‘DivergentBeam’, ‘NonFlatSample’] |
| IncludePartialBins | Input | boolean | False | If true then partial bins at the beginning and end of the output range are included |
| AnalysisMode | Input | string | PointDetectorAnalysis | Analysis mode. This property is only used when ProcessingInstructions is not set. Allowed values: [‘PointDetectorAnalysis’, ‘MultiDetectorAnalysis’] |
| ProcessingInstructions | Input | string | Grouping pattern of spectrum numbers to yield only the detectors of interest. See GroupDetectors for syntax. | |
| CorrectDetectors | Input | boolean | True | Moves detectors to twoTheta if ThetaIn or ThetaLogName is given |
| DetectorCorrectionType | Input | string | VerticalShift | When correcting detector positions, this determines whether detectorsshould be shifted vertically or rotated around the sample position. Allowed values: [‘RotateAroundSample’, ‘VerticalShift’] |
| WavelengthMin | Input | number | Optional | Wavelength Min in angstroms |
| WavelengthMax | Input | number | Optional | Wavelength Max in angstroms |
| I0MonitorIndex | Input | number | Optional | I0 monitor workspace index |
| MonitorBackgroundWavelengthMin | Input | number | Optional | Wavelength minimum for monitor background subtraction in angstroms. |
| MonitorBackgroundWavelengthMax | Input | number | Optional | Wavelength maximum for monitor background subtraction in angstroms. |
| MonitorIntegrationWavelengthMin | Input | number | Optional | Wavelength minimum for integration in angstroms. |
| MonitorIntegrationWavelengthMax | Input | number | Optional | Wavelength maximum for integration in angstroms. |
| NormalizeByIntegratedMonitors | Input | boolean | True | Normalize by dividing by the integrated monitors. |
| FirstTransmissionRun | Input | MatrixWorkspace | First transmission run, or the low wavelength transmission run if SecondTransmissionRun is also provided. | |
| SecondTransmissionRun | Input | MatrixWorkspace | Second, high wavelength transmission run. Optional. Causes the FirstTransmissionRun to be treated as the low wavelength transmission run. | |
| Params | Input | dbl list | A comma separated list of first bin boundary, width, last bin boundary. These parameters are used for stitching together transmission runs. Values are in wavelength (angstroms). This input is only needed if a SecondTransmission run is provided. | |
| StartOverlap | Input | number | Optional | Start wavelength for stitching transmission runs together. Only used if a second transmission run is provided. |
| EndOverlap | Input | number | Optional | End wavelength (angstroms) for stitching transmission runs together. Only used if a second transmission run is provided. |
| CorrectionAlgorithm | Input | string | AutoDetect | The type of correction to perform. Allowed values: [‘None’, ‘AutoDetect’, ‘PolynomialCorrection’, ‘ExponentialCorrection’] |
| Polynomial | Input | dbl list | Coefficients to be passed to the PolynomialCorrection algorithm. | |
| C0 | Input | number | 0 | C0 value to be passed to the ExponentialCorrection algorithm. |
| C1 | Input | number | 0 | C1 value to be passed to the ExponentialCorrection algorithm. |
| MomentumTransferMin | Input | number | Optional | Minimum Q value in IvsQ Workspace. Used for Rebinning the IvsQ Workspace |
| MomentumTransferStep | Input | number | Optional | Resolution value in IvsQ Workspace. Used for Rebinning the IvsQ Workspace. This value will be made minus to apply logarithmic rebinning. If you wish to have linear bin-widths then please provide a negative value. |
| MomentumTransferMax | Input | number | Optional | Maximum Q value in IvsQ Workspace. Used for Rebinning the IvsQ Workspace |
| PolarizationAnalysis | Input | string | None | Polarization analysis mode. Allowed values: [‘None’, ‘PA’, ‘PNR’, ‘ParameterFile’] |
| CPp | Input | dbl list | Effective polarizing power of the polarizing system. Expressed as a ratio 0 < Pp < 1 | |
| CAp | Input | dbl list | Effective polarizing power of the analyzing system. Expressed as a ratio 0 < Ap < 1 | |
| CRho | 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. | |
| CAlpha | 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. | |
| Debug | Input | boolean | False | Whether to enable the output of extra workspaces. |
| OutputWorkspace | Output | MatrixWorkspace | Output workspace in Q (native binning) |
This algorithm performs a reduction with ReflectometryReductionOneAuto v2 on a live data workspace. It is intended to be run as a post-processing algorithm for StartLiveData v1, although it can also be called directly on a workspace output from live data monitoring. It is not intended to be run on a workspace for a completed run.
This algorithm does some setting up of the instrument and sample logs, which are not normally present for a live data workspace, so that the reduction can be run. This uses live values for theta and the slit gaps, which are found from the instrument using GetLiveInstrumentValue v1. Once the workspace is set up, ReflectometryReductionOneAuto v2 is run, with ThetaLogName set to the appropriate value to use the value of theta that was set in the logs.
GetLiveInstrumentValue v1 requires Mantid to have EPICS support installed, and appropriate processes must be running on the instrument to supply the EPICS values. A different algorithm for fetching live values could be specified by overriding the GetLiveValueAlgorithm property.
- StartLiveData(Instrument=’INTER’,
- PostProcessingAlgorithm=’ReflectometryReductionOneLiveData’, PostProcessingProperties=’Instrument=INTER’, AccumulationMethod=’Replace’,AccumulationWorkspace=’TOF_live’,OutputWorkspace=’IvsQ_binned_live’,)
See also
Algorithm GetLiveInstrumentValue v1, ReflectometryReductionOneAuto v2, StartLiveData v1 and the ISIS Reflectometry interface.
Categories: Algorithm Index | Reflectometry
Python: ReflectometryReductionOneLiveData.py (last modified: 2018-11-28)