Skip to content

Commit

Permalink
Added summary method to SINQ algorithms. Refs #9523.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jawrainey
jawrainey committed May 29, 2014
1 parent 3bdb013 commit 31a67ca
Show file tree
Hide file tree
Showing 30 changed files with 45 additions and 117 deletions.
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/InvertMDDim.h
View file
Expand Up @@ -41,6 +41,9 @@ class MANTID_SINQ_DLL InvertMDDim : public Mantid::API::Algorithm
virtual ~InvertMDDim() {}
/// Algorithm's name
virtual const std::string name() const { return "InvertMDDim"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Inverts dimensions of a MDHistoWorkspace";}

/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
Expand All @@ -59,8 +62,6 @@ class MANTID_SINQ_DLL InvertMDDim : public Mantid::API::Algorithm
unsigned int calcIndex(Mantid::API::IMDHistoWorkspace_sptr ws, int *dim);
unsigned int calcInvertedIndex(Mantid::API::IMDHistoWorkspace_sptr ws, int *dim);

virtual void initDocs();

};

#endif /*INVERTMDDIM_H_*/
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/LoadFlexiNexus.h
View file
Expand Up @@ -58,6 +58,9 @@ class MANTID_SINQ_DLL LoadFlexiNexus : public Mantid::API::Algorithm
virtual ~LoadFlexiNexus() {}
/// Algorithm's name
virtual const std::string name() const { return "LoadFlexiNexus"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Loads a NeXus file directed by a dictionary file";}

/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
Expand Down Expand Up @@ -93,8 +96,6 @@ class MANTID_SINQ_DLL LoadFlexiNexus : public Mantid::API::Algorithm
int calculateCAddress(int *pos, int* dim, int rank);
int calculateF77Address(int *pos, int rank);
size_t *indexMaker;

virtual void initDocs();
};

#endif /*FLEXINEXUSLOADER_H_*/
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/MDHistoToWorkspace2D.h
View file
Expand Up @@ -42,6 +42,9 @@ class MANTID_SINQ_DLL MDHistoToWorkspace2D : public Mantid::API::Algorithm
virtual ~MDHistoToWorkspace2D() {}
/// Algorithm's name
virtual const std::string name() const { return "MDHistoToWorkspace2D"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Flattens a n dimensional MDHistoWorkspace into a Workspace2D with many spectra";}

/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
Expand All @@ -53,8 +56,6 @@ class MANTID_SINQ_DLL MDHistoToWorkspace2D : public Mantid::API::Algorithm
///Execution code
void exec();

virtual void initDocs();

size_t rank;
size_t currentSpectra;
size_t calculateNSpectra( Mantid::API::IMDHistoWorkspace_sptr inws);
Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiAutoCorrelation5.h
View file
Expand Up @@ -68,6 +68,9 @@ class MANTID_SINQ_DLL PoldiAutoCorrelation5 : public API::Algorithm
virtual ~PoldiAutoCorrelation5() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiAutoCorrelation"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Proceed to autocorrelation on Poldi data.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 5; }
/// Algorithm's category for identification overriding a virtual method
Expand All @@ -84,8 +87,6 @@ class MANTID_SINQ_DLL PoldiAutoCorrelation5 : public API::Algorithm


private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
4 changes: 3 additions & 1 deletion Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiFitPeaks1D.h
View file
Expand Up @@ -51,6 +51,9 @@ namespace Poldi
virtual ~PoldiFitPeaks1D();

virtual const std::string name() const;
///Summary of algorithms purpose
virtual const std::string summary() const {return "PoldiPeakFit1D fits peak profiles to POLDI auto-correlation data.";}

virtual int version() const;
virtual const std::string category() const;

Expand Down Expand Up @@ -82,7 +85,6 @@ namespace Poldi
double m_fwhmMultiples;

private:
virtual void initDocs();
void init();
void exec();
};
Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiLoadChopperSlits.h
View file
Expand Up @@ -49,6 +49,9 @@ namespace Mantid
virtual ~PoldiLoadChopperSlits() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiLoadChopperSlits"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Load Poldi chopper slits data file.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
Expand All @@ -63,8 +66,6 @@ namespace Mantid


private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiLoadIPP.h
View file
Expand Up @@ -55,6 +55,9 @@ namespace Mantid
virtual ~PoldiLoadIPP() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiLoadIPP"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Load Poldi IPP data.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
Expand All @@ -68,8 +71,6 @@ namespace Mantid


private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiLoadLog.h
View file
Expand Up @@ -53,6 +53,9 @@ namespace Mantid
virtual ~PoldiLoadLog() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiLoadLog"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Load Poldi log data.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
Expand All @@ -69,8 +72,6 @@ namespace Mantid


private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiLoadSpectra.h
View file
Expand Up @@ -50,6 +50,9 @@ namespace Mantid
virtual ~PoldiLoadSpectra() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiLoadSpectra"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Load Poldi data file.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
Expand All @@ -66,8 +69,6 @@ namespace Mantid


