diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp index 4205786760c6..4f23885bbcb9 100644 --- a/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp +++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp @@ -1,5 +1,13 @@ /*WIKI* -TODO: Enter a full wiki-markup description of your algorithm here. You can then use the Build/wiki_maker.py script to generate your full wiki page. +The algorithm replicates the sequence of actions undertaken by MuonAnalysis in order to produce a Muon workspace ready for fitting. + +Specifically: +# Load the specified filename +# Apply dead time correction +# Group the workspace +# Offset, crop and rebin the workspace +# If the loaded data is multi-period - apply the specified operation to specified periods to get a single data set. +# Use [[MuonCalculateAsymmetry]] to get the resulting workspace. *WIKI*/ #include "MantidWorkflowAlgorithms/MuonLoad.h"