3.5

MuonLoad v1

../_images/MuonLoad-v1_dlg.png

MuonLoad dialog.

Summary

Loads Muon workspace ready for analysis.

Properties

Name Direction Type Default Description
Filename Input string Mandatory The name of the Nexus file to load. Allowed extensions: [‘.nxs’]
FirstPeriod Input number 0 Group index of the first period workspace to use
SecondPeriod Input number Optional Group index of the second period workspace to use
PeriodOperation Input string + If two periods specified, what operation to apply to workspaces to get a final one. Allowed values: [‘+’, ‘-‘]
ApplyDeadTimeCorrection Input boolean False Whether dead time correction should be applied to loaded workspace
CustomDeadTimeTable Input TableWorkspace   Table with dead time information. See LoadMuonNexus for format expected.If not specified – algorithm tries to use dead times stored in the data file.
DetectorGroupingTable Input TableWorkspace   Table with detector grouping information. See LoadMuonNexus for format expected. If not specified – algorithm tries to get grouping information from the data file.
TimeZero Input number Optional Value used for Time Zero correction.
RebinParams Input dbl list   Params used for rebinning. If empty - rebinning is not done.
Xmin Input number Optional Minimal X value to include
Xmax Input number Optional Maximal X value to include
OutputType Input string PairAsymmetry What kind of workspace required for analysis. Allowed values: [‘PairAsymmetry’, ‘GroupAsymmetry’, ‘GroupCounts’]
PairFirstIndex Input number Optional Workspace index of the first pair group
PairSecondIndex Input number Optional Workspace index of the second pair group
Alpha Input number 1 Alpha value of the pair
GroupIndex Input number Optional Workspace index of the group
OutputWorkspace Output MatrixWorkspace Mandatory An output workspace.

Description

The algorithm replicates the sequence of actions undertaken by MuonAnalysis in order to produce a Muon workspace ready for fitting.

Specifically:

  1. Load the specified filename
  2. Apply dead time correction
  3. Group the workspace
  4. Offset, crop and rebin the workspace
  5. Use MuonCalculateAsymmetry v1 to get the resulting workspace.

Usage

Note

To run these usage examples please first download the usage data, and add these to your path. In MantidPlot this is done using Manage User Directories.

Note

For more extensive usage examples on result type / period options please refer to the MuonCalculateAsymmetry v1 documentation.

For example of applying custom dead times, please refer to ApplyDeadTimeCorr v1 documentation.

For example of applying custom grouping, please refer to MuonGroupDetectors v1 documentation.

Example - Integrated pair asymmetry for MUSR run:

output = MuonLoad(Filename = 'MUSR0015189.nxs',
                  TimeZero = 0.55,
                  Xmin = 0.11,
                  Xmax = 12,
                  OutputType = "PairAsymmetry",
                  PairFirstIndex = 0,
                  PairSecondIndex = 1,
                  Alpha = 1.0)

output_int = Integration(output)

print 'Integrated asymmetry for the run: {0:.3f}'.format(output_int.readY(0)[0])

Output:

Integrated asymmetry for the run: 1.701

Categories: Algorithms | Workflow | Muon

Source

C++ source: MuonLoad.cpp

C++ header: MuonLoad.h