private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiPeakDetection2.h
View file
Expand Up @@ -61,6 +61,9 @@ class MANTID_SINQ_DLL PoldiPeakDetection2 : public API::Algorithm
virtual ~PoldiPeakDetection2() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiPeakDetection"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Peak detection used on a diffractogram, with peak refinement thru a peak fit with a gaussian function.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 2; }
/// Algorithm's category for identification overriding a virtual method
Expand All @@ -72,8 +75,6 @@ class MANTID_SINQ_DLL PoldiPeakDetection2 : public API::Algorithm
void exec();

private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
4 changes: 3 additions & 1 deletion Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiPeakSearch.h
View file
Expand Up @@ -54,10 +54,12 @@ namespace Poldi

virtual int version() const { return 1; }
virtual const std::string name() const { return "PoldiPeakSearch"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "This algorithm finds the peaks in a POLDI auto-correlation spectrum.";}

virtual const std::string category() const { return "SINQ\\Poldi"; }

protected:
void initDocs();

MantidVec getNeighborSums(MantidVec correlationCounts) const;

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/PoldiRemoveDeadWires.h
View file
Expand Up @@ -60,6 +60,9 @@ namespace Mantid
virtual ~PoldiRemoveDeadWires() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "PoldiRemoveDeadWires"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Remove dead wires from Poldi data.";}

/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
Expand Down Expand Up @@ -90,8 +93,6 @@ namespace Mantid


private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/ProjectMD.h
View file
Expand Up @@ -40,6 +40,9 @@ class MANTID_SINQ_DLL ProjectMD : public Mantid::API::Algorithm
virtual ~ProjectMD() {}
/// Algorithm's name
virtual const std::string name() const { return "ProjectMD"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Sum a MDHistoWorkspace along a choosen dimension";}

/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
Expand All @@ -58,8 +61,6 @@ class MANTID_SINQ_DLL ProjectMD : public Mantid::API::Algorithm
double getValue(Mantid::API::IMDHistoWorkspace_sptr ws, int *dim);
void putValue(Mantid::API::IMDHistoWorkspace_sptr ws, int *dim, double val);
unsigned int calcIndex(Mantid::API::IMDHistoWorkspace_sptr ws, int *dim);

virtual void initDocs();
};

#endif /*PROJECTMD_H_*/
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/SINQTranspose3D.h
View file
Expand Up @@ -44,6 +44,9 @@ class MANTID_SINQ_DLL SINQTranspose3D : public Mantid::API::Algorithm
virtual ~SINQTranspose3D() {}
/// Algorithm's name
virtual const std::string name() const { return "Transpose3D"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "SINQ specific MD data reordering";}

/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
Expand All @@ -60,8 +63,6 @@ class MANTID_SINQ_DLL SINQTranspose3D : public Mantid::API::Algorithm
void doTRICS( Mantid::API::IMDHistoWorkspace_sptr inws);
void doAMOR( Mantid::API::IMDHistoWorkspace_sptr inws);

virtual void initDocs();

void copyMetaData( Mantid::API::IMDHistoWorkspace_sptr inws, Mantid::API::IMDHistoWorkspace_sptr outws);
};

Expand Down
5 changes: 3 additions & 2 deletions Code/Mantid/Framework/SINQ/inc/MantidSINQ/SliceMDHisto.h
View file
Expand Up @@ -40,6 +40,9 @@ class MANTID_SINQ_DLL SliceMDHisto : public Mantid::API::Algorithm
virtual ~SliceMDHisto() {}
/// Algorithm's name
virtual const std::string name() const { return "SliceMDHisto"; }
///Summary of algorithms purpose
virtual const std::string summary() const {return "Extracts a hyperslab of data from a MDHistoWorkspace";}

/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
Expand All @@ -60,8 +63,6 @@ class MANTID_SINQ_DLL SliceMDHisto : public Mantid::API::Algorithm

void copyMetaData( Mantid::API::IMDHistoWorkspace_sptr inws, Mantid::API::IMDHistoWorkspace_sptr outws);

virtual void initDocs();

};

#endif /*SLICEMDHISTO_H_*/
4 changes: 0 additions & 4 deletions Code/Mantid/Framework/SINQ/src/InvertMDDim.cpp
View file
Expand Up @@ -135,7 +135,3 @@ unsigned int InvertMDDim::calcInvertedIndex(IMDHistoWorkspace_sptr ws, int dim[]
}
return static_cast<unsigned int>(idx);
}
void InvertMDDim::initDocs()
{
this->setWikiSummary("Inverts dimensions of a MDHistoWorkspace");
}
4 changes: 0 additions & 4 deletions Code/Mantid/Framework/SINQ/src/LoadFlexiNexus.cpp
View file
Expand Up @@ -437,7 +437,3 @@ int LoadFlexiNexus::safeOpenpath(NeXus::File *fin, std::string path)
}
return 1;
}
void LoadFlexiNexus::initDocs()
{
this->setWikiSummary("Loads a NeXus file directed by a dictionary file");
}
4 changes: 0 additions & 4 deletions Code/Mantid/Framework/SINQ/src/MDHistoToWorkspace2D.cpp
View file
Expand Up @@ -131,10 +131,6 @@ void MDHistoToWorkspace2D::checkW2D(Mantid::DataObjects::Workspace2D_sptr outWS)
}
}
}
void MDHistoToWorkspace2D::initDocs()
{
this->setWikiSummary("Flattens a n dimensional MDHistoWorkspace into a Workspace2D with many spectra");
}

