Commit 45b4c61f authored by Doucet, Mathieu's avatar Doucet, Mathieu
Browse files

Re #5051 Fixing missing or inaccurate documentation

parent fa2e1d9e
......@@ -12,7 +12,8 @@ namespace Mantid
{
namespace API
{
/** DataProcessorAlgorithm :
/**
Data processor algorithm to be used as a parent to workflow algorithms.
This algorithm provides utility methods to load and process data.
......
......@@ -10,6 +10,29 @@ namespace Mantid
{
namespace WorkflowAlgorithms
{
/**
Workflow algorithm to compute a patched sensitivity correction for EQSANS.
Copyright © 2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport ComputeSensitivity : public API::Algorithm
{
public:
......
......@@ -11,27 +11,24 @@ namespace Mantid
namespace WorkflowAlgorithms
{
/**
Calculate the detector sensitivity and patch the pixels that are masked in a second workspace.
Apply the sensitivity correction as a function of wavelength for EQSANS.
Apply wavelength dependence as
Copyright &copy; 2011 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
Efficiency(lambda) = Efficiency(0) * (1 - exp(-b*lambda))
This file is part of Mantid.
where b is the value of the Factor property.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the workspace to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the result </LI>
</UL>
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
Optional Properties:
<UL>
<LI> MinEfficiency - Minimum efficiency for a pixel to be considered (default: no minimum)</LI>
<LI> MaxEfficiency - Maximum efficiency for a pixel to be considered (default: no maximum)</LI>
<LI> Factor - Exponential factor for detector efficiency as a function of wavelength (default: 1.0)</LI>
<LI> Error - Error on Factor property (default: 0.0)</LI>
</UL>
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
......
......@@ -11,6 +11,29 @@ namespace Mantid
{
namespace WorkflowAlgorithms
{
/**
Perform EQSANS data reduction.
Copyright &copy; 2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport EQSANSReduce : public API::DataProcessorAlgorithm
{
public:
......@@ -18,11 +41,11 @@ public:
EQSANSReduce() : API::DataProcessorAlgorithm() {}
/// Virtual destructor
virtual ~EQSANSReduce() {}
/// Algorithm's name
/// Algorithm's name for identification. @see Algorithm::name
virtual const std::string name() const { return "EQSANSReduce"; }
/// Algorithm's version
/// Algorithm's version for identification. @see Algorithm::version
virtual int version() const { return (1); }
/// Algorithm's category for identification
/// Algorithm's category for identification. @see Algorithm::category
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
......@@ -32,9 +55,11 @@ private:
void init();
/// Execution code
void exec();
void initializeReduction();
/// Perform data reduction
void performReduction(API::Workspace_sptr workspace);
/// Post-process the reduced data
API::Workspace_sptr postProcess(API::Workspace_sptr workspace);
/// Load input file or workspace
API::Workspace_sptr loadInputData();
};
......
......@@ -13,9 +13,25 @@ namespace Mantid
namespace WorkflowAlgorithms
{
/**
Data reduction for reflectometry
Copyright &copy; 2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
......
......@@ -14,6 +14,23 @@ namespace WorkflowAlgorithms
Workflow algorithm for reflectometry to sum up a region of interest on a 2D detector.
Copyright &copy; 2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment