Compares two workspaces for equality. More...

#include <CompareWorkspaces.h>

Inheritance diagram for Mantid::Algorithms::CompareWorkspaces:

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

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

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
	Algorithm's summary for use in the GUI and help.

int	version () const override
	Algorithm's version 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.

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.

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

Static Public Member Functions
static bool	withinAbsoluteTolerance (double x1, double x2, double atol, bool const nanEqual=false)
	Function which calculates absolute error between two values and analyses if this error is within the limits requested.

static bool	withinRelativeTolerance (double x1, double x2, double rtol, bool const nanEqual=false)
	Function which calculates relative error between two values and analyses if this error is within the limits requested.

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.

Private Member Functions
bool	checkAxes (const API::MatrixWorkspace_const_sptr &ws1, const API::MatrixWorkspace_const_sptr &ws2)
	Checks that the axes matches.

bool	checkData (const API::MatrixWorkspace_const_sptr &ws1, const API::MatrixWorkspace_const_sptr &ws2)
	Checks that the data matches.

bool	checkInstrument (const API::MatrixWorkspace_const_sptr &ws1, const API::MatrixWorkspace_const_sptr &ws2)

bool	checkMasking (const API::MatrixWorkspace_const_sptr &ws1, const API::MatrixWorkspace_const_sptr &ws2)
	Checks that the bin masking matches.

bool	checkRunProperties (const API::Run &run1, const API::Run &run2)
	Checks that the Run matches.

bool	checkSample (const API::Sample &sample1, const API::Sample &sample2)
	Checks that the sample matches.

bool	checkSpectraMap (const API::MatrixWorkspace_const_sptr &ws1, const API::MatrixWorkspace_const_sptr &ws2)
	Checks that the spectra maps match.

int	compareEventsListInDetails (const DataObjects::EventList &el1, const DataObjects::EventList &el2, double tolTof, double tolWeight, int64_t tolPulse, bool printdetails, size_t &numdiffpulse, size_t &numdifftof, size_t &numdiffboth, size_t &numdiffweight) const
	Compare 2 EventsList.

bool	compareEventWorkspaces (const DataObjects::EventWorkspace &ews1, const DataObjects::EventWorkspace &ews2)
	Check whether 2 event lists are identical.

void	doComparison ()
	CompareWorkspaces::doComparison.

void	doLeanElasticPeaksComparison (const DataObjects::LeanElasticPeaksWorkspace_sptr &tws1, const DataObjects::LeanElasticPeaksWorkspace_sptr &tws2)

void	doMDComparison (const API::Workspace_sptr &w1, const API::Workspace_sptr &w2)

void	doPeaksComparison (DataObjects::PeaksWorkspace_sptr tws1, DataObjects::PeaksWorkspace_sptr tws2)

void	doTableComparison (const API::ITableWorkspace_const_sptr &tws1, const API::ITableWorkspace_const_sptr &tws2)

void	exec () override
	Execute algorithm.

void	init () override
	Initialise algorithm.

bool	processGroups () override
	Process two groups and ensure the Result string is set properly on the final algorithm.

void	processGroups (const std::shared_ptr< const API::WorkspaceGroup > &groupOne, const std::shared_ptr< const API::WorkspaceGroup > &groupTwo)
	Process the two groups.

void	recordMismatch (const std::string &msg, std::string ws1="", std::string ws2="")
	Records a mismatch in the Messages workspace and sets Result to false.

Private Attributes
std::function< bool(const double, const double)>	m_compare
	The comparison method to use (true if equal, false otherwise)

API::ITableWorkspace_sptr	m_messages
	Mismatch messages that resulted from comparison.

bool	m_parallelComparison {false}
	Variable states if one wants to compare workspaces in parallell.

std::unique_ptr< API::Progress >	m_progress = nullptr
	Report progress of comparison.

bool	m_result {false}
	Result of comparison (true if equal, false otherwise)

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

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

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

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.

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

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

Detailed Description

Compares two workspaces for equality.

This algorithm is mainly intended for use by Mantid developers as part of the testing process.

