Commit 028174e8 authored by Nick Draper's avatar Nick Draper
Browse files

re #9523 Crystal, CurveFitting, DataHandling, ICat and ISISLiveData

parent 83961ad9
......@@ -30,9 +30,9 @@ def write_header(subproject, classname, filename, args):
virtual const std::string name() const;
virtual int version() const;
virtual const std::string category() const;
virtual const std::string summary() const;
private:
virtual void initDocs();
void init();
void exec();
......@@ -125,8 +125,7 @@ def write_source(subproject, classname, filename, args):
algorithm_source = """
//----------------------------------------------------------------------------------------------
/// Algorithm's name for identification. @see Algorithm::name
const std::string %s::name() const { return "%s";};
/// Algorithm's version for identification. @see Algorithm::version
int %s::version() const { return 1;};
......@@ -134,13 +133,8 @@ def write_source(subproject, classname, filename, args):
/// Algorithm's category for identification. @see Algorithm::category
const std::string %s::category() const { return TODO: FILL IN A CATEGORY;}
//----------------------------------------------------------------------------------------------
/// Sets documentation strings for this algorithm
void %s::initDocs()
{
this->setWikiSummary("TODO: Enter a quick description of your algorithm.");
this->setOptionalMessage("TODO: Enter a quick description of your algorithm.");
}
/// Algorithm's summary for use in the GUI and help. @see Algorithm::summary
const std::string %s::summary() const { return TODO: FILL IN A SUMMARY;};
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
......
......@@ -73,6 +73,9 @@ public:
virtual ~AnvredCorrection() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "AnvredCorrection"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculates anvred correction factors for attenuation due to absorption and scattering in a spherical sample";}
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
......
......@@ -40,11 +40,13 @@ namespace Crystal
virtual ~CalculatePeaksHKL();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculates Miller indices for each peak. No rounding or UB optimization.";}
virtual int version() const;
virtual const std::string category() const;
private:
virtual void initDocs();
void init();
void exec();
......
......@@ -42,14 +42,16 @@ namespace Crystal
/// Algorithm's name for identification
virtual const std::string name() const { return "CalculateUMatrix";};
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculate the U matrix from a peaks workspace, given lattice parameters.";}
/// Algorithm's version for identification
virtual int version() const { return 1;};
/// Algorithm's category for identification
virtual const std::string category() const { return "Crystal";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the properties
void init();
/// Run the algorithm
......
......@@ -30,14 +30,16 @@ namespace Crystal
/// Algorithm's name for identification
virtual const std::string name() const { return "CentroidPeaks";};
///Summary of algorithms purpose
virtual const std::string summary() const {return "Find the centroid of single-crystal peaks in a 2D Workspace, in order to refine their positions.";}
/// Algorithm's version for identification
virtual int version() const { return 1;};
/// Algorithm's category for identification
virtual const std::string category() const { return "Crystal";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the properties
void init();
/// Run the algorithm
......
......@@ -38,6 +38,9 @@ namespace Crystal
virtual ~ClearUB();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Clears the UB by removing the oriented lattice from the sample.";}
virtual int version() const;
virtual const std::string category() const;
......@@ -47,7 +50,6 @@ namespace Crystal
private:
bool clearSingleExperimentInfo(Mantid::API::ExperimentInfo * const experimentInfo, const bool dryRun) const;
virtual void initDocs();
void init();
void exec();
......
......@@ -38,11 +38,13 @@ namespace Crystal
virtual ~CombinePeaksWorkspaces();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Combines the sets of peaks in two peaks workspaces, optionally omitting duplicates.";}
virtual int version() const;
virtual const std::string category() const;
private:
virtual void initDocs();
void init();
void exec();
};
......
......@@ -36,11 +36,13 @@ namespace Crystal
virtual ~DiffPeaksWorkspaces();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Removes from a workspace any peaks that match a peak in a second workspace.";}
virtual int version() const;
virtual const std::string category() const;
private:
virtual void initDocs();
void init();
void exec();
};
......
......@@ -38,11 +38,13 @@ namespace Crystal
virtual ~FilterPeaks();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Filters the peaks in a peaks workspace based upon the valur of a chosen variable.";}
virtual int version() const;
virtual const std::string category() const;
private:
virtual void initDocs();
void init();
void exec();
......
......@@ -40,11 +40,13 @@ namespace Crystal
virtual ~FindClusterFaces();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Find faces for clusters in a cluster image.";}
virtual int version() const;
virtual const std::string category() const;
private:
virtual void initDocs();
void init();
void exec();
......
......@@ -203,13 +203,15 @@ public:
virtual ~FindSXPeaks() {};
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "FindSXPeaks";}
///Summary of algorithms purpose
virtual const std::string summary() const {return "Takes a 2D workspace as input and find the FindSXPeaksimum in each 1D spectrum. This is used in particular for single crystal as a quick way to find strong peaks.";}
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return (1);}
/// Algorithm's category for identification overriding a virtual method
virtual const std::string category() const { return "Crystal;Optimization\\PeakFinding";}
private:
void initDocs();
// Overridden Algorithm methods
void init();
//
......
......@@ -50,10 +50,10 @@ namespace Crystal
/// Algorithm's category for identification
virtual const std::string category() const;
private:
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculate the UB matrix from a peaks workspace, given min(a,b,c) and max(a,b,c).";}
/// Sets documentation strings for this algorithm
virtual void initDocs();
private:
/// Initialise the properties
void init();
......
......@@ -54,10 +54,12 @@ namespace Crystal
virtual const std::string category() const
{ return "Crystal";}
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculate the UB matrix from a peaks workspace, containing indexed peaks.";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the properties
void init();
......
......@@ -54,11 +54,11 @@ namespace Crystal
virtual const std::string category() const
{ return "Crystal";}
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculate the UB matrix from a peaks workspace, given lattice parameters.";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the properties
void init();
......
......@@ -51,11 +51,13 @@ namespace Crystal
/// Algorithm's category for identification
virtual const std::string category() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Calculate the UB matrix from a peaks workspace, given min(a,b,c) and max(a,b,c).";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the properties
void init();
......
......@@ -50,18 +50,16 @@ namespace Mantid
~GoniometerAnglesFromPhiRotation();
/// Algorithm's name for identification
const std::string name() const
{
return "GoniometerAnglesFromPhiRotation";
}
;
const std::string name() const { return "GoniometerAnglesFromPhiRotation"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "The 2nd PeaksWorkspace is set up with the correct sample orientations and UB matrices";}
/// Algorithm's version for identification
int version() const
{
return 1;
}
;
/// Algorithm's category for identification
const std::string category() const
......@@ -70,10 +68,6 @@ namespace Mantid
}
private:
/// Sets documentation strings for this algorithm
void initDocs();
/// Initialise the properties
void init();
Kernel::Matrix<double> getUBRaw(const Kernel::Matrix<double> &UB,
......
......@@ -40,11 +40,13 @@ namespace Crystal
virtual ~HasUB();
virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "Determines whether the workspace has one or more UB Matrix";}
virtual int version() const;
virtual const std::string category() const;
private:
virtual void initDocs();
void init();
void exec();
......
......@@ -43,12 +43,13 @@ namespace Crystal
~IndexPeaks();
/// Algorithm's name for identification
virtual const std::string name() const
{ return "IndexPeaks";};
virtual const std::string name() const { return "IndexPeaks";};
///Summary of algorithms purpose
virtual const std::string summary() const {return "Index the peaks using the UB from the sample.";}
/// Algorithm's version for identification
virtual int version() const
{ return 1;};
{ return 1;}
/// Algorithm's category for identification
virtual const std::string category() const
......@@ -56,8 +57,7 @@ namespace Crystal
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the properties
void init();
......
......@@ -178,6 +178,9 @@ public:
virtual ~IndexSXPeaks() {};
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "IndexSXPeaks";}
///Summary of algorithms purpose
virtual const std::string summary() const {return "Takes a PeaksWorkspace and a B-Matrix and determines the HKL values corresponding to each Single Crystal peak. Sets indexes on the input/output workspace.";}
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return (1);}
/// Algorithm's category for identification overriding a virtual method
......@@ -189,7 +192,6 @@ private:
void cullHKLs(std::vector<PeakCandidate>& peaksCandidates, Mantid::Geometry::UnitCell& unitcell);
//Helper method used to check that not all peaks are colinear.
void validateNotColinear(std::vector<PeakCandidate>& peakCandidates) const;
void initDocs();
// Overridden Algorithm methods
void init();
//
......
......@@ -286,6 +286,10 @@ public:
return "IntegratePeakTimeSlices";
}
///Summary of algorithms purpose
virtual const std::string summary() const {return "The algorithm uses CurveFitting::BivariateNormal for fitting a time slice";}
/// Algorithm's version for identification overriding a virtual method
virtual int version() const
{
......@@ -304,7 +308,6 @@ private:
void init();
void exec();
virtual void initDocs();
Mantid::API::MatrixWorkspace_sptr inputW; ///< A pointer to the input workspace, the data set
Mantid::DataObjects::TableWorkspace_sptr outputW; ///< A pointer to the output workspace
......
Markdown is supported
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