ConvertToMD : Transform a workspace into MD workspace with components defined by user. More...

#include <ConvertToMD.h>

Inheritance diagram for Mantid::MDAlgorithms::ConvertToMD:

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

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

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::MDAlgorithms::ConvertToMDParent
const std::string	category () const override
	Algorithm's category for identification.

Public Member Functions inherited from Mantid::API::Algorithm
	Algorithm ()
	Constructor.

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor.

void	initialize () override
	Initialization method invoked by the framework.

bool	execute () override final
	The actions to be performed by the algorithm on a dataset.

void	addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)

void	executeAsChildAlg () override
	Execute as a Child Algorithm.

ExecutionState	executionState () const override
	Gets the current execution state.

ResultState	resultState () const override
	Gets the current result State.

bool	isInitialized () const override
	Has the Algorithm already been initialized.

bool	isExecuted () const override
	Has the Algorithm already been executed successfully.

bool	isRunning () const override
	True if the algorithm is running.

bool	isReadyForGarbageCollection () const override
	True if the algorithm is ready for garbage collection.

bool	isChild () const override
	To query whether algorithm is a child.

void	setChild (const bool isChild) override
	To set whether algorithm is a child.

void	enableHistoryRecordingForChild (const bool on) override
	Change the state of the history recording flag.

bool	isRecordingHistoryForChild ()

void	setAlwaysStoreInADS (const bool doStore) override
	Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms.

bool	getAlwaysStoreInADS () const override
	Returns true if we always store in the AnalysisDataService.

void	setRethrows (const bool rethrow) override
	Set whether the algorithm will rethrow exceptions.

Poco::ActiveResult< bool >	executeAsync () override
	Asynchronous execution.

void	addObserver (const Poco::AbstractObserver &observer) const override
	Add an observer for a notification.

void	removeObserver (const Poco::AbstractObserver &observer) const override
	Remove an observer.

void	cancel () override
	Raises the cancel flag.

bool	getCancel () const
	Returns the cancellation state.

Kernel::Logger &	getLogger () const
	Returns a reference to the logger.

void	setLogging (const bool value) override
	Logging can be disabled by passing a value of false.

bool	isLogging () const override
	returns the status of logging, True = enabled

void	setLoggingOffset (const int value) override
	gets the logging priority offset

int	getLoggingOffset () const override
	returns the logging priority offset

void	setAlgStartupLogging (const bool enabled) override
	disable Logging of start and end messages

bool	getAlgStartupLogging () const override
	get the state of Logging of start and end messages

void	setChildStartProgress (const double startProgress) const override
	setting the child start progress

void	setChildEndProgress (const double endProgress) const override
	setting the child end progress

std::string	toString () const override
	Serialize an object to a string.

::Json::Value	toJson () const override
	Serialize an object to a json object.

virtual 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)
	Create a Child Algorithm.

void	setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true)
	Setup algorithm as child algorithm.

void	trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist)
	set whether we wish to track the child algorithm's history and pass it the parent object to fill.

void	findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const
	Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output)

virtual bool	checkGroups ()
	Check the input workspace properties for groups.

virtual bool	processGroups ()
	Process WorkspaceGroup inputs.

void	copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum)
	Copy all the non-workspace properties from this to alg.

void	declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add a property to the list of managed properties.

void	declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add or replace property in the list of managed properties.

void	resetProperties () override
	Reset property values back to initial values (blank or default values)

void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by one string of values, separated by semicolons.

void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Sets all the declared properties from a json object.

void	setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override
	Sets all the declared properties from a string.

void	setPropertyValue (const std::string &name, const std::string &value) override
	Set the value of a property by string N.B.

void	setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
	Set the value of a property by Json::Value object.

void	setPropertyOrdinal (const int &index, const std::string &value) override
	Set the value of a property by an index N.B.

virtual void	copyPropertiesFrom (const Algorithm &alg)
	Make m_properties point to the same PropertyManager as alg.m_properties.

bool	existsProperty (const std::string &name) const override
	Checks whether the named property is already in the list of managed property.

bool	validateProperties () const override
	Validates all the properties in the collection.

size_t	propertyCount () const override
	Count the number of properties under management.

std::string	getPropertyValue (const std::string &name) const override
	Get the value of a property as a string.

const std::vector< Kernel::Property * > &	getProperties () const override
	Get the list of managed properties.

std::vector< std::string >	getDeclaredPropertyNames () const noexcept override
	Return the list of declared property names.

TypedValue	getProperty (const std::string &name) const override
	Get the value of a property.

std::string	asString (bool withDefaultValues=false) const override
	Return the property manager serialized as a string.

::Json::Value	asJson (bool withDefaultValues=false) const override
	Return the property manager serialized as a json object.

bool	isDefault (const std::string &name) const

void	removeProperty (const std::string &name, const bool delproperty=true) override
	Removes the property from management.

std::unique_ptr< Kernel::Property >	takeProperty (const size_t index) override
	Removes the property from management and returns a pointer to it.

void	clear () override
	Clears all properties under management.

void	afterPropertySet (const std::string &) override
	Override this method to perform a custom action right after a property was set.

Kernel::Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name.

Kernel::Property *	getPointerToPropertyOrdinal (const int &index) const override
	Get a property by an index.

virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them)

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.

const std::vector< std::string >	categories () const override
	Function to return all of the categories that contain this algorithm.

const std::string	categorySeparator () const override
	Function to return the separator token for the category string.

const std::string	alias () const override
	function to return any aliases to the algorithm; A default implementation is provided

const std::string	aliasDeprecated () const override
	Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date.

const std::string	helpURL () const override
	function to return URL for algorithm documentation; A default implementation is provided.

template<typename T , typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet >	getWorkspaceAndIndices (const std::string &name) const
	Mechanism for retriving the index property.

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)
	Mechanism for setting the index property with a workspace shared pointer.

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)
	Mechanism for setting the index property with a workspace shared pointer.

const std::string	workspaceMethodName () const override

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

const std::string	workspaceMethodInputProperty () const override

AlgorithmID	getAlgorithmID () const override
	Algorithm ID.

Algorithms As Methods
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.

virtual void	filterByProperty (Mantid::Kernel::LogFilter *, const std::vector< std::string > &)

std::vector< Property * >	getPropertiesInGroup (const std::string &group) const
	Get the list of managed properties in a given group.

IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *.

IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string.

template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue.

template<typename T >
IPropertyManager *	setProperty (const std::string &name, std::unique_ptr< T > value)
	Templated method to set the value of a PropertyWithValue from a std::unique_ptr.

void	setPropertyGroup (const std::string &name, const std::string &group)
	Set the group for a given property.

void	setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)

void	updatePropertyValues (const IPropertyManager &other)
	Update values of the existing properties.

virtual	~IPropertyManager ()=default

Protected Member Functions
void	addExperimentInfo (API::IMDEventWorkspace_sptr &mdEventWS, MDAlgorithms::MDWSDescription &targWSDescr) const
	par of store metadata routine which generate metadata necessary for initializing ConvertToMD plugin

bool	buildTargetWSDescription (const API::IMDEventWorkspace_sptr &spws, const std::string &QModReq, const std::string &dEModReq, const std::vector< std::string > &otherDimNames, std::vector< double > &dimMin, std::vector< double > &dimMax, const std::string &QFrame, const std::string &convertTo_, MDAlgorithms::MDWSDescription &targWSDescr)
	handle the input parameters and build target workspace description as function of input parameters

void	copyMetaData (API::IMDEventWorkspace_sptr &mdEventWS) const
	Store metadata and set some metadata, needed for plugin to run on the target workspace description.

API::IMDEventWorkspace_sptr	createNewMDWorkspace (const MDAlgorithms::MDWSDescription &targWSDescr, const bool filebackend, const std::string &filename)
	Create new MD workspace using existing parameters for algorithm.

bool	doWeNeedNewTargetWorkspace (const API::IMDEventWorkspace_sptr &spws)
	Check if target workspace new or existing one and we need to create new workspace.

void	findMinMax (const Mantid::API::MatrixWorkspace_sptr &inWS, const std::string &QMode, const std::string &dEMode, const std::string &QFrame, const std::string &ConvertTo, const std::vector< std::string > &otherDim, std::vector< double > &minVal, std::vector< double > &maxVal)
	Method takes min-max values from algorithm parameters if they are present or calculates default min-max values if these values were not supplied to the method or the supplied value is incorrect.

void	setupTopLevelSplitting (const Mantid::API::BoxController_sptr &bc)
	Sets up the top level splitting, i.e. of level 0, for the box controller.

Protected Member Functions inherited from Mantid::MDAlgorithms::ConvertToMDParent
void	init () override
	Initialize the algorithm's properties.

template<class T >
bool	isNaN (T val)
	Template to check if a variable equal to NaN.

DataObjects::TableWorkspace_const_sptr	preprocessDetectorsPositions (const Mantid::API::MatrixWorkspace_const_sptr &InWS2D, const std::string &dEModeRequested, bool updateMasks, const std::string &OutWSName)
	The method responsible for analyzing input workspace parameters and preprocessing detectors positions into reciprocal space.

DataObjects::TableWorkspace_sptr	runPreprocessDetectorsToMDChildUpdatingMasks (const Mantid::API::MatrixWorkspace_const_sptr &InWS2D, const std::string &OutWSName, const std::string &dEModeRequested, Kernel::DeltaEMode::Type &Emode)

Protected Member Functions inherited from Mantid::API::BoxControllerSettingsAlgorithm
std::string	getBoxSettingsGroupName ()

void	initBoxControllerProps (const std::string &SplitInto="5", int SplitThreshold=1000, int MaxRecursionDepth=5)
	Initialise the properties.

void	setBoxController (const Mantid::API::BoxController_sptr &bc)
	Set the settings in the given box controller.

void	setBoxController (const Mantid::API::BoxController_sptr &bc, const Mantid::Geometry::Instrument_const_sptr &instrument)
	Set the settings in the given box controller.

void	takeDefaultsFromInstrument (const Mantid::Geometry::Instrument_const_sptr &instrument, const size_t ndims)
	Take the defaults for the box splitting from the instrument parameters.

Protected Member Functions inherited from Mantid::API::Algorithm
virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm.

void	cacheWorkspaceProperties ()
	Go through the properties and cache the input/output workspace properties for later use.

void	cacheInputWorkspaceHistories ()
	Cache the histories of any input workspaces so they can be copied over after algorithm completion.

void	setExecutionState (const ExecutionState state)
	Sets the current execution state.

void	setResultState (const ResultState state)
	Sets the result execution state.

void	store ()
	Stores any output workspaces into the AnalysisDataService.

void	progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
	Sends ProgressNotification.

void	interruption_point ()
	This is called during long-running operations, and check if the algorithm has requested that it be cancelled.

Poco::NotificationCenter &	notificationCenter () const
	Return a reference to the algorithm's notification dispatcher.

void	handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
	Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm.

const Poco::AbstractObserver &	progressObserver () const
	Return a reference to the algorithm's object that is reporting progress.

bool	isWorkspaceProperty (const Kernel::Property *const prop) const
	checks the property is a workspace property

bool	trackingHistory ()
	get whether we are tracking the history for this algorithm,

virtual void	fillHistory ()
	Copy workspace history from input workspaces to output workspaces and record the history for ths algorithm.

void	fillHistory (const std::vector< Workspace_sptr > &outputWorkspaces)
	Copy workspace history from input workspaces to provided vector of output workspaces.

virtual void	setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
	Virtual method to set the non workspace properties for this algorithm.

template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
void	declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)
	Declare a property which defines the workspace and allowed index types, as well as a property for capturing the indices all at once.

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property.

template<>
MANTID_KERNEL_DLL PropertyManager_sptr	getValue (const std::string &name) const

template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr	getValue (const std::string &name) const

Protected Attributes
Mantid::API::MatrixWorkspace_sptr	m_InWS2D
	pointer to the input workspace;

std::shared_ptr< MDAlgorithms::MDEventWSWrapper >	m_OutWSWrapper

Protected Attributes inherited from Mantid::MDAlgorithms::ConvertToMDParent
std::shared_ptr< MDAlgorithms::ConvToMDBase >	m_Convertor
	pointer to the class, which does the particular conversion

Protected Attributes inherited from Mantid::API::Algorithm
std::atomic< bool >	m_cancel
	Set to true to stop execution.

std::atomic< bool >	m_parallelException
	Set if an exception is thrown, and not caught, within a parallel region.

std::vector< IWorkspaceProperty * >	m_inputWorkspaceProps
	All the WorkspaceProperties that are Input or InOut. Set in execute()

std::shared_ptr< AlgorithmHistory >	m_history
	Pointer to the history for the algorithm being executed.

Kernel::Logger	m_log
	Logger for this algorithm.

Kernel::Logger &	g_log

std::shared_ptr< AlgorithmHistory >	m_parentHistory
	Pointer to the parent history object (if set)

std::vector< WorkspaceVector >	m_unrolledInputWorkspaces
	One vector of workspaces for each input workspace property.

size_t	m_groupSize
	Size of the group(s) being processed.

