Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | List of all members
Mantid::Algorithms::PerformIndexOperations Class Reference

PerformIndexOperations : Crop and sum a workspace according to the parsed workspace index operations provided. More...

#include <PerformIndexOperations.h>

Inheritance diagram for Mantid::Algorithms::PerformIndexOperations:
Mantid::API::GenericDataProcessorAlgorithm< Base >

Public Member Functions

const std::string category () const override
 Algorithm's category for identification.
 
const std::string name () const override
 Algorithm's name for identification.
 
const std::vector< std::string > seeAlso () const override
 
const std::string summary () const override
 Summary of algorithms purpose.
 
int version () const override
 Algorithm's version for identification.
 
- Public Member Functions inherited from Mantid::API::GenericDataProcessorAlgorithm< Base >
 GenericDataProcessorAlgorithm ()
 Constructor.
 
Kernel::IPropertyManager::TypedValue getProperty (const std::string &name) const override
 Get the property held by this object.
 
std::string getPropertyValue (const std::string &name) const override
 Get the property held by this object.
 

Private Member Functions

void exec () override
 Execute the algorithm.
 
void init () override
 Initialize the algorithm's properties.
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::API::GenericDataProcessorAlgorithm< Base >
void copyProperty (const API::Algorithm_sptr &alg, const std::string &name)
 Copy a property from an existing algorithm.
 
std::shared_ptr< AlgorithmcreateChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1) override
 Create a Child Algorithm.
 
virtual ITableWorkspace_sptr determineChunk (const std::string &filename)
 
MatrixWorkspace_sptr divide (const MatrixWorkspace_sptr lhs, const double &rhsValue)
 Divide a matrix workspace by a single value.
 
MatrixWorkspace_sptr divide (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
 Divide a matrix workspace by another matrix workspace.
 
void forwardProperties ()
 
std::shared_ptr< Kernel::PropertyManagergetProcessProperties (const std::string &propertyManager=std::string()) const
 Get the property manager object of a given name from the property manager data service, or create a new one.
 
Workspace_sptr load (const std::string &inputData, const bool loadQuiet=false)
 Determine what kind of input data we have and load it.
 
virtual MatrixWorkspace_sptr loadChunk (const size_t rowIndex)
 
void mapPropertyName (const std::string &nameInProp, const std::string &nameInPropManager)
 Declare mapping of property name to name in the PropertyManager.
 
MatrixWorkspace_sptr minus (const MatrixWorkspace_sptr lhs, const double &rhsValue)
 Subract a single value from a matrix workspace.
 
MatrixWorkspace_sptr minus (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
 Subract a matrix workspace by another matrix workspace.
 
MatrixWorkspace_sptr multiply (const MatrixWorkspace_sptr lhs, const double &rhsValue)
 Multiply a matrix workspace by a single value.
 
MatrixWorkspace_sptr multiply (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
 Multiply a matrix workspace by another matrix workspace.
 
MatrixWorkspace_sptr plus (const MatrixWorkspace_sptr lhs, const double &rhsValue)
 Add a single value to a matrix workspace.
 
MatrixWorkspace_sptr plus (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
 Add a matrix workspace to another matrix workspace.
 
void saveNexus (const std::string &outputWSName, const std::string &outputFile)
 Save a workspace as a nexus file, with check for which thread we are executing in.
 
void setAccumAlg (const std::string &alg)
 
void setLoadAlg (const std::string &alg)
 
void setLoadAlgFileProp (const std::string &filePropName)
 
void setPropManagerPropName (const std::string &propName)
 
std::vector< std::string > splitInput (const std::string &input)
 

Detailed Description

PerformIndexOperations : Crop and sum a workspace according to the parsed workspace index operations provided.

Definition at line 18 of file PerformIndexOperations.h.

Member Function Documentation

◆ category()

const std::string Mantid::Algorithms::PerformIndexOperations::category ( ) const
override

Algorithm's category for identification.

See also
Algorithm::category

Definition at line 252 of file PerformIndexOperations.cpp.

◆ exec()

void Mantid::Algorithms::PerformIndexOperations::exec ( )
overrideprivate

◆ init()

void Mantid::Algorithms::PerformIndexOperations::init ( )
overrideprivate

Initialize the algorithm's properties.

Definition at line 259 of file PerformIndexOperations.cpp.

References Mantid::Kernel::Direction::Input, and Mantid::Kernel::Direction::Output.

◆ name()

const std::string Mantid::Algorithms::PerformIndexOperations::name ( ) const
override

Algorithm's name for identification.

See also
Algorithm::name

Definition at line 246 of file PerformIndexOperations.cpp.

◆ seeAlso()

const std::vector< std::string > Mantid::Algorithms::PerformIndexOperations::seeAlso ( ) const
inlineoverride

Definition at line 27 of file PerformIndexOperations.h.

◆ summary()

const std::string Mantid::Algorithms::PerformIndexOperations::summary ( ) const
inlineoverride

Summary of algorithms purpose.

Definition at line 22 of file PerformIndexOperations.h.

◆ version()

int Mantid::Algorithms::PerformIndexOperations::version ( ) const
override

Algorithm's version for identification.

See also
Algorithm::version

Definition at line 249 of file PerformIndexOperations.cpp.


The documentation for this class was generated from the following files: