Converts the units in which a workspace is represented. More...

#include <ConvertUnits.h>

Inheritance diagram for Mantid::Algorithms::ConvertUnits:

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification overriding a virtual method.

const std::string	name () const override
	Algorithm's name for identification overriding a virtual method.

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso algorithms related to this algorithm.

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

int	version () const override
	Algorithm's version for identification overriding a virtual method.

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.

std::map< std::string, std::string >	validateInputs () override
	Perform validation of ALL the input properties of the 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::string	category () const override
	function to return a category of the algorithm.

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::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	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
API::MatrixWorkspace_sptr	alignBins (const API::MatrixWorkspace_sptr &workspace)
	Calls Rebin as a Child Algorithm to align the bins.

const std::vector< double >	calculateRebinParams (const API::MatrixWorkspace_const_sptr &workspace) const
	The Rebin parameters should cover the full range of the converted unit, with the same number of bins.

API::MatrixWorkspace_sptr	convertQuickly (const API::MatrixWorkspace_const_sptr &inputWS, const double &factor, const double &power)
	Convert the workspace units according to a simple output = a * (input^b) relationship.

virtual API::MatrixWorkspace_sptr	convertViaTOF (Kernel::Unit_const_sptr fromUnit, API::MatrixWorkspace_const_sptr inputWS)
	Convert the workspace units using TOF as an intermediate step in the conversion.

void	exec () override
	Executes the algorithm.

API::MatrixWorkspace_sptr	executeUnitConversion (const API::MatrixWorkspace_sptr &inputWS)
	Executes the main part of the algorithm that handles the conversion of the units.

void	init () override
	Initialisation method.

void	putBackBinWidth (const API::MatrixWorkspace_sptr &outputWS)
	Divide by the bin width if workspace is a distribution.

API::MatrixWorkspace_sptr	removeUnphysicalBins (const API::MatrixWorkspace_const_sptr &workspace)
	For conversions to energy transfer, removes bins corresponding to inaccessible values.

void	reverse (const API::MatrixWorkspace_sptr &WS)
	Reverses the workspace if X values are in descending order.

void	setupMemberVariables (const API::MatrixWorkspace_const_sptr &inputWS)
	Initialise the member variables.

API::MatrixWorkspace_sptr	setupOutputWorkspace (const API::MatrixWorkspace_const_sptr &inputWS)
	Create an output workspace of the appropriate (histogram or event) type and copy over the data.

virtual void	storeEModeOnWorkspace (API::MatrixWorkspace_sptr outputWS)
	Stores the emode in the provided workspace.

const std::string	workspaceMethodInputProperty () const override
	Returns the name of the input workspace property used by the calling object.

const std::string	workspaceMethodName () const override

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
bool	m_distribution {false}
	Whether input is a distribution.

bool	m_inputEvents {false}
	to histogram workspaces.

Kernel::Unit_const_sptr	m_inputUnit
	The unit of the input workspace.

std::size_t	m_numberOfSpectra {0}
	The number of spectra in the input workspace.

Kernel::Unit_sptr	m_outputUnit
	The unit we're going to.

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

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::API::Algorithm
static size_t	g_execCount = 0
	Counter to keep track of algorithm execution order.

Detailed Description

Converts the units in which a workspace is represented.

Note that if you are converting to or from units which are not meaningful for monitor detectors, then you should not expect the resulting spectrum to hold meaningful values.

Definition at line 22 of file ConvertUnits.h.

Member Function Documentation

◆ alignBins()

API::MatrixWorkspace_sptr Mantid::Algorithms::ConvertUnits::alignBins ( const API::MatrixWorkspace_sptr & workspace )

protected

Calls Rebin as a Child Algorithm to align the bins.

Definition at line 486 of file ConvertUnits.cpp.

References calculateRebinParams(), Mantid::API::Algorithm::createChildAlgorithm(), and workspace.

Referenced by executeUnitConversion().