The data values (X,Y and error) are always checked. The algorithm can also optionally check the axes (this includes the units), the spectra-detector map, the instrument (the name and parameter map) and any bin masking.

Required Properties:

Workspace1 - The name of the first input workspace
Workspace2 - The name of the second input workspace

Optional Properties:

Tolerance - The maximum amount by which values may differ between the workspaces (default: 0)
CheckAxes - Whether to check that the axes match (default: true)
CheckSpectraMap - Whether to check that the spectra-detector maps match (default: true)
CheckInstrument - Whether to check that the instruments match (default: true)
CheckMasking - Whether to check that the bin masking matches (default: true)
CheckSample - Whether to check that the sample object mathces (default: false)

Output Properties:

Result - Contains boolean true if the workspaces match, false otherwise
Messages - TableWorkspace with three columns. The first column contains messages about any mismatches that were detected. The second and third columns contain the names of the workspaces being compared. If no mismatches were detected, this workspace will be empty.

Definition at line 60 of file CompareWorkspaces.h.

Member Function Documentation

◆ category()

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

inlineoverridevirtual

Algorithm's category for identification.

See also: Algorithm::category

Implements Mantid::API::IAlgorithm.

Definition at line 70 of file CompareWorkspaces.h.

◆ checkAxes()

bool Mantid::Algorithms::CompareWorkspaces::checkAxes	(	const API::MatrixWorkspace_const_sptr &	ws1,
		const API::MatrixWorkspace_const_sptr &	ws2
	)

private

Checks that the axes matches.

Parameters

ws1	:: the first workspace
ws2	:: the second workspace

Return values

true	The axes match
false	The axes do not match

Definition at line 706 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Axis::isNumeric(), Mantid::API::Axis::isSpectra(), recordMismatch(), Mantid::API::Axis::title(), tolerance, and Mantid::API::Axis::unit().

Referenced by doComparison().

◆ checkData()

bool Mantid::Algorithms::CompareWorkspaces::checkData	(	const API::MatrixWorkspace_const_sptr &	ws1,
		const API::MatrixWorkspace_const_sptr &	ws2
	)

private

Checks that the data matches.

Parameters

ws1	:: the first workspace
ws2	:: the second workspace

Return values

true	The data matches
false	The data does not matches