bool	m_usingBaseProcessGroups = false
	distinguish between base processGroups() and overriden/algorithm specific versions

Private Member Functions
void	exec () override
	Virtual method - must be overridden by concrete algorithm.

void	init () override
	Virtual method - must be overridden by concrete algorithm.

void	setupFileBackend (const std::string &filebackPath, const API::IMDEventWorkspace_sptr &outputWS)
	Setup the filebackend for the output workspace.

std::map< std::string, std::string >	validateInputs () override
	Perform validation of ALL the input properties of the algorithm.

Private Attributes
boost::scoped_ptr< API::Progress >	m_Progress
	progress reporter

Additional Inherited Members
Public Types inherited from Mantid::API::Algorithm
using	WorkspaceVector = std::vector< std::shared_ptr< Workspace > >

Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr	fromString (const std::string &input)
	De-serialize an object from a string.

static IAlgorithm_sptr	fromJson (const Json::Value &input)
	De-serialize an object from a Json.

static IAlgorithm_sptr	fromHistory (const AlgorithmHistory &history)
	Construct an object from a history entry.

Public Attributes inherited from Mantid::API::Algorithm
bool	calledByAlias = false
	Flag to indicate if the algorithm is called by its alias.

Static Protected Member Functions inherited from Mantid::API::Algorithm
template<typename NumT >
static bool	isEmpty (const NumT toCheck)
	checks that the value was not set by users, uses the value in empty double/int.

Static Protected Attributes inherited from Mantid::MDAlgorithms::ConvertToMDParent
static Mantid::Kernel::Logger &	g_Log
	logger -> to provide logging, for MD dataset file operations

Static Protected Attributes inherited from Mantid::API::Algorithm
static size_t	g_execCount = 0
	Counter to keep track of algorithm execution order.

Detailed Description

ConvertToMD : Transform a workspace into MD workspace with components defined by user.

Gateway for number of ChildTransformations, provided by ConvertToMD factory. Intended to cover wide range of cases;

The detailed description of the algorithm is provided at dev-docs/source/WritingCustomConvertToMDTransformation.rst. Convert to MD Events class itself:

Definition at line 32 of file ConvertToMD.h.

Member Function Documentation

◆ addExperimentInfo()

void Mantid::MDAlgorithms::ConvertToMD::addExperimentInfo	(	API::IMDEventWorkspace_sptr &	mdEventWS,
		MDAlgorithms::MDWSDescription &	targWSDescr
	)		const

protected

par of store metadata routine which generate metadata necessary for initializing ConvertToMD plugin

Copy over the part of metadata necessary to initialize ConvertToMD plugin from the input matrix workspace to output MDEventWorkspace.

Parameters

mdEventWS	:: The output MDEventWorkspace
targWSDescr	:: The description of the target workspace, used in the algorithm

Definition at line 308 of file ConvertToMD.cpp.

References Mantid::API::LogManager::addProperty(), Mantid::API::LogManager::getPropertyValueAsType(), Mantid::Kernel::Matrix< T >::getVector(), m_InWS2D, and Mantid::MDAlgorithms::MDWSDescription::m_Wtransf.

Referenced by exec().

◆ buildTargetWSDescription()

bool Mantid::MDAlgorithms::ConvertToMD::buildTargetWSDescription	(	const API::IMDEventWorkspace_sptr &	spws,
		const std::string &	QModReq,
		const std::string &	dEModReq,
		const std::vector< std::string > &	otherDimNames,
		std::vector< double > &	dimMin,
		std::vector< double > &	dimMax,
		const std::string &	QFrame,
		const std::string &	convertTo_,
		MDAlgorithms::MDWSDescription &	targWSDescr
	)

protected

handle the input parameters and build target workspace description as function of input parameters

Parameters

spws	shared pointer to target MD workspace (just created or already existing)
QModReq	– mode to convert momentum
dEModReq	– mode to convert energy
otherDimNames	– the vector of additional dimensions names (if any)
dimMin	– the vector of minimal values for all dimensions of the workspace; on input it is copied from the algorithm parameters, on output it is defined from MD workspace of matrix workspace depending on how well input parameters are defined
dimMax	– the vector of maximal values for all dimensions of the workspace; is set up similarly to dimMin
QFrame	– in Q3D case this describes target coordinate system and is ignored in any other case
convertTo_	– The parameter describing Q-scaling transformations
targWSDescr	– the resulting class used to interpret all parameters together and used to describe selected transformation.

Definition at line 409 of file ConvertToMD.cpp.

