DgsReduction : This is the top-level workflow algorithm for controlling direct geometry spectrometer reduction. More...

#include <DgsReduction.h>

Inheritance diagram for Mantid::WorkflowAlgorithms::DgsReduction:

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification. More...

const std::string	name () const override
	Algorithm's name for identification. More...

const std::string	summary () const override
	Summary of algorithms purpose. More...

int	version () const override
	Algorithm's version for identification. More...

Public Member Functions inherited from Mantid::API::GenericDataProcessorAlgorithm< Base >
	GenericDataProcessorAlgorithm ()
	Constructor. More...

Kernel::IPropertyManager::TypedValue	getProperty (const std::string &name) const override
	Get the property held by this object. More...

std::string	getPropertyValue (const std::string &name) const override
	Get the property held by this object. More...

Private Member Functions
void	exec () override
	Execute the algorithm. More...

double	getParameter (const std::string &algParam, const API::MatrixWorkspace_sptr &ws, const std::string &altParam)

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

API::MatrixWorkspace_sptr	loadGroupingFile (const std::string &prop)

API::MatrixWorkspace_sptr	loadHardMask ()

API::Workspace_sptr	loadInputData (const std::string &prop, const bool mustLoad=true)
	Create a workspace by either loading a file or using an existing workspace. More...

Private Attributes
std::shared_ptr< Kernel::PropertyManager >	reductionManager

Additional Inherited Members
Protected Member Functions inherited from Mantid::API::GenericDataProcessorAlgorithm< Base >
Workspace_sptr	assemble (const std::string &partialWSName, const std::string &outputWSName)
	Assemble the partial workspaces from all MPI processes. More...

Workspace_sptr	assemble (Workspace_sptr partialWS)
	Assemble the partial workspaces from all MPI processes. More...

void	copyProperty (const API::Algorithm_sptr &alg, const std::string &name)
	Copy a property from an existing algorithm. More...