Definition at line 603 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::E1(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::is(), m_compare, m_parallelComparison, m_progress, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_CRITICAL, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, and recordMismatch().

Referenced by doComparison().

◆ checkInstrument()

bool Mantid::Algorithms::CompareWorkspaces::checkInstrument	(	const API::MatrixWorkspace_const_sptr &	ws1,
		const API::MatrixWorkspace_const_sptr &	ws2
	)

private

Definition at line 831 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::Geometry::ParameterMap::diff(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), and recordMismatch().

Referenced by doComparison().

◆ checkMasking()

bool Mantid::Algorithms::CompareWorkspaces::checkMasking	(	const API::MatrixWorkspace_const_sptr &	ws1,
		const API::MatrixWorkspace_const_sptr &	ws2
	)

private

Checks that the bin masking matches.

Parameters

ws1	:: the first workspace
ws2	:: the second workspace

Return values

true	The masking matches
false	The masking does not match

Definition at line 881 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, and recordMismatch().

Referenced by doComparison().

◆ checkRunProperties()

bool Mantid::Algorithms::CompareWorkspaces::checkRunProperties	(	const API::Run &	run1,
		const API::Run &	run2
	)

private

Checks that the Run matches.

Parameters

run1	:: the first run object
run2	:: the second run object

Return values

true	The sample matches
false	The samples does not match

Definition at line 933 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::LogManager::getLogData(), Mantid::API::Run::getProtonCharge(), Mantid::Kernel::Logger::is(), Mantid::Kernel::Property::name(), name(), and recordMismatch().

Referenced by doComparison().

◆ checkSample()

bool Mantid::Algorithms::CompareWorkspaces::checkSample	(	const API::Sample &	sample1,
		const API::Sample &	sample2
	)

private

Checks that the sample matches.

Parameters

sample1	:: the first sample
sample2	:: the second sample

Return values

true	The sample matches
false	The samples does not match

Definition at line 911 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::Sample::getName(), and recordMismatch().

Referenced by doComparison().

◆ checkSpectraMap()

bool Mantid::Algorithms::CompareWorkspaces::checkSpectraMap	(	const API::MatrixWorkspace_const_sptr &	ws1,
		const API::MatrixWorkspace_const_sptr &	ws2
	)

private

Checks that the spectra maps match.

Parameters

ws1	:: the first sp det map
ws2	:: the second sp det map

Return values

true	The maps match
false	The maps do not match

Definition at line 782 of file CompareWorkspaces.cpp.

References recordMismatch().

Referenced by doComparison().

◆ compareEventsListInDetails()

int Mantid::Algorithms::CompareWorkspaces::compareEventsListInDetails	(	const DataObjects::EventList &	el1,
		const DataObjects::EventList &	el2,
		double	tolTof,
		double	tolWeight,
		int64_t	tolPulse,
		bool	printdetails,
		size_t &	numdiffpulse,
		size_t &	numdifftof,
		size_t &	numdiffboth,
		size_t &	numdiffweight
	)		const

private

Compare 2 EventsList.

Compare 2 different events list with detailed information output (Linear) It assumes that the number of events between these 2 are identical el1 :: event list 1 el2 :: event list 2 tolfTOF :: tolerance of Time-of-flight (in micro-second) tolWeight :: tolerance of weight for weighted neutron events tolPulse :: tolerance of pulse time (in nanosecond) NOTE: there is no need to compare the event type as it has been done by other tjype of check printdetails :: option for comparing.

-1: simple, 0: full but no print, 1: full with print

Returns: :: int. -1: different number of events; N > 0 : some events are not same

Definition at line 994 of file CompareWorkspaces.cpp.

References Mantid::API::Algorithm::g_log, Mantid::DataObjects::EventList::getEventType(), and Mantid::DataObjects::EventList::getNumberEvents().

Referenced by compareEventWorkspaces().

◆ compareEventWorkspaces()

bool Mantid::Algorithms::CompareWorkspaces::compareEventWorkspaces	(	const DataObjects::EventWorkspace &	ews1,
		const DataObjects::EventWorkspace &	ews2
	)

private

Check whether 2 event lists are identical.

Definition at line 452 of file CompareWorkspaces.cpp.

Referenced by doComparison().

◆ doComparison()

void Mantid::Algorithms::CompareWorkspaces::doComparison ( )

private

CompareWorkspaces::doComparison.

Definition at line 298 of file CompareWorkspaces.cpp.

References checkAxes(), checkData(), checkInstrument(), checkMasking(), checkRunProperties(), checkSample(), checkSpectraMap(), compareEventWorkspaces(), doLeanElasticPeaksComparison(), doMDComparison(), doPeaksComparison(), doTableComparison(), Mantid::API::Algorithm::getProperty(), m_progress, and recordMismatch().

Referenced by exec().

◆ doLeanElasticPeaksComparison()

void Mantid::Algorithms::CompareWorkspaces::doLeanElasticPeaksComparison	(	const DataObjects::LeanElasticPeaksWorkspace_sptr &	tws1,
		const DataObjects::LeanElasticPeaksWorkspace_sptr &	tws2
	)

private

Definition at line 1138 of file CompareWorkspaces.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), name(), Mantid::Kernel::V3D::norm(), Mantid::Kernel::Logger::notice(), recordMismatch(), tolerance, withinAbsoluteTolerance(), and withinRelativeTolerance().

Referenced by doComparison().

◆ doMDComparison()

void Mantid::Algorithms::CompareWorkspaces::doMDComparison	(	const API::Workspace_sptr &	w1,
		const API::Workspace_sptr &	w2
	)

private

Definition at line 1316 of file CompareWorkspaces.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::getProperty(), recordMismatch(), and tolerance.

Referenced by doComparison().

◆ doPeaksComparison()

void Mantid::Algorithms::CompareWorkspaces::doPeaksComparison	(	DataObjects::PeaksWorkspace_sptr	tws1,
		DataObjects::PeaksWorkspace_sptr	tws2
	)

private

Definition at line 1020 of file CompareWorkspaces.cpp.