void MDHistoToWorkspace2D::copyMetaData(Mantid::API::IMDHistoWorkspace_sptr inWS, Mantid::DataObjects::Workspace2D_sptr outWS)
{
Expand Down
7 changes: 0 additions & 7 deletions Code/Mantid/Framework/SINQ/src/PoldiAutoCorrelation5.cpp
View file
Expand Up @@ -40,13 +40,6 @@ namespace Poldi
// Register the algorithm into the algorithm factory
DECLARE_ALGORITHM(PoldiAutoCorrelation5)

/// Sets documentation strings for this algorithm
void PoldiAutoCorrelation5::initDocs()
{
this->setWikiSummary("Calculates auto-correlation function for POLDI data.");
this->setOptionalMessage("Proceed to autocorrelation on Poldi data.");
}


using namespace Kernel;
using namespace API;
Expand Down
8 changes: 0 additions & 8 deletions Code/Mantid/Framework/SINQ/src/PoldiFitPeaks1D.cpp
View file
Expand Up @@ -67,14 +67,6 @@ int PoldiFitPeaks1D::version() const { return 1;}
/// Algorithm's category for identification. @see Algorithm::category
const std::string PoldiFitPeaks1D::category() const { return "SINQ\\Poldi\\PoldiSet"; }


/// Sets documentation strings for this algorithm
void PoldiFitPeaks1D::initDocs()
{
this->setWikiSummary("PoldiPeakFit1D fits peak profiles to POLDI auto-correlation data.");
this->setOptionalMessage("PoldiPeakFit1D fits peak profiles to POLDI auto-correlation data.");
}

void PoldiFitPeaks1D::init()
{
declareProperty(new WorkspaceProperty<Workspace2D>("InputWorkspace","",Direction::Input), "An input workspace containing a POLDI auto-correlation spectrum.");
Expand Down
7 changes: 0 additions & 7 deletions Code/Mantid/Framework/SINQ/src/PoldiLoadChopperSlits.cpp
View file
Expand Up @@ -31,13 +31,6 @@ namespace Poldi
// Register the algorithm into the algorithm factory
DECLARE_ALGORITHM(PoldiLoadChopperSlits)

// Sets documentation strings for this algorithm
void PoldiLoadChopperSlits::initDocs()
{
this->setWikiSummary("Load Poldi chopper slits data file. ");
this->setOptionalMessage("Load Poldi chopper slits data file.");
}


using namespace Kernel;
using namespace API;
Expand Down
7 changes: 0 additions & 7 deletions Code/Mantid/Framework/SINQ/src/PoldiLoadIPP.cpp
View file
Expand Up @@ -30,13 +30,6 @@ namespace Poldi
// Register the algorithm into the algorithm factory
DECLARE_ALGORITHM(PoldiLoadIPP)

/// Sets documentation strings for this algorithm
void PoldiLoadIPP::initDocs()
{
this->setWikiSummary("Load Poldi IPP data. ");
this->setOptionalMessage("Load Poldi IPP data.");
}


using namespace Kernel;
using namespace API;
Expand Down
7 changes: 0 additions & 7 deletions Code/Mantid/Framework/SINQ/src/PoldiLoadLog.cpp
View file
Expand Up @@ -35,13 +35,6 @@ namespace Poldi
// Register the algorithm into the algorithm factory
DECLARE_ALGORITHM(PoldiLoadLog)

/// Sets documentation strings for this algorithm
void PoldiLoadLog::initDocs()
{
this->setWikiSummary("Load Poldi log data. ");
this->setOptionalMessage("Load Poldi log data.");
}


using namespace Kernel;
using namespace API;
Expand Down
7 changes: 0 additions & 7 deletions Code/Mantid/Framework/SINQ/src/PoldiLoadSpectra.cpp
View file
Expand Up @@ -35,13 +35,6 @@ namespace DataHandling
// Register the algorithm into the algorithm factory
DECLARE_ALGORITHM(PoldiLoadSpectra)

// Sets documentation strings for this algorithm
void PoldiLoadSpectra::initDocs()
{
this->setWikiSummary("Load Poldi data file. ");
this->setOptionalMessage("Load Poldi data file.");
}


using namespace Kernel;
using namespace API;
Expand Down

0 comments on commit 31a67ca

Please sign in to comment.