◆ calculateRebinParams()

const std::vector< double > Mantid::Algorithms::ConvertUnits::calculateRebinParams ( const API::MatrixWorkspace_const_sptr & workspace ) const

protected

The Rebin parameters should cover the full range of the converted unit, with the same number of bins.

Definition at line 501 of file ConvertUnits.cpp.

References workspace.

Referenced by alignBins().

◆ category()

const std::string Mantid::Algorithms::ConvertUnits::category ( ) const

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Implements Mantid::API::IAlgorithm.

Definition at line 34 of file ConvertUnits.h.

◆ convertQuickly()

MatrixWorkspace_sptr Mantid::Algorithms::ConvertUnits::convertQuickly	(	const API::MatrixWorkspace_const_sptr &	inputWS,
		const double &	factor,
		const double &	power
	)

protected

Convert the workspace units according to a simple output = a * (input^b) relationship.

Parameters

inputWS	:: the input workspace
factor	:: the conversion factor a to apply
power	:: the Power b to apply to the conversion

Returns: A shared pointer to the output workspace

Definition at line 297 of file ConvertUnits.cpp.

References m_inputEvents, m_numberOfSpectra, m_outputUnit, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::ProgressBase::report(), setupOutputWorkspace(), Mantid::Kernel::threadSafe(), and Mantid::Geometry::x.

Referenced by executeUnitConversion().

◆ convertViaTOF()

MatrixWorkspace_sptr Mantid::Algorithms::ConvertUnits::convertViaTOF	(	Kernel::Unit_const_sptr	fromUnit,
		API::MatrixWorkspace_const_sptr	inputWS
	)

protectedvirtual

Convert the workspace units using TOF as an intermediate step in the conversion.

Parameters

fromUnit	:: The unit of the input workspace
inputWS	:: The input workspace

Returns: A shared pointer to the output workspace

Todo:: No implementation for any of these in the geometry yet so using properties

Todo:: Don't yet consider hold-off (delta)

Definition at line 358 of file ConvertUnits.cpp.