Referenced by doComparison().

◆ doTableComparison()

void Mantid::Algorithms::CompareWorkspaces::doTableComparison	(	const API::ITableWorkspace_const_sptr &	tws1,
		const API::ITableWorkspace_const_sptr &	tws2
	)

private

Definition at line 1256 of file CompareWorkspaces.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), recordMismatch(), and tolerance.

Referenced by doComparison().

◆ exec()

void Mantid::Algorithms::CompareWorkspaces::exec ( )

overrideprivatevirtual

Execute algorithm.

Execute the algorithm.

Implements Mantid::API::Algorithm.

Definition at line 165 of file CompareWorkspaces.cpp.

References doComparison(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::is(), m_compare, m_messages, m_parallelComparison, m_result, Mantid::Kernel::Logger::notice(), Mantid::Kernel::IPropertyManager::setProperty(), tolerance, Mantid::Kernel::Logger::warning(), withinAbsoluteTolerance(), and withinRelativeTolerance().

◆ init()

void Mantid::Algorithms::CompareWorkspaces::init ( )

overrideprivatevirtual

Initialise algorithm.

Initialize the algorithm's properties.

Implements Mantid::API::Algorithm.

Definition at line 113 of file CompareWorkspaces.cpp.

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

◆ name()

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

inlineoverridevirtual

Algorithm's name.

Implements Mantid::API::Algorithm.

Definition at line 63 of file CompareWorkspaces.h.

Referenced by checkRunProperties(), doLeanElasticPeaksComparison(), doPeaksComparison(), and processGroups().

◆ processGroups() [1/2]

bool Mantid::Algorithms::CompareWorkspaces::processGroups ( )

overrideprivatevirtual

Process two groups and ensure the Result string is set properly on the final algorithm.

Returns: A boolean true if execution was sucessful, false otherwise

Reimplemented from Mantid::API::Algorithm.

Definition at line 206 of file CompareWorkspaces.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), m_messages, m_result, Mantid::Kernel::Logger::notice(), processGroups(), recordMismatch(), and Mantid::Kernel::IPropertyManager::setProperty().

Referenced by processGroups().

◆ processGroups() [2/2]

void Mantid::Algorithms::CompareWorkspaces::processGroups	(	const std::shared_ptr< const API::WorkspaceGroup > &	groupOne,
		const std::shared_ptr< const API::WorkspaceGroup > &	groupTwo
	)

private

Process the two groups.

CompareWorkspaces::processGroups.

Parameters

groupOne
groupTwo

Definition at line 246 of file CompareWorkspaces.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::getProperties(), Mantid::Kernel::Property::name(), name(), recordMismatch(), Mantid::Kernel::Property::value(), and version().

◆ recordMismatch()

void Mantid::Algorithms::CompareWorkspaces::recordMismatch	(	const std::string &	msg,
		std::string	ws1 = `""`,
		std::string	ws2 = `""`
	)

private

Records a mismatch in the Messages workspace and sets Result to false.

Records a mismatch that has occurred in the output workspace and sets the Result to indicate that the input workspaces did not match.

Parameters

msg	Mismatch message to be logged in output workspace
ws1	Name of first workspace being compared
ws2	Name of second workspace being compared

Definition at line 1343 of file CompareWorkspaces.cpp.

References Mantid::API::Algorithm::getProperty(), m_messages, and m_result.

Referenced by checkAxes(), checkData(), checkInstrument(), checkMasking(), checkRunProperties(), checkSample(), checkSpectraMap(), compareEventWorkspaces(), doComparison(), doLeanElasticPeaksComparison(), doMDComparison(), doPeaksComparison(), doTableComparison(), processGroups(), and processGroups().

◆ seeAlso()

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

inlineoverridevirtual

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

Implements Mantid::API::IAlgorithm.

Definition at line 67 of file CompareWorkspaces.h.

◆ summary()

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

inlineoverridevirtual

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

See also: Algorithm::summary

Implements Mantid::API::Algorithm.

Definition at line 73 of file CompareWorkspaces.h.

◆ version()

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

inlineoverridevirtual

Algorithm's version for identification.

See also: Algorithm::version

