Normalizes a 2D workspace by a specified monitor spectrum. More...

#include <NormaliseToMonitor.h>

Inheritance diagram for Mantid::Algorithms::NormaliseToMonitor:

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
void	checkProperties (const API::MatrixWorkspace_sptr &inputWorkspace)
	Makes sure that the input properties are set correctly.

API::MatrixWorkspace_sptr	extractMonitorSpectra (const API::MatrixWorkspace_sptr &ws, const std::vector< size_t > &workspaceIndexes)
	Pulls the monitor spectra out of a larger workspace.

size_t	getInWSMonitorIndex (const API::MatrixWorkspace_sptr &inputWorkspace)

API::MatrixWorkspace_sptr	getInWSMonitorSpectrum (const API::MatrixWorkspace_sptr &inputWorkspace)
	Checks and retrieves the requested spectrum out of the input workspace.

API::MatrixWorkspace_sptr	getMonitorWorkspace (const API::MatrixWorkspace_sptr &inputWorkspace)
	Checks and retrieves the monitor spectrum out of the input workspace.

void	normalisationFactor (const HistogramData::BinEdges &X, HistogramData::Counts &Y, HistogramData::CountStandardDeviations &E)
	Calculates the overall normalization factor.

void	normaliseBinByBin (const API::MatrixWorkspace_sptr &inputWorkspace, API::MatrixWorkspace_sptr &outputWorkspace)
	Carries out the bin-by-bin normalization.

void	normaliseByIntegratedCount (const API::MatrixWorkspace_sptr &inputWorkspace, API::MatrixWorkspace_sptr &outputWorkspace, const bool isSingleCountWorkspace)
	Carries out a normalization based on the integrated count of the monitor over a range.

void	performHistogramDivision (const API::MatrixWorkspace_sptr &inputWorkspace, API::MatrixWorkspace_sptr &outputWorkspace)
	This performs a similar operation to divide, but is a separate algorithm so that the correct spectra are used in the case of detector scans.

bool	setIntegrationProps (const bool isSingleCountWorkspace)
	Sets the maximum and minimum X values of the monitor spectrum to use for integration.

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

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.

std::map< std::string, std::string >	validateInputs () override
	Validates input properties.

Private Attributes
bool	m_commonBins = false
	Whether the input workspace has common bins.

double	m_integrationMax = EMPTY_DBL()
	The upper bound of the integration range.

double	m_integrationMin = EMPTY_DBL()
	The lower bound of the integration range.

API::MatrixWorkspace_sptr	m_monitor
	A single spectrum workspace containing the monitor.

bool	m_scanInput = false

std::vector< size_t >	m_workspaceIndexes

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.

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

Normalizes a 2D workspace by a specified monitor spectrum.

By default ,the normalization is done bin-by-bin following this formula: Norm(s_i)=(s_i/m_i)*Dlam_i*Sum(m_i)/Sum(Dlam_i) where s_i is the signal in bin i, m_i the count in the corresponding monitor bin, Dlam_i the width of the bin, Sum(m_i) is the integrated monitor count and Sum(Dlam_i) the sum of all bin widths (the full range).

Optionally, can instead normalize by the integrated monitor count over a specified range in X. In this case all bins in all spectra will simply be divided by this integrated count. No bin width correction takes place in this case.

The monitor spectrum can be provided either as an index in the main input workspace or as a separate single-spectrum workspace.

Required Properties:

InputWorkspace - The name of the input workspace. Must be a histogram and not a distribution.
OutputWorkspace - The name of the output workspace.
MonitorSpectrum - The spectrum number for the monitor to normalize with.
MonitorWorkspace - A workspace containing the monitor spectrum.

Optional Properties: These should be set to normalize by an integrated monitor count over the range given

IntegrationRangeMin - The lower bound of the range to use.
IntegrationRangeMax - The upper bound of the range to use.
IncludePartialBins - Scales counts in end bins if min/max not on bin boundary.

Definition at line 64 of file NormaliseToMonitor.h.

Member Function Documentation

◆ category()

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

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Implements Mantid::API::IAlgorithm.

Definition at line 79 of file NormaliseToMonitor.h.

◆ checkProperties()

void Mantid::Algorithms::NormaliseToMonitor::checkProperties ( const API::MatrixWorkspace_sptr & inputWorkspace )

protected

Makes sure that the input properties are set correctly.

Parameters

inputWorkspace The input workspace

Definition at line 346 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::g_log, getInWSMonitorSpectrum(), getMonitorWorkspace(), Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), Mantid::Kernel::Property::isDefault(), m_commonBins, m_monitor, m_scanInput, m_workspaceIndexes, Mantid::Kernel::Logger::warning(), and Mantid::Kernel::Exception::NotFoundError::what().

Referenced by exec().

◆ exec()

void Mantid::Algorithms::NormaliseToMonitor::exec ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

Implements Mantid::API::Algorithm.

Definition at line 240 of file NormaliseToMonitor.cpp.

