From 5f30ec52fe5909ce9cdecc5149b9c0d35a72167a Mon Sep 17 00:00:00 2001
From: Gesner Passos <gesner.passos@stfc.ac.uk>
Date: Thu, 28 Feb 2013 15:49:00 +0000
Subject: [PATCH] Wikimaker fixes for RemoveExpDecay
It was necessary to change the name from MuonRemoveExpDecay files to RemoveExpDecay.
re #6485
---
.../Framework/Algorithms/CMakeLists.txt | 10 ++++----
...{MuonRemoveExpDecay.h => RemoveExpDecay.h} | 0
...nRemoveExpDecay.cpp => RemoveExpDecay.cpp} | 25 ++++++++++++++++---
...oveExpDecayTest.h => RemoveExpDecayTest.h} | 2 +-
4 files changed, 27 insertions(+), 10 deletions(-)
rename Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/{MuonRemoveExpDecay.h => RemoveExpDecay.h} (100%)
rename Code/Mantid/Framework/Algorithms/src/{MuonRemoveExpDecay.cpp => RemoveExpDecay.cpp} (92%)
rename Code/Mantid/Framework/Algorithms/test/{MuonRemoveExpDecayTest.h => RemoveExpDecayTest.h} (97%)
diff --git a/Code/Mantid/Framework/Algorithms/CMakeLists.txt b/Code/Mantid/Framework/Algorithms/CMakeLists.txt
index 9041f1e0c67..1d5cc1b2970 100644
--- a/Code/Mantid/Framework/Algorithms/CMakeLists.txt
+++ b/Code/Mantid/Framework/Algorithms/CMakeLists.txt
@@ -2,7 +2,6 @@ set ( SRC_FILES
# src/Q1DTOF.cpp
# src/CountEventsInPulses.cpp
# src/UpdatePeakParameterTable.cpp
- src/CorrectFlightPaths.cpp
src/AbsorptionCorrection.cpp
src/AddLogDerivative.cpp
src/AddPeak.cpp
@@ -45,6 +44,7 @@ set ( SRC_FILES
src/ConvertUnits.cpp
src/CopyInstrumentParameters.cpp
src/CopySample.cpp
+ src/CorrectFlightPaths.cpp
src/CorrectKiKf.cpp
src/CorrectToFile.cpp
src/CreateCalFileByNames.cpp
@@ -131,7 +131,6 @@ set ( SRC_FILES
src/MultipleScatteringCylinderAbsorption.cpp
src/Multiply.cpp
src/MultiplyRange.cpp
- src/MuonRemoveExpDecay.cpp
src/NormaliseByCurrent.cpp
src/NormaliseByDetector.cpp
src/NormaliseToMonitor.cpp
@@ -162,6 +161,7 @@ set ( SRC_FILES
src/RecordPythonScript.cpp
src/Regroup.cpp
src/RemoveBins.cpp
+ src/RemoveExpDecay.cpp
src/RemoveLowResTOF.cpp
src/RemovePromptPulse.cpp
src/RenameWorkspace.cpp
@@ -211,7 +211,6 @@ set ( INC_FILES
# inc/MantidAlgorithms/Q1DTOF.h
# inc/MantidAlgorithms/CountEventsInPulses.h
# inc/MantidAlgorithms/UpdatePeakParameterTable.h
- inc/MantidAlgorithms/CorrectFlightPaths.h
inc/MantidAlgorithms/AbsorptionCorrection.h
inc/MantidAlgorithms/AddLogDerivative.h
inc/MantidAlgorithms/AddPeak.h
@@ -254,6 +253,7 @@ set ( INC_FILES
inc/MantidAlgorithms/ConvertUnits.h
inc/MantidAlgorithms/CopyInstrumentParameters.h
inc/MantidAlgorithms/CopySample.h
+ inc/MantidAlgorithms/CorrectFlightPaths.h
inc/MantidAlgorithms/CorrectKiKf.h
inc/MantidAlgorithms/CorrectToFile.h
inc/MantidAlgorithms/CreateCalFileByNames.h
@@ -341,7 +341,6 @@ set ( INC_FILES
inc/MantidAlgorithms/MultipleScatteringCylinderAbsorption.h
inc/MantidAlgorithms/Multiply.h
inc/MantidAlgorithms/MultiplyRange.h
- inc/MantidAlgorithms/MuonRemoveExpDecay.h
inc/MantidAlgorithms/NormaliseByCurrent.h
inc/MantidAlgorithms/NormaliseByDetector.h
inc/MantidAlgorithms/NormaliseToMonitor.h
@@ -372,6 +371,7 @@ set ( INC_FILES
inc/MantidAlgorithms/RecordPythonScript.h
inc/MantidAlgorithms/Regroup.h
inc/MantidAlgorithms/RemoveBins.h
+ inc/MantidAlgorithms/RemoveExpDecay.h
inc/MantidAlgorithms/RemoveLowResTOF.h
inc/MantidAlgorithms/RemovePromptPulse.h
inc/MantidAlgorithms/RenameWorkspace.h
@@ -545,7 +545,6 @@ set ( TEST_FILES
MultipleScatteringCylinderAbsorptionTest.h
MultiplyRangeTest.h
MultiplyTest.h
- MuonRemoveExpDecayTest.h
NormaliseByCurrentTest.h
NormaliseByDetectorTest.h
NormaliseToMonitorTest.h
@@ -573,6 +572,7 @@ set ( TEST_FILES
RebunchTest.h
RegroupTest.h
RemoveBinsTest.h
+ RemoveExpDecayTest.h
RemoveLowResTOFTest.h
RemovePromptPulseTest.h
RenameWorkspaceTest.h
diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/MuonRemoveExpDecay.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RemoveExpDecay.h
similarity index 100%
rename from Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/MuonRemoveExpDecay.h
rename to Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RemoveExpDecay.h
diff --git a/Code/Mantid/Framework/Algorithms/src/MuonRemoveExpDecay.cpp b/Code/Mantid/Framework/Algorithms/src/RemoveExpDecay.cpp
similarity index 92%
rename from Code/Mantid/Framework/Algorithms/src/MuonRemoveExpDecay.cpp
rename to Code/Mantid/Framework/Algorithms/src/RemoveExpDecay.cpp
index 53d9375ca21..a81ec754d9d 100644
--- a/Code/Mantid/Framework/Algorithms/src/MuonRemoveExpDecay.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/RemoveExpDecay.cpp
@@ -1,3 +1,20 @@
+/*WIKI*
+
+
+
+This algorithm removes the exponential time decay from a specified muon spectra. By default, all the spectra in a workspace will be corrected.
+
+The formula for removing the exponential decay is given by:
+
+:<math> NewData = (OldData\times{e^\frac{t}{\tau}})/N_0 - 1.0 </math>
+
+where Ï„ is the muon lifetime (2.197019e-6 seconds). <math>N_0</math> is a fitted normalisation constant.
+
+
+
+
+
+*WIKI*/
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
@@ -8,7 +25,7 @@
#include "MantidAPI/IFunction.h"
#include "MantidKernel/PhysicalConstants.h"
#include "MantidKernel/ArrayProperty.h"
-#include "MantidAlgorithms/MuonRemoveExpDecay.h"
+#include "MantidAlgorithms/RemoveExpDecay.h"
namespace Mantid
{
@@ -36,11 +53,11 @@ void MuonRemoveExpDecay::initDocs()
void MuonRemoveExpDecay::init()
{
declareProperty(new API::WorkspaceProperty<API::MatrixWorkspace>("InputWorkspace", "",
- Direction::Input), "Name of the input 2D workspace");
+ Direction::Input), "The name of the input 2D workspace.");
declareProperty(new API::WorkspaceProperty<API::MatrixWorkspace>("OutputWorkspace", "",
- Direction::Output), "The name of the workspace to be created as the output of the algorithm");
+ Direction::Output), "The name of the output 2D workspace.");
std::vector<int> empty;
- declareProperty(new Kernel::ArrayProperty<int>("Spectra", empty), "Spectra to remove the exponential decay from");
+ declareProperty(new Kernel::ArrayProperty<int>("Spectra", empty), "The workspace indeces to remove the exponential decay from.");
}
/** Executes the algorithm
diff --git a/Code/Mantid/Framework/Algorithms/test/MuonRemoveExpDecayTest.h b/Code/Mantid/Framework/Algorithms/test/RemoveExpDecayTest.h
similarity index 97%
rename from Code/Mantid/Framework/Algorithms/test/MuonRemoveExpDecayTest.h
rename to Code/Mantid/Framework/Algorithms/test/RemoveExpDecayTest.h
index 6ad22942904..a2b02e8c1d1 100644
--- a/Code/Mantid/Framework/Algorithms/test/MuonRemoveExpDecayTest.h
+++ b/Code/Mantid/Framework/Algorithms/test/RemoveExpDecayTest.h
@@ -5,7 +5,7 @@
#include "MantidDataHandling/LoadInstrument.h"
#include "MantidDataHandling/LoadMuonNexus2.h"
-#include "MantidAlgorithms/MuonRemoveExpDecay.h"
+#include "MantidAlgorithms/RemoveExpDecay.h"
#include "MantidAPI/Workspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidAPI/AnalysisDataService.h"
--
GitLab