PlotAsymmetryByLogValue
From MantidProject
Contents |
Summary
Calculates asymmetry for a series of log values
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | FirstRun | Input | Workspace | Mandatory | The name of the first workspace in the series. |
| 2 | LastRun | Output | Workspace | Mandatory | The name of the last workspace in the series. |
| 3 | OutputWorkspace | Output | Workspace | Mandatory | The name of the output workspace containing the resulting asymmetries. |
| 4 | LogValue | Input | String | Mandatory | The name of the log values which will be used as the x-axis in the output workspace. |
| 5 | Red | Input | Integer | 1 | The period number for the "red" data. |
| 6 | Green | Input | Integer | Optional | The period number for the "green" data. |
| 7 | Type | Input | String | Integral | The calculation type: "Integral" or "Differential". |
| 8 | TimeMin | Input | double | Optional | The beginning of the time interval used in the calculations. |
| 9 | TimeMax | Input | double | Optional | The end of the time interval used in the calculations. |
| 10 | ForwardSpectra | Input | Integer array | Optional | The list of spectra for the forward group. |
| 11 | BackwardSpectra | Input | Integer array | Optional | The list of spectra for the backward group. |
Description
This algorithm calculates asymmetry for a series of muon workspaces. The input workspaces must be in Muon Nexus files which names follow the rule: the filename must begin with at least 1 letter and followed by a number. The input property FirstRun must be set to the file name with the smalest number and the LastRun to the one with the highest number. If the "Green" property is not set the output workspace will contain a single spectrum with asymmetry values. If the "Green" is set the output workspace will contain four spectra with asymmetries:
| Workspace Index | Spectrum | Asymmetry |
|---|---|---|
| 0 | 1 | Difference of Red and Green |
| 1 | 2 | Red only |
| 2 | 3 | Green only |
| 3 | 4 | Sum of red and green asymmetries |
If ForwardSpectra and BackwardSpectra are set the muon workspaces will be grouped according to the user input, otherwise the Autogroup option of LoadMuonNexus will be used for grouping.
There is a python script PlotAsymmetryByLogValue.py which if called in MantidPlot runs the algorithm and plots the results.
Source Code
Header PlotAsymmetryByLogValue.h
Source PlotAsymmetryByLogValue.cpp