References checkProperties(), extractMonitorSpectra(), Mantid::API::Algorithm::getPointerToProperty(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), m_monitor, m_workspaceIndexes, normaliseBinByBin(), normaliseByIntegratedCount(), setIntegrationProps(), and Mantid::Kernel::IPropertyManager::setProperty().

◆ extractMonitorSpectra()

MatrixWorkspace_sptr Mantid::Algorithms::NormaliseToMonitor::extractMonitorSpectra	(	const API::MatrixWorkspace_sptr &	ws,
		const std::vector< size_t > &	workspaceIndexes
	)

protected

Pulls the monitor spectra out of a larger workspace.

Parameters

ws
workspaceIndexes	The indexes of the spectra to extract

Returns: A workspace containing the spectra requested

Definition at line 286 of file NormaliseToMonitor.cpp.

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

Referenced by exec(), and normaliseByIntegratedCount().

◆ getInWSMonitorIndex()

size_t Mantid::Algorithms::NormaliseToMonitor::getInWSMonitorIndex ( const API::MatrixWorkspace_sptr & inputWorkspace )

protected

◆ getInWSMonitorSpectrum()

MatrixWorkspace_sptr Mantid::Algorithms::NormaliseToMonitor::getInWSMonitorSpectrum ( const API::MatrixWorkspace_sptr & inputWorkspace )

protected

Checks and retrieves the requested spectrum out of the input workspace.

Parameters

inputWorkspace The input workspace

Returns: The unchanged input workspace (so that signature is the same as getMonitorWorkspace)

Exceptions

std::runtime_error If the properties are invalid

Definition at line 416 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::getProperty(), Mantid::API::SpectraAxis::getSpectraIndexMap(), m_scanInput, and m_workspaceIndexes.

Referenced by checkProperties().

◆ getMonitorWorkspace()

MatrixWorkspace_sptr Mantid::Algorithms::NormaliseToMonitor::getMonitorWorkspace ( const API::MatrixWorkspace_sptr & inputWorkspace )

protected

Checks and retrieves the monitor spectrum out of the input workspace.

Parameters

inputWorkspace The input workspace

Returns: A workspace containing the monitor spectrum only

Definition at line 465 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::getProperty(), m_commonBins, m_workspaceIndexes, and Mantid::API::WorkspaceHelpers::matchingBins().

Referenced by checkProperties().

◆ init()

void Mantid::Algorithms::NormaliseToMonitor::init ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

Implements Mantid::API::Algorithm.

Definition at line 162 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_DBL(), Mantid::Kernel::Direction::InOut, Mantid::Kernel::Direction::Input, Mantid::Kernel::IS_DEFAULT, Mantid::API::PropertyMode::Optional, Mantid::Kernel::Direction::Output, and Mantid::Kernel::IPropertyManager::setPropertySettings().

◆ name()

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

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 67 of file NormaliseToMonitor.h.

◆ normalisationFactor()

void Mantid::Algorithms::NormaliseToMonitor::normalisationFactor	(	const HistogramData::BinEdges &	X,
		HistogramData::Counts &	Y,
		HistogramData::CountStandardDeviations &	E
	)

protected

Calculates the overall normalization factor.

This multiplies result by (bin width * sum of monitor counts) / total frame width.

Parameters

X	The BinEdges of the workspace
Y	The Counts of the workspace
E	The CountStandardDeviations of the workspace

Definition at line 744 of file NormaliseToMonitor.cpp.

References Mantid::Geometry::X, and Mantid::Geometry::Y.

Referenced by normaliseBinByBin().

◆ normaliseBinByBin()

void Mantid::Algorithms::NormaliseToMonitor::normaliseBinByBin	(	const API::MatrixWorkspace_sptr &	inputWorkspace,
		API::MatrixWorkspace_sptr &	outputWorkspace
	)

protected

Carries out the bin-by-bin normalization.

Parameters

inputWorkspace	The input workspace
outputWorkspace	The result workspace

Definition at line 621 of file NormaliseToMonitor.cpp.

References Mantid::DataObjects::EventList::divide(), fabs, Mantid::API::Algorithm::g_log, m_commonBins, m_monitor, m_scanInput, m_workspaceIndexes, normalisationFactor(), PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::VectorHelper::rebinHistogram(), Mantid::Kernel::ProgressBase::report(), Mantid::Algorithms::spectrumDefinitionsMatchTimeIndex(), Mantid::Kernel::threadSafe(), Mantid::Kernel::Logger::warning(), Mantid::Geometry::X, and Mantid::Geometry::Y.

Referenced by exec().

◆ normaliseByIntegratedCount()

void Mantid::Algorithms::NormaliseToMonitor::normaliseByIntegratedCount	(	const API::MatrixWorkspace_sptr &	inputWorkspace,
		API::MatrixWorkspace_sptr &	outputWorkspace,
		const bool	isSingleCountWorkspace
	)

protected

Carries out a normalization based on the integrated count of the monitor over a range.

Parameters

inputWorkspace	The input workspace
outputWorkspace	The result workspace
isSingleCountWorkspace	Whether or not the input workspace is point data with single counts per spectrum

Definition at line 523 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), extractMonitorSpectra(), Mantid::API::Algorithm::getProperty(), m_integrationMax, m_integrationMin, m_monitor, m_workspaceIndexes, and performHistogramDivision().