Referenced by exec().

◆ copyMetaData()

void Mantid::MDAlgorithms::ConvertToMD::copyMetaData ( API::IMDEventWorkspace_sptr & mdEventWS ) const

protected

Store metadata and set some metadata, needed for plugin to run on the target workspace description.

Copy over the metadata from the input matrix workspace to output MDEventWorkspace.

Parameters

mdEventWS :: The output MDEventWorkspace where metadata are copied to. The source of the metadata is the input matrix workspace

Definition at line 332 of file ConvertToMD.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, Mantid::Kernel::Logger::information(), Mantid::MDAlgorithms::ConvertToMDParent::m_Convertor, m_InWS2D, and Mantid::MDAlgorithms::UnitsConversionHelper::updateConversion().

Referenced by exec().

◆ createNewMDWorkspace()

API::IMDEventWorkspace_sptr Mantid::MDAlgorithms::ConvertToMD::createNewMDWorkspace	(	const MDAlgorithms::MDWSDescription &	targWSDescr,
		const bool	filebackend,
		const std::string &	filename
	)

protected

Create new MD workspace using existing parameters for algorithm.

Create new MD workspace and set up its box controller using algorithm's box controllers properties.

Parameters

targWSDescr	:: Description of workspace to create
filebackend	:: true if the workspace will have a file back end
filename	:: file to use for file back end of workspace

Returns: :: Shared pointer for the created workspace

Definition at line 513 of file ConvertToMD.cpp.

References Mantid::Kernel::Logger::error(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), m_InWS2D, m_OutWSWrapper, Mantid::MDAlgorithms::MDWSDescription::nDimensions(), Mantid::API::BoxControllerSettingsAlgorithm::setBoxController(), setupFileBackend(), and setupTopLevelSplitting().

Referenced by exec().

◆ doWeNeedNewTargetWorkspace()

bool Mantid::MDAlgorithms::ConvertToMD::doWeNeedNewTargetWorkspace ( const API::IMDEventWorkspace_sptr & spws )

protected

Check if target workspace new or existing one and we need to create new workspace.

Check if the target workspace new or exists and we need to create new workspace.

Parameters

spws	– shared pointer to target MD workspace, which can be undefined if the workspace does not exist

Returns: true if one needs to create new workspace and false otherwise

Definition at line 578 of file ConvertToMD.cpp.

References Mantid::API::Algorithm::getProperty().

Referenced by buildTargetWSDescription().

◆ exec()

void Mantid::MDAlgorithms::ConvertToMD::exec ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

copy & retrieve metadata, necessary to initialize convertToMD Plugin, including getting the unique number, that identifies the run, the source workspace came from.

Implements Mantid::API::Algorithm.

Definition at line 187 of file ConvertToMD.cpp.

◆ findMinMax()

void Mantid::MDAlgorithms::ConvertToMD::findMinMax	(	const Mantid::API::MatrixWorkspace_sptr &	inWS,
		const std::string &	QMode,
		const std::string &	dEMode,
		const std::string &	QFrame,
		const std::string &	ConvertTo,
		const std::vector< std::string > &	otherDim,
		std::vector< double > &	minVal,
		std::vector< double > &	maxVal
	)

protected

Method takes min-max values from algorithm parameters if they are present or calculates default min-max values if these values were not supplied to the method or the supplied value is incorrect.

Parameters

inWS	– the shared pointer to the source workspace
QMode	– the string which defines algorithms Q-conversion mode
dEMode	– the string describes the algorithms energy conversion mode
QFrame	– in Q3D case this describes target coordinate system and is ignored in any other caste
ConvertTo	– The parameter describing Q-scaling transformations
otherDim	– the vector of other dimension names (if any) Input-output values:
minVal	– the vector with min values for the algorithm
maxVal	– the vector with max values for the algorithm

Definition at line 607 of file ConvertToMD.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::DeltaEMode::fromString(), Mantid::API::g_log, Mantid::MDAlgorithms::MDTransfInterface::getNMatrixDimensions(), Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), and Mantid::Geometry::MDHistoDimensionBuilder::resizeToFitMDBox().

Referenced by buildTargetWSDescription().

◆ init()

void Mantid::MDAlgorithms::ConvertToMD::init ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

Implements Mantid::API::Algorithm.

Definition at line 49 of file ConvertToMD.cpp.