References Mantid::API::LogManager::addProperty(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::delta, Mantid::Kernel::DeltaEMode::Direct, Mantid::Kernel::efixed, Mantid::EMPTY_DBL(), Mantid::Kernel::DeltaEMode::fromString(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), m_inputEvents, m_numberOfSpectra, m_outputUnit, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::ProgressBase::report(), setupOutputWorkspace(), Mantid::Kernel::threadSafe(), and Mantid::Kernel::Logger::warning().

Referenced by executeUnitConversion().

◆ exec()

void Mantid::Algorithms::ConvertUnits::exec ( )

overrideprotectedvirtual

Executes the algorithm.

Exceptions

std::runtime_error	:: Thrown in the following cases: If the input workspace has not had its unit set If the input workspace contains Points, but ConvertFromPointData has not been enabled. If ConvertFromPointData has been enabled, but the conversion to Bins or back to Points fails.
InstrumentDefinitionError	If unable to calculate source-sample distance

Implements Mantid::API::Algorithm.

Definition at line 85 of file ConvertUnits.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), executeUnitConversion(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::Logger::information(), m_inputUnit, m_outputUnit, Mantid::Kernel::IPropertyManager::setProperty(), and setupMemberVariables().

◆ executeUnitConversion()

MatrixWorkspace_sptr Mantid::Algorithms::ConvertUnits::executeUnitConversion ( const API::MatrixWorkspace_sptr & inputWS )

protected

Executes the main part of the algorithm that handles the conversion of the units.

Parameters

inputWS :: the input workspace that will be converted

Exceptions

std::runtime_error :: If the workspace has invalid X axis binning

Returns: A pointer to a MatrixWorkspace_sptr that contains the converted units

Definition at line 171 of file ConvertUnits.cpp.

References alignBins(), convertQuickly(), convertViaTOF(), Mantid::API::Algorithm::getProperty(), m_distribution, m_inputEvents, m_inputUnit, m_numberOfSpectra, m_outputUnit, putBackBinWidth(), removeUnphysicalBins(), and reverse().

Referenced by exec().

◆ init()

void Mantid::Algorithms::ConvertUnits::init ( )

overrideprotectedvirtual

Initialisation method.

Implements Mantid::API::Algorithm.

Definition at line 37 of file ConvertUnits.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_DBL(), Mantid::Kernel::Direction::Input, and Mantid::Kernel::Direction::Output.

◆ name()

const std::string Mantid::Algorithms::ConvertUnits::name ( ) const

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 25 of file ConvertUnits.h.

◆ putBackBinWidth()

void Mantid::Algorithms::ConvertUnits::putBackBinWidth ( const API::MatrixWorkspace_sptr & outputWS )

protected

Divide by the bin width if workspace is a distribution.

Parameters

outputWS The workspace to operate on

Definition at line 659 of file ConvertUnits.cpp.

References m_numberOfSpectra.

Referenced by executeUnitConversion().

◆ removeUnphysicalBins()

API::MatrixWorkspace_sptr Mantid::Algorithms::ConvertUnits::removeUnphysicalBins ( const API::MatrixWorkspace_const_sptr & workspace )

protected

For conversions to energy transfer, removes bins corresponding to inaccessible values.

Unwieldy method which removes bins which lie in a physically inaccessible region.

This presently only occurs in conversions to energy transfer, where the initial unit conversion sets them to +/-DBL_MAX. This method removes those bins, leading to a workspace which is smaller than the input one. As presently implemented, it unfortunately requires testing for and knowledge of aspects of the particular units conversion instead of keeping all that in the units class. It could be made more general, but that would be less efficient.

Parameters

workspace :: The workspace after initial unit conversion

Returns: The workspace after bins have been removed

Definition at line 575 of file ConvertUnits.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), workspace, Mantid::Geometry::X, and Mantid::Geometry::Y.

Referenced by executeUnitConversion().

◆ reverse()

void Mantid::Algorithms::ConvertUnits::reverse ( const API::MatrixWorkspace_sptr & WS )

protected

Reverses the workspace if X values are in descending order.

Parameters

WS	The workspace to operate on

Definition at line 527 of file ConvertUnits.cpp.

References Mantid::API::Algorithm::interruption_point(), PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, and Mantid::Kernel::threadSafe().

Referenced by Mantid::Algorithms::ConvertAxisByFormula::exec(), and executeUnitConversion().

◆ seeAlso()

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

inlineoverridevirtual

Function to return all of the seeAlso algorithms related to this algorithm.

Implements Mantid::API::IAlgorithm.

Definition at line 30 of file ConvertUnits.h.

◆ setupMemberVariables()

void Mantid::Algorithms::ConvertUnits::setupMemberVariables ( const API::MatrixWorkspace_const_sptr & inputWS )

protected

Initialise the member variables.

Parameters

inputWS The input workspace

Definition at line 226 of file ConvertUnits.cpp.

References Mantid::API::Algorithm::getPropertyValue(), m_distribution, m_inputEvents, m_inputUnit, m_numberOfSpectra, and m_outputUnit.

Referenced by exec().

◆ setupOutputWorkspace()

API::MatrixWorkspace_sptr Mantid::Algorithms::ConvertUnits::setupOutputWorkspace ( const API::MatrixWorkspace_const_sptr & inputWS )

protected

Create an output workspace of the appropriate (histogram or event) type and copy over the data.

Parameters

inputWS The input workspace

Definition at line 244 of file ConvertUnits.cpp.

References Mantid::API::Algorithm::getProperty(), m_distribution, m_inputEvents, m_numberOfSpectra, m_outputUnit, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::ProgressBase::report(), storeEModeOnWorkspace(), Mantid::Kernel::threadSafe(), Mantid::Geometry::X, and Mantid::Geometry::Y.

Referenced by convertQuickly(), and convertViaTOF().