Implements Mantid::API::Algorithm.

Definition at line 66 of file CompareWorkspaces.h.

Referenced by processGroups().

◆ withinAbsoluteTolerance()

bool Mantid::Algorithms::CompareWorkspaces::withinAbsoluteTolerance	(	double	x1,
		double	x2,
		double	atol,
		bool const	nanEqual = `false`
	)

static

Function which calculates absolute error between two values and analyses if this error is within the limits requested.

Parameters

x1	– first value to check difference
x2	– second value to check difference
atol	– the tolerance of the comparison. Must be nonnegative
nanEqual	– whether two NaNs compare as equal

Returns: true if absolute difference is within the tolerance; false otherwise

Definition at line 1371 of file CompareWorkspaces.cpp.

References Mantid::Kernel::withinAbsoluteDifference().

Referenced by doLeanElasticPeaksComparison(), and exec().

◆ withinRelativeTolerance()

bool Mantid::Algorithms::CompareWorkspaces::withinRelativeTolerance	(	double	x1,
		double	x2,
		double	rtol,
		bool const	nanEqual = `false`
	)

static

Function which calculates relative error between two values and analyses if this error is within the limits requested.

Parameters

x1	– first value to check difference
x2	– second value to check difference
rtol	– the tolerance of the comparison. Must be nonnegative
nanEqual	– whether two NaNs compare as equal

Returns: true if relative difference is within the tolerance; false otherwise; true if error or false if the relative value is within the limits requested

Definition at line 1390 of file CompareWorkspaces.cpp.

References Mantid::Kernel::withinRelativeDifference().

Referenced by doLeanElasticPeaksComparison(), and exec().

Member Data Documentation

◆ m_compare

std::function<bool(const double, const double)> Mantid::Algorithms::CompareWorkspaces::m_compare

private

The comparison method to use (true if equal, false otherwise)

Definition at line 125 of file CompareWorkspaces.h.

Referenced by checkData(), doPeaksComparison(), and exec().

◆ m_messages

API::ITableWorkspace_sptr Mantid::Algorithms::CompareWorkspaces::m_messages

private

Mismatch messages that resulted from comparison.

Definition at line 128 of file CompareWorkspaces.h.

Referenced by exec(), init(), processGroups(), and recordMismatch().

◆ m_parallelComparison

bool Mantid::Algorithms::CompareWorkspaces::m_parallelComparison {false}

private

Variable states if one wants to compare workspaces in parallell.

This usully true but if one wants to look at the comparison logs, parallell comparison make things complicated as logs from different threads are mixed together. In this case, it is better not to do parallell comparison.

Definition at line 138 of file CompareWorkspaces.h.

Referenced by checkData(), compareEventWorkspaces(), and exec().

◆ m_progress

std::unique_ptr<API::Progress> Mantid::Algorithms::CompareWorkspaces::m_progress = nullptr

private

Report progress of comparison.

Definition at line 131 of file CompareWorkspaces.h.

Referenced by checkData(), compareEventWorkspaces(), and doComparison().

◆ m_result

bool Mantid::Algorithms::CompareWorkspaces::m_result {false}

private

Result of comparison (true if equal, false otherwise)

Definition at line 122 of file CompareWorkspaces.h.

Referenced by exec(), processGroups(), and recordMismatch().

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ category()

◆ checkAxes()

◆ checkData()

◆ checkInstrument()

◆ checkMasking()

◆ checkRunProperties()

◆ checkSample()

◆ checkSpectraMap()

◆ compareEventsListInDetails()

◆ compareEventWorkspaces()

◆ doComparison()

◆ doLeanElasticPeaksComparison()

◆ doMDComparison()

◆ doPeaksComparison()

◆ doTableComparison()

◆ exec()

◆ init()

◆ name()

◆ processGroups() [1/2]

◆ processGroups() [2/2]

◆ recordMismatch()

◆ seeAlso()

◆ summary()

◆ version()

◆ withinAbsoluteTolerance()

◆ withinRelativeTolerance()

Member Data Documentation

◆ m_compare

◆ m_messages

◆ m_parallelComparison

◆ m_progress

◆ m_result