Skip to content

Commit

Permalink
Refs #8889. Add the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
arturbekasov committed Feb 5, 2014
1 parent c20f1d8 commit 41fc5d0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion 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"
Expand Down

0 comments on commit 41fc5d0

Please sign in to comment.