LoadEventAndCompress : TODO: DESCRIPTION. More...

#include <LoadEventAndCompress.h>

Inheritance diagram for Mantid::WorkflowAlgorithms::LoadEventAndCompress:

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

const std::string	name () const override
	Algorithms name for identification. More...

const std::vector< std::string >	seeAlso () const override

const std::string	summary () const override
	Algorithm's summary for use in the GUI and help. 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...

Protected Member Functions
API::ITableWorkspace_sptr	determineChunk (const std::string &filename) override

Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const override

API::MatrixWorkspace_sptr	loadChunk (const size_t rowIndex) override

API::MatrixWorkspace_sptr	processChunk (API::MatrixWorkspace_sptr &wksp)
	Process a chunk in-place. More...

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)

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

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

Private Attributes
API::ITableWorkspace_sptr	m_chunkingTable

double	m_filterBadPulses

Additional Inherited Members
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

LoadEventAndCompress : TODO: DESCRIPTION.

Definition at line 18 of file LoadEventAndCompress.h.

Member Function Documentation

◆ category()

const string Mantid::WorkflowAlgorithms::LoadEventAndCompress::category ( ) const

override

Algorithm's category for identification.

See also: Algorithm::category

Definition at line 37 of file LoadEventAndCompress.cpp.

◆ determineChunk()

ITableWorkspace_sptr Mantid::WorkflowAlgorithms::LoadEventAndCompress::determineChunk ( const std::string & filename )

overrideprotectedvirtual

See also: DataProcessorAlgorithm::determineChunk(const std::string &)

Reimplemented from Mantid::API::GenericDataProcessorAlgorithm< Base >.

Definition at line 102 of file LoadEventAndCompress.cpp.

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

Referenced by exec().

◆ exec()

void Mantid::WorkflowAlgorithms::LoadEventAndCompress::exec ( )

overrideprivate

Execute the algorithm.

Definition at line 198 of file LoadEventAndCompress.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::assemble(), Mantid::API::GenericDataProcessorAlgorithm< Base >::createChildAlgorithm(), determineChunk(), Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty(), Mantid::API::GenericDataProcessorAlgorithm< Base >::getPropertyValue(), loadChunk(), m_chunkingTable, m_filterBadPulses, processChunk(), Mantid::Kernel::ProgressBase::report(), and Mantid::Kernel::ProgressBase::resetNumSteps().

◆ getParallelExecutionMode()

Parallel::ExecutionMode Mantid::WorkflowAlgorithms::LoadEventAndCompress::getParallelExecutionMode ( const std::map< std::string, Parallel::StorageMode > & storageModes ) const

overrideprotected

Definition at line 252 of file LoadEventAndCompress.cpp.

◆ init()

void Mantid::WorkflowAlgorithms::LoadEventAndCompress::init ( )

overrideprivate

Initialize the algorithm's properties.

Definition at line 45 of file LoadEventAndCompress.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::copyProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), and Mantid::Kernel::IS_EQUAL_TO.

◆ loadChunk()

MatrixWorkspace_sptr Mantid::WorkflowAlgorithms::LoadEventAndCompress::loadChunk ( const size_t rowIndex )

overrideprotectedvirtual

See also: DataProcessorAlgorithm::loadChunk(const size_t)

Reimplemented from Mantid::API::GenericDataProcessorAlgorithm< Base >.

Definition at line 120 of file LoadEventAndCompress.cpp.

References Mantid::API::GenericDataProcessorAlgorithm< Base >::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::API::g_log, Mantid::API::GenericDataProcessorAlgorithm< Base >::getProperty(), m_chunkingTable, m_filterBadPulses, and name().

Referenced by exec().

◆ name()

const string Mantid::WorkflowAlgorithms::LoadEventAndCompress::name ( ) const

override

Algorithms name for identification.

See also: Algorithm::name

Definition at line 31 of file LoadEventAndCompress.cpp.

Referenced by loadChunk().

◆ processChunk()

API::MatrixWorkspace_sptr Mantid::WorkflowAlgorithms::LoadEventAndCompress::processChunk ( API::MatrixWorkspace_sptr & wksp )

protected

Process a chunk in-place.

Definition at line 173 of file LoadEventAndCompress.cpp.

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

Referenced by exec().

◆ seeAlso()

const std::vector< std::string > Mantid::WorkflowAlgorithms::LoadEventAndCompress::seeAlso ( ) const

inlineoverride

Definition at line 22 of file LoadEventAndCompress.h.

◆ summary()

const string Mantid::WorkflowAlgorithms::LoadEventAndCompress::summary ( ) const

override

Algorithm's summary for use in the GUI and help.

See also: Algorithm::summary

Definition at line 40 of file LoadEventAndCompress.cpp.

◆ version()

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

override

Algorithm's version for identification.

See also: Algorithm::version

Definition at line 34 of file LoadEventAndCompress.cpp.

Member Data Documentation

◆ m_chunkingTable

API::ITableWorkspace_sptr Mantid::WorkflowAlgorithms::LoadEventAndCompress::m_chunkingTable

private

Definition at line 38 of file LoadEventAndCompress.h.

Referenced by exec(), and loadChunk().

◆ m_filterBadPulses

double Mantid::WorkflowAlgorithms::LoadEventAndCompress::m_filterBadPulses

private

Definition at line 39 of file LoadEventAndCompress.h.

Referenced by exec(), loadChunk(), and processChunk().

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ category()

◆ determineChunk()

◆ exec()

◆ getParallelExecutionMode()

◆ init()

◆ loadChunk()

◆ name()

◆ processChunk()

◆ seeAlso()

◆ summary()

◆ version()

Member Data Documentation

◆ m_chunkingTable

◆ m_filterBadPulses