std::shared_ptr< Algorithm >	createChildAlgorithm (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. More...

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. More...

MatrixWorkspace_sptr	divide (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
	Divide a matrix workspace by another matrix workspace. More...

void	forwardProperties ()

int	getNThreads ()
	Return the number of MPI processes running. More...

std::shared_ptr< Kernel::PropertyManager >	getProcessProperties (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. More...

bool	isMainThread ()
	Return true if we are running on the main thread. More...

Workspace_sptr	load (const std::string &inputData, const bool loadQuiet=false)
	Determine what kind of input data we have and load it. More...

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. More...

MatrixWorkspace_sptr	minus (const MatrixWorkspace_sptr lhs, const double &rhsValue)
	Subract a single value from a matrix workspace. More...

MatrixWorkspace_sptr	minus (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
	Subract a matrix workspace by another matrix workspace. More...

MatrixWorkspace_sptr	multiply (const MatrixWorkspace_sptr lhs, const double &rhsValue)
	Multiply a matrix workspace by a single value. More...

MatrixWorkspace_sptr	multiply (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
	Multiply a matrix workspace by another matrix workspace. More...

MatrixWorkspace_sptr	plus (const MatrixWorkspace_sptr lhs, const double &rhsValue)
	Add a single value to a matrix workspace. More...

MatrixWorkspace_sptr	plus (const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs)
	Add a matrix workspace to another matrix workspace. More...

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. More...

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)

Protected Attributes inherited from Mantid::API::GenericDataProcessorAlgorithm< Base >
bool	m_useMPI
	MPI option. If false, we will use one job event if MPI is available. More...

Detailed Description

DgsReduction : This is the top-level workflow algorithm for controlling direct geometry spectrometer reduction.

Date: 2012-06-06

Definition at line 21 of file DgsReduction.h.

Member Function Documentation

◆ category()

const std::string Mantid::WorkflowAlgorithms::DgsReduction::category ( ) const

override

Algorithm's category for identification.

See also: Algorithm::category

Definition at line 43 of file DgsReduction.cpp.

◆ exec()

void Mantid::WorkflowAlgorithms::DgsReduction::exec ( )

overrideprivate

Execute the algorithm.

!! There is Property outputMaskWorkspace to get masks? It looks like one

Definition at line 526 of file DgsReduction.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::createChildAlgorithm(), Mantid::API::GenericDataProcessorAlgorithm< Base >::divide(), Mantid::Kernel::Logger::error(), Mantid::Kernel::InstrumentInfo::facility(), Mantid::API::g_log, Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty(), Mantid::API::GenericDataProcessorAlgorithm< Base >::getPropertyValue(), Mantid::Kernel::SingletonHolder< T >::Instance(), loadGroupingFile(), loadHardMask(), loadInputData(), Mantid::Kernel::FacilityInfo::name(), Mantid::Kernel::Logger::notice(), Mantid::Kernel::Direction::Output, reductionManager, and Mantid::Kernel::ProgressBase::report().

◆ getParameter()

double Mantid::WorkflowAlgorithms::DgsReduction::getParameter	(	const std::string &	algParam,
		const API::MatrixWorkspace_sptr &	ws,
		const std::string &	altParam
	)

private

Definition at line 514 of file DgsReduction.cpp.

References Mantid::EMPTY_DBL(), and Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty().

◆ init()

void Mantid::WorkflowAlgorithms::DgsReduction::init ( )

overrideprivate

Initialize the algorithm's properties.

Definition at line 47 of file DgsReduction.cpp.

References Mantid::EMPTY_DBL(), Mantid::EMPTY_INT(), Mantid::Kernel::Direction::Input, Mantid::Kernel::IS_EQUAL_TO, Mantid::Kernel::IS_NOT_EQUAL_TO, Mantid::API::PropertyMode::Optional, Mantid::API::FileProperty::OptionalLoad, Mantid::API::FileProperty::OptionalSave, and Mantid::Kernel::Direction::Output.

◆ loadGroupingFile()

MatrixWorkspace_sptr Mantid::WorkflowAlgorithms::DgsReduction::loadGroupingFile ( const std::string & prop )

private

Definition at line 492 of file DgsReduction.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::createChildAlgorithm(), Mantid::API::g_log, Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty(), reductionManager, and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ loadHardMask()

MatrixWorkspace_sptr Mantid::WorkflowAlgorithms::DgsReduction::loadHardMask ( )

private

Definition at line 466 of file DgsReduction.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::createChildAlgorithm(), Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty(), reductionManager, and tmp.

Referenced by exec().

◆ loadInputData()

Workspace_sptr Mantid::WorkflowAlgorithms::DgsReduction::loadInputData	(	const std::string &	prop,
		const bool	mustLoad = `true`
	)

private

Create a workspace by either loading a file or using an existing workspace.

Definition at line 413 of file DgsReduction.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::API::g_log, Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty(), Mantid::API::GenericDataProcessorAlgorithm< Base >::getPropertyValue(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::API::GenericDataProcessorAlgorithm< Base >::load(), reductionManager, and Mantid::API::GenericDataProcessorAlgorithm< Base >::setLoadAlg().

Referenced by exec().

◆ name()

const std::string Mantid::WorkflowAlgorithms::DgsReduction::name ( ) const

override

Algorithm's name for identification.

See also: Algorithm::name

Definition at line 37 of file DgsReduction.cpp.

◆ summary()

const std::string Mantid::WorkflowAlgorithms::DgsReduction::summary ( ) const

inlineoverride

Summary of algorithms purpose.

Definition at line 25 of file DgsReduction.h.

◆ version()

int Mantid::WorkflowAlgorithms::DgsReduction::version ( ) const

override

Algorithm's version for identification.

See also: Algorithm::version

Definition at line 40 of file DgsReduction.cpp.

Member Data Documentation

◆ reductionManager

std::shared_ptr<Kernel::PropertyManager> Mantid::WorkflowAlgorithms::DgsReduction::reductionManager

private

Definition at line 38 of file DgsReduction.h.

Referenced by exec(), loadGroupingFile(), loadHardMask(), and loadInputData().

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

Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsReduction.h
Framework/WorkflowAlgorithms/src/DgsReduction.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ category()

◆ exec()

◆ getParameter()

◆ init()

◆ loadGroupingFile()

◆ loadHardMask()

◆ loadInputData()

◆ name()

◆ summary()

◆ version()

Member Data Documentation

◆ reductionManager