◆ storeEModeOnWorkspace()

void Mantid::Algorithms::ConvertUnits::storeEModeOnWorkspace ( API::MatrixWorkspace_sptr outputWS )

protectedvirtual

Stores the emode in the provided workspace.

Parameters

outputWS The workspace

Definition at line 284 of file ConvertUnits.cpp.

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

Referenced by setupOutputWorkspace().

◆ summary()

const std::string Mantid::Algorithms::ConvertUnits::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 27 of file ConvertUnits.h.

◆ version()

int Mantid::Algorithms::ConvertUnits::version ( ) const

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 29 of file ConvertUnits.h.

◆ workspaceMethodInputProperty()

const std::string Mantid::Algorithms::ConvertUnits::workspaceMethodInputProperty ( ) const

inlineoverrideprotectedvirtual

Returns the name of the input workspace property used by the calling object.

Implements Mantid::API::IAlgorithm.

Definition at line 45 of file ConvertUnits.h.

◆ workspaceMethodName()

const std::string Mantid::Algorithms::ConvertUnits::workspaceMethodName ( ) const

inlineoverrideprotectedvirtual

Returns a name that will be used when attached as a workspace method. Empty string indicates do not attach

Implements Mantid::API::IAlgorithm.

Definition at line 44 of file ConvertUnits.h.

Member Data Documentation

◆ m_distribution

bool Mantid::Algorithms::ConvertUnits::m_distribution {false}

protected

Whether input is a distribution.

Only applies

Definition at line 76 of file ConvertUnits.h.

Referenced by executeUnitConversion(), setupMemberVariables(), and setupOutputWorkspace().

◆ m_inputEvents

bool Mantid::Algorithms::ConvertUnits::m_inputEvents {false}

protected

to histogram workspaces.

Flag indicating whether input workspace is an EventWorkspace

Definition at line 78 of file ConvertUnits.h.

Referenced by convertQuickly(), convertViaTOF(), executeUnitConversion(), setupMemberVariables(), and setupOutputWorkspace().

◆ m_inputUnit

Kernel::Unit_const_sptr Mantid::Algorithms::ConvertUnits::m_inputUnit

protected

The unit of the input workspace.

Definition at line 79 of file ConvertUnits.h.

Referenced by exec(), executeUnitConversion(), and setupMemberVariables().

◆ m_numberOfSpectra

std::size_t Mantid::Algorithms::ConvertUnits::m_numberOfSpectra {0}

protected

The number of spectra in the input workspace.

Definition at line 75 of file ConvertUnits.h.

Referenced by convertQuickly(), convertViaTOF(), executeUnitConversion(), putBackBinWidth(), setupMemberVariables(), and setupOutputWorkspace().

◆ m_outputUnit

Kernel::Unit_sptr Mantid::Algorithms::ConvertUnits::m_outputUnit

protected

The unit we're going to.

Definition at line 80 of file ConvertUnits.h.

Referenced by convertQuickly(), convertViaTOF(), exec(), executeUnitConversion(), setupMemberVariables(), and setupOutputWorkspace().

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

Framework/Algorithms/inc/MantidAlgorithms/ConvertUnits.h
Framework/Algorithms/src/ConvertUnits.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ alignBins()

◆ calculateRebinParams()

◆ category()

◆ convertQuickly()

◆ convertViaTOF()

◆ exec()

◆ executeUnitConversion()

◆ init()

◆ name()

◆ putBackBinWidth()

◆ removeUnphysicalBins()

◆ reverse()

◆ seeAlso()

◆ setupMemberVariables()

◆ setupOutputWorkspace()

◆ storeEModeOnWorkspace()

◆ summary()

◆ version()

◆ workspaceMethodInputProperty()

◆ workspaceMethodName()

Member Data Documentation

◆ m_distribution

◆ m_inputEvents

◆ m_inputUnit

◆ m_numberOfSpectra

◆ m_outputUnit