Referenced by exec().

◆ performHistogramDivision()

void Mantid::Algorithms::NormaliseToMonitor::performHistogramDivision	(	const API::MatrixWorkspace_sptr &	inputWorkspace,
		API::MatrixWorkspace_sptr &	outputWorkspace
	)

protected

This performs a similar operation to divide, but is a separate algorithm so that the correct spectra are used in the case of detector scans.

This currently does not support event workspaces properly, but should be made to in the future.

Parameters

inputWorkspace	The workspace with the spectra to divide by the monitor
outputWorkspace	The resulting workspace

Definition at line 568 of file NormaliseToMonitor.cpp.

References m_monitor, m_scanInput, m_workspaceIndexes, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::ProgressBase::report(), Mantid::Algorithms::spectrumDefinitionsMatchTimeIndex(), and Mantid::Kernel::threadSafe().

Referenced by normaliseByIntegratedCount().

◆ seeAlso()

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

inlineoverridevirtual

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

Implements Mantid::API::IAlgorithm.

Definition at line 77 of file NormaliseToMonitor.h.

◆ setIntegrationProps()

bool Mantid::Algorithms::NormaliseToMonitor::setIntegrationProps ( const bool isSingleCountWorkspace )

protected

Sets the maximum and minimum X values of the monitor spectrum to use for integration.

Returns: True if the maximum or minimum values are set

Parameters

isSingleCountWorkspace Whether or not the input workspace is point data with single counts per spectrum

Returns: True if the maximum or minimum values are set, or it is a single count workspace

Definition at line 489 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::isEmpty(), m_integrationMax, m_integrationMin, m_monitor, Mantid::Kernel::Logger::warning(), and Mantid::Geometry::x.

Referenced by exec().

◆ summary()

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

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 69 of file NormaliseToMonitor.h.

◆ validateInputs()

std::map< std::string, std::string > Mantid::Algorithms::NormaliseToMonitor::validateInputs ( void )

overrideprivatevirtual

Validates input properties.

Returns: A map of input properties as keys and (error) messages as values.

Implements Mantid::API::IAlgorithm.

Definition at line 299 of file NormaliseToMonitor.cpp.

References Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Property::isDefault(), and Mantid::API::Algorithm::isEmpty().

◆ version()

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

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 76 of file NormaliseToMonitor.h.

Member Data Documentation

◆ m_commonBins

bool Mantid::Algorithms::NormaliseToMonitor::m_commonBins = false

private

Whether the input workspace has common bins.

Definition at line 110 of file NormaliseToMonitor.h.

Referenced by checkProperties(), getMonitorWorkspace(), and normaliseBinByBin().

◆ m_integrationMax

double Mantid::Algorithms::NormaliseToMonitor::m_integrationMax = EMPTY_DBL()

private

The upper bound of the integration range.

Definition at line 114 of file NormaliseToMonitor.h.

Referenced by normaliseByIntegratedCount(), and setIntegrationProps().

◆ m_integrationMin

double Mantid::Algorithms::NormaliseToMonitor::m_integrationMin = EMPTY_DBL()

private

The lower bound of the integration range.

Definition at line 112 of file NormaliseToMonitor.h.

Referenced by normaliseByIntegratedCount(), and setIntegrationProps().

◆ m_monitor

API::MatrixWorkspace_sptr Mantid::Algorithms::NormaliseToMonitor::m_monitor

private

A single spectrum workspace containing the monitor.

Definition at line 108 of file NormaliseToMonitor.h.

Referenced by checkProperties(), exec(), normaliseBinByBin(), normaliseByIntegratedCount(), performHistogramDivision(), and setIntegrationProps().

◆ m_scanInput

bool Mantid::Algorithms::NormaliseToMonitor::m_scanInput = false

private

Definition at line 115 of file NormaliseToMonitor.h.

Referenced by checkProperties(), getInWSMonitorSpectrum(), normaliseBinByBin(), and performHistogramDivision().

◆ m_workspaceIndexes

std::vector<size_t> Mantid::Algorithms::NormaliseToMonitor::m_workspaceIndexes

private

Definition at line 116 of file NormaliseToMonitor.h.

Referenced by checkProperties(), exec(), getInWSMonitorSpectrum(), getMonitorWorkspace(), normaliseBinByBin(), normaliseByIntegratedCount(), and performHistogramDivision().

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ category()

◆ checkProperties()

◆ exec()

◆ extractMonitorSpectra()

◆ getInWSMonitorIndex()

◆ getInWSMonitorSpectrum()

◆ getMonitorWorkspace()

◆ init()

◆ name()

◆ normalisationFactor()

◆ normaliseBinByBin()

◆ normaliseByIntegratedCount()

◆ performHistogramDivision()

◆ seeAlso()

◆ setIntegrationProps()

◆ summary()

◆ validateInputs()

◆ version()

Member Data Documentation

◆ m_commonBins

◆ m_integrationMax

◆ m_integrationMin

◆ m_monitor

◆ m_scanInput

◆ m_workspaceIndexes