References Mantid::MDAlgorithms::ConvertToMDParent::init(), Mantid::Kernel::Direction::Input, Mantid::Kernel::IS_EQUAL_TO, Mantid::API::FileProperty::OptionalSave, and Mantid::Kernel::Direction::Output.

◆ name()

const std::string Mantid::MDAlgorithms::ConvertToMD::name ( ) const

overridevirtual

Algorithm's name for identification.

Implements Mantid::MDAlgorithms::ConvertToMDParent.

Definition at line 121 of file ConvertToMD.cpp.

Referenced by buildTargetWSDescription().

◆ seeAlso()

const std::vector< std::string > Mantid::MDAlgorithms::ConvertToMD::seeAlso ( ) const

inlineoverridevirtual

Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

Reimplemented from Mantid::API::Algorithm.

Definition at line 46 of file ConvertToMD.h.

◆ setupFileBackend()

void Mantid::MDAlgorithms::ConvertToMD::setupFileBackend	(	const std::string &	filebackPath,
		const API::IMDEventWorkspace_sptr &	outputWS
	)

private

Setup the filebackend for the output workspace.

It assumes that the box controller has already been initialized

Parameters

filebackPath	:: Path to the file used for backend storage
outputWS	:: Workspace on which to set the file back end

Definition at line 709 of file ConvertToMD.cpp.

References Mantid::API::Algorithm::createChildAlgorithm().

Referenced by createNewMDWorkspace().

◆ setupTopLevelSplitting()

void Mantid::MDAlgorithms::ConvertToMD::setupTopLevelSplitting ( const Mantid::API::BoxController_sptr & bc )

protected

Sets up the top level splitting, i.e. of level 0, for the box controller.

Splits the top level box at level 0 into a defined number of subboxes for the the first level.

Parameters

bc	A pointer to the box controller.

Definition at line 557 of file ConvertToMD.cpp.

Referenced by createNewMDWorkspace().

◆ summary()

const std::string Mantid::MDAlgorithms::ConvertToMD::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 37 of file ConvertToMD.h.

◆ validateInputs()

std::map< std::string, std::string > Mantid::MDAlgorithms::ConvertToMD::validateInputs ( void )

overrideprivatevirtual

Perform validation of ALL the input properties of the algorithm.

This is to be overridden by specific algorithms. It will be called in dialogs after parsing all inputs and setting the properties, but BEFORE executing.

Returns: a map where: Key = string name of the property; Value = string describing the problem with the property.

Reimplemented from Mantid::API::Algorithm.

Definition at line 125 of file ConvertToMD.cpp.

References Mantid::API::Algorithm::getProperty(), and Mantid::MDAlgorithms::ConvToMDEventsWSIndexing::isSplitValid().

◆ version()

int Mantid::MDAlgorithms::ConvertToMD::version ( ) const

overridevirtual

Algorithm's version for identification.

Implements Mantid::MDAlgorithms::ConvertToMDParent.

Definition at line 123 of file ConvertToMD.cpp.

Member Data Documentation

◆ m_InWS2D

Mantid::API::MatrixWorkspace_sptr Mantid::MDAlgorithms::ConvertToMD::m_InWS2D

protected

pointer to the input workspace;

Definition at line 63 of file ConvertToMD.h.

Referenced by addExperimentInfo(), buildTargetWSDescription(), copyMetaData(), createNewMDWorkspace(), and exec().

◆ m_OutWSWrapper

std::shared_ptr<MDAlgorithms::MDEventWSWrapper> Mantid::MDAlgorithms::ConvertToMD::m_OutWSWrapper

protected

Definition at line 66 of file ConvertToMD.h.

Referenced by createNewMDWorkspace(), and exec().

◆ m_Progress

boost::scoped_ptr<API::Progress> Mantid::MDAlgorithms::ConvertToMD::m_Progress

private

progress reporter

Definition at line 56 of file ConvertToMD.h.

Referenced by exec().

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

Framework/MDAlgorithms/inc/MantidMDAlgorithms/ConvertToMD.h
Framework/MDAlgorithms/src/ConvertToMD.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addExperimentInfo()

◆ buildTargetWSDescription()

◆ copyMetaData()

◆ createNewMDWorkspace()

◆ doWeNeedNewTargetWorkspace()

◆ exec()

◆ findMinMax()

◆ init()

◆ name()

◆ seeAlso()

◆ setupFileBackend()

◆ setupTopLevelSplitting()

◆ summary()

◆ validateInputs()

◆ version()

Member Data Documentation

◆ m_InWS2D

◆ m_OutWSWrapper

◆ m_Progress