Calculates the sum of the counts against a circular ring. More...

#include <RingProfile.h>

Inheritance diagram for Mantid::Algorithms::RingProfile:

Public Member Functions
const std::string	category () const override
	function to return a category of the algorithm. More...

const std::string	name () const override
	function to return a name of the algorithm, must be overridden in all algorithms More...

	RingProfile ()
	Constructor. More...

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

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

int	version () const override
	function to return a version of the algorithm, must be overridden in all algorithms More...

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

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor. More...

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

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

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. More...

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

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

void	cancel () override
	Raises the cancel flag. More...

bool	getCancel () const
	Returns the cancellation state. More...

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

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

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

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

int	getLoggingOffset () const override
	returns the logging priority offset More...

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

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

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

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

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

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

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. More...

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

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. More...

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) More...

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

virtual bool	processGroups ()
	Process WorkspaceGroup inputs. More...

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

const Parallel::Communicator &	communicator () const
	Returns a const reference to the (MPI) communicator of the algorithm. More...

void	setCommunicator (const Parallel::Communicator &communicator)
	Sets the (MPI) communicator of the algorithm. More...

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

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

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

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. More...

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. More...

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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	clear () override
	Clears all properties under management. More...

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

void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &) override

void	splitByTime (std::vector< Kernel::SplittingInterval > &, std::vector< Kernel::PropertyManager * >) const override

void	filterByProperty (const Kernel::TimeSeriesProperty< bool > &, const std::vector< std::string > &) override

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

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

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

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. More...

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. More...

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. More...

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). More...

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). More...

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. More...

const std::string	category () const override
	function to return a category of the algorithm. More...

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

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

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. More...

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

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

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

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

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)

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)

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. More...

virtual void	addObserver (const Poco::AbstractObserver &observer) const =0
	Add an observer for a notification. More...

virtual const std::string	alias () const =0
	function to return any aliases of the algorithm. More...

virtual const std::string	aliasDeprecated () const =0
	Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...

virtual void	cancel ()=0
	Raises the cancel flag. More...

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

virtual const std::string	category () const =0
	function to return a category of the algorithm. More...

virtual const std::string	categorySeparator () const =0
	Function to return the separator token for the category string. More...

virtual void	enableHistoryRecordingForChild (const bool on)=0
	If true history will be recorded for a child. More...

virtual bool	execute ()=0
	System execution. More...

virtual void	executeAsChildAlg ()=0
	Execute as a Child Algorithm, with try/catch. More...

virtual Poco::ActiveResult< bool >	executeAsync ()=0
	Asynchronous execution of the algorithm. More...

virtual ExecutionState	executionState () const =0
	Gets the current execution state. More...

virtual AlgorithmID	getAlgorithmID () const =0
	Algorithm ID. More...

virtual bool	getAlgStartupLogging () const =0
	get the state of Logging of start and end messages More...

virtual bool	getAlwaysStoreInADS () const =0
	To query whether the output is stored in the analysis data service. More...

virtual int	getLoggingOffset () const =0
	returns the logging priority offset More...

virtual const std::string	helpURL () const =0
	function to return an optional URL for documentation. More...

virtual void	initialize ()=0
	Initialization method invoked by the framework. More...

virtual bool	isChild () const =0
	To query whether algorithm is a child. Default to false. More...

virtual bool	isExecuted () const =0
	Check whether the algorithm has been executed sucessfully. More...

virtual bool	isInitialized () const =0
	Check whether the algorithm is initialized properly. More...

virtual bool	isLogging () const =0
	returns the status of logging, True = enabled More...

virtual bool	isReadyForGarbageCollection () const =0
	True if the algorithm is ready for garbage collection. More...

virtual bool	isRunning () const =0
	True if the algorithm is running. More...

virtual const std::string	name () const =0
	function to return a name of the algorithm, must be overridden in all algorithms More...

virtual void	removeObserver (const Poco::AbstractObserver &observer) const =0
	Remove an observer. More...

virtual ResultState	resultState () const =0
	Gets the currnet result State. More...

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

virtual void	setAlgStartupLogging (const bool enabled)=0
	disable Logging of start and end messages More...

virtual void	setAlwaysStoreInADS (const bool doStore)=0
	Set whether we always store the output in the analysis data service. More...

virtual void	setChild (const bool isChild)=0
	To set whether algorithm is a child. More...

virtual void	setChildEndProgress (const double endProgress) const =0
	setting the child end progress More...

virtual void	setChildStartProgress (const double startProgress) const =0
	setting the child start progress More...

virtual void	setLogging (const bool value)=0
	Logging can be disabled by passing a value of false. More...

virtual void	setLoggingOffset (const int value)=0
	gets the logging priority offset More...

virtual void	setRethrows (const bool rethrow)=0
	To query whether an algorithm should rethrow exceptions when executing. More...

virtual const std::string	summary () const =0
	function returns a summary message that will be displayed in the default GUI, and in the help. More...

virtual ::Json::Value	toJson () const =0
	Serialize an algorithm as Json. More...

virtual std::string	toString () const =0
	Serialize an algorithm. More...

virtual std::map< std::string, std::string >	validateInputs ()=0
	Method checking errors on ALL the inputs, before execution. More...

virtual int	version () const =0
	function to return a version of the algorithm, must be overridden in all algorithms More...

Algorithms As Methods
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value	asJson (bool withDefaultValues=false) const =0
	Return the property manager serialized as a json object. More...

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

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

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). More...

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. More...

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). More...

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. More...

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. More...

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. More...

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

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

virtual void	filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0

virtual void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0

virtual std::vector< std::string >	getDeclaredPropertyNames () const noexcept=0
	Get the list of managed property names. More...

virtual Property *	getPointerToProperty (const std::string &name) const =0
	Get a pointer to property by name. More...

virtual const std::vector< Property * > &	getProperties () const =0
	Get the list of managed properties. More...

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

virtual TypedValue	getProperty (const std::string &name) const =0
	Get the value of a property. More...

virtual std::string	getPropertyValue (const std::string &name) const =0
	Get the value of a property as a string. More...

virtual size_t	propertyCount () const =0
	Returns the number of properties under management. More...

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

virtual void	resetProperties ()=0

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

virtual void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
	Sets all properties from a string. More...

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

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

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

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

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. More...

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

virtual void	setPropertyOrdinal (const int &index, const std::string &value)=0
	Set the value of a property by an index. More...

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

virtual void	setPropertyValue (const std::string &name, const std::string &value)=0
	Sets property value from a string. More...

virtual void	setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0
	Sets property value from a Json::Value. More...

virtual void	splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0

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

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

virtual bool	validateProperties () const =0
	Validates all the properties in the collection. More...

virtual	~IPropertyManager ()=default

Protected Attributes
std::shared_ptr< API::Progress >	m_progress

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

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

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

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

Kernel::Logger	m_log
	Logger for this algorithm. More...

Kernel::Logger &	g_log

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

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

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

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

Private Member Functions
void	checkInputsForNumericWorkspace (const API::MatrixWorkspace_sptr &)
	validate the inputs of the algorithm for 2d matrix based instrument More...

void	checkInputsForSpectraWorkspace (const API::MatrixWorkspace_sptr &)
	validate the inputs of the algorithm for instrument based workspace More...

void	exec () override
	Execute the algorithm. More...

int	fromAngleToBin (double angle, bool degree=true)
	get the bin position for the given angle More...

void	getBinForPixel (const API::MatrixWorkspace_sptr &, int, std::vector< int > &)
	identify the bin position for the given pixel in the image based workspace More...

int	getBinForPixel (const Kernel::V3D &position)
	Here is the main logic to perform the transformation, to calculate the bin position in degree for each detector. More...

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

void	processInstrumentRingProfile (const API::MatrixWorkspace_sptr &inputWS, std::vector< double > &output_bins)
	process ring profile for instrument based workspace More...

void	processNumericImageRingProfile (const API::MatrixWorkspace_sptr &inputWS, std::vector< double > &output_bins)
	process ring profile for image based workspace More...

Private Attributes
double	bin_size
	The size of the bins in angle that is equal to 360 / NumBins. More...

double	centre_x
	copy of centre for axis(0) More...

double	centre_y
	copy of centre for axis(1) More...

double	centre_z
	copy of centre for axis(2) More...

bool	clockwise
	flag that indicate if Sense input was configure to clockwise More...

double	max_radius
	copy of the maxRadius input More...

double	min_radius
	copy of the minRadius input More...

int	num_bins
	copy of NumBins input More...

double	start_angle
	copy of the StartAngle input More...

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. More...

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

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

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

Protected Member Functions inherited from Mantid::API::Algorithm
void	exec (Parallel::ExecutionMode executionMode)
	Runs the algorithm with the specified execution mode. More...

virtual void	execDistributed ()
	Runs the algorithm in `distributed` execution mode. More...

virtual void	execMasterOnly ()
	Runs the algorithm in `master-only` execution mode. More...

virtual Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const
	Get correct execution mode based on input storage modes for an MPI run. More...

virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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)

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void	afterPropertySet (const std::string &)
	Override this method to perform a custom action right after a property was set. More...

virtual void	clear ()=0
	Clears all properties under management. More...

virtual Property *	getPointerToPropertyOrdinal (const int &index) const =0
	Get a property by an index. More...

template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property. More...

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. More...

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

Detailed Description

Calculates the sum of the counts against a circular ring.

Author: Gesner Passos, ISIS

Definition at line 23 of file RingProfile.h.

Constructor & Destructor Documentation

◆ RingProfile()

Mantid::Algorithms::RingProfile::RingProfile ( )

Constructor.

Definition at line 29 of file RingProfile.cpp.

Member Function Documentation

◆ category()

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

inlineoverridevirtual

function to return a category of the algorithm.

Implements Mantid::API::IAlgorithm.

Definition at line 33 of file RingProfile.h.

◆ checkInputsForNumericWorkspace()

void Mantid::Algorithms::RingProfile::checkInputsForNumericWorkspace ( const API::MatrixWorkspace_sptr & inputWS )

private

validate the inputs of the algorithm for 2d matrix based instrument

Validation of the inputs of the RingProfile algorithm.

Inside this method, the Workspace is considered a 2D Matrix, where each spectrum is the rows of the matrix and have the variation in axis0. The columns of the matrix is the position of dataX(0)

The main validation are:

the centre of the ring is inside the image it self.
The minimum ring is smaller than the limits of the image to allow
Parameters

inputWS pointer to the input workspace

Definition at line 309 of file RingProfile.cpp.

References centre_x, centre_y, Mantid::API::Algorithm::g_log, Mantid::API::NumericAxis::getMax(), Mantid::API::NumericAxis::getMin(), min_radius, and Mantid::Kernel::Logger::notice().

Referenced by exec().

◆ checkInputsForSpectraWorkspace()

void Mantid::Algorithms::RingProfile::checkInputsForSpectraWorkspace ( const API::MatrixWorkspace_sptr & inputWS )

private

validate the inputs of the algorithm for instrument based workspace

Validation of the inputs of the RingProfile algorithm.

Inside this method, the Workspace is considered an instrument based instrument. Each spectrum has a detector associated which has a position in the 3D space.

The main validation are:

the centre of the ring is inside the image it self.
The minimum ring is smaller than the limits of the image to allow

Parameters

inputWS the input workspace

Definition at line 205 of file RingProfile.cpp.

References centre_x, centre_y, centre_z, Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, and min_radius.

Referenced by exec().

◆ exec()

void Mantid::Algorithms::RingProfile::exec ( )

overrideprivatevirtual

Execute the algorithm.

The algorithm is executed in the following order:

Check is performed to see if all the inputs are valid to allow an answer.
Perform the ring profile algorithm
Configure the output of the algorithm

The execution of the first two steps depend on the nature of the input. If the input is a workspace whose positions are held by the instrument connected to the workspace, it process the two steps with the following methods:

checkInputsForSpectraWorkspace
processInstrumentRingProfile

If the workspace must be dealt with as a flat 2D image, these steps will be performed by:

checkInputsForNumericWorkspace
processNumericImageRingProfile

Implements Mantid::API::Algorithm.

Definition at line 101 of file RingProfile.cpp.

References bin_size, centre_x, centre_y, centre_z, checkInputsForNumericWorkspace(), checkInputsForSpectraWorkspace(), clockwise, Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::SingletonHolder< T >::Instance(), m_progress, max_radius, min_radius, num_bins, processInstrumentRingProfile(), processNumericImageRingProfile(), Mantid::Kernel::IPropertyManager::setProperty(), and start_angle.

◆ fromAngleToBin()

int Mantid::Algorithms::RingProfile::fromAngleToBin	(	double	angle,
		bool	degree = `true`
	)

private

get the bin position for the given angle

Definition at line 579 of file RingProfile.cpp.

References bin_size, and start_angle.

Referenced by getBinForPixel().

◆ getBinForPixel() [1/2]

void Mantid::Algorithms::RingProfile::getBinForPixel	(	const API::MatrixWorkspace_sptr &	ws,
		int	spectrum_index,
		std::vector< int > &	bins_pos
	)

private

identify the bin position for the given pixel in the image based workspace

Here is the main logic to perform the transformation, to calculate the bin position in degree for each spectrum.

The first part of the method is to check if the pixel position is inside the ring defined as minRadio and maxRadio.

To do this, it deducts the pixel position. This deduction follows the followin assumption:

the spectrum_index == row number
the position in the 'Y' direction is given by getAxis(1)[spectrum_index]
the position in the 'X' direction is the central point of the bin (dataX[column] + dataX[column+1])/2

Having the position of the pixel, as defined above, if the distance is outside the ring defined by minRadio, maxRadio, it defines the bin position as -1.

If the pixel is inside the ring, it calculates the angle of the pixel and calls fromAngleToBin to define the bin position.

Parameters

ws	pointer to the workspace
spectrum_index	index of the spectrum
bins_pos	bin positions (for each column inside the spectrum, the correspondent bin_pos)

Definition at line 516 of file RingProfile.cpp.

References centre_x, centre_y, fromAngleToBin(), and max_radius.

Referenced by processInstrumentRingProfile(), and processNumericImageRingProfile().

◆ getBinForPixel() [2/2]

int Mantid::Algorithms::RingProfile::getBinForPixel ( const Kernel::V3D & position )

private

Here is the main logic to perform the transformation, to calculate the bin position in degree for each detector.

The first part of the method is to check if the detector is inside the ring defined as minRadio and maxRadio.

To do this, it checks the projected distance between the centre and the detector position. If this projected distance is outside the defined ring, it returns -1.

For those detectors that lay inside the ring, it will calculate the phi angle. And than find the slot where this angle should be placed (bin)

Parameters

position pixel position

Returns: bin position

Definition at line 426 of file RingProfile.cpp.

References centre_x, centre_y, centre_z, fromAngleToBin(), Mantid::Kernel::V3D::getSpherical(), max_radius, and position.

◆ init()

void Mantid::Algorithms::RingProfile::init ( )

overrideprivatevirtual

Initialize the algorithm's properties.

It configures the algorithm to accept the following inputs:

InputWorkspace
OutputWorkspace
Centre
MinRadius
MaxRadius
NumBins
StartAngle
Sense

Implements Mantid::API::Algorithm.

Definition at line 45 of file RingProfile.cpp.

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

◆ name()

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

inlineoverridevirtual

function to return a name of the algorithm, must be overridden in all algorithms

Implements Mantid::API::Algorithm.

Definition at line 27 of file RingProfile.h.

◆ processInstrumentRingProfile()

void Mantid::Algorithms::RingProfile::processInstrumentRingProfile	(	const API::MatrixWorkspace_sptr &	inputWS,
		std::vector< double > &	output_bins
	)

private

process ring profile for instrument based workspace

The main method to calculate the ring profile for workspaces based on instruments.

It will iterate over all the spectrum inside the workspace. For each spectrum, it will use the RingProfile::getBinForPixel method to identify where, in the output_bins, the sum of all the spectrum values should be placed in.

Parameters

inputWS	pointer to the input workspace
output_bins	the reference to the vector to be filled with the integration values

Definition at line 375 of file RingProfile.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, getBinForPixel(), Mantid::Kernel::Logger::information(), and m_progress.

Referenced by exec().

◆ processNumericImageRingProfile()

void Mantid::Algorithms::RingProfile::processNumericImageRingProfile	(	const API::MatrixWorkspace_sptr &	inputWS,
		std::vector< double > &	output_bins
	)

private

process ring profile for image based workspace

The main method to calculate the ring profile for 2d image based workspace.

It will iterate over all the spectrum inside the workspace. For each spectrum, it will use the RingProfile::getBinForPixel method to identify where, in the output_bins, the elements of the spectrum should be placed in.

Parameters

inputWS	pointer to the input workspace
output_bins	the reference to the vector to be filled with the integration values

Definition at line 462 of file RingProfile.cpp.

References getBinForPixel(), and m_progress.

Referenced by exec().

◆ seeAlso()

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

inlineoverridevirtual

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

Implements Mantid::API::IAlgorithm.

Definition at line 32 of file RingProfile.h.

◆ summary()

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

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 29 of file RingProfile.h.

◆ version()

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

inlineoverridevirtual

function to return a version of the algorithm, must be overridden in all algorithms

Implements Mantid::API::Algorithm.

Definition at line 31 of file RingProfile.h.

Member Data Documentation

◆ bin_size

double Mantid::Algorithms::RingProfile::bin_size

private

The size of the bins in angle that is equal to 360 / NumBins.

Definition at line 72 of file RingProfile.h.

Referenced by exec(), and fromAngleToBin().

◆ centre_x

double Mantid::Algorithms::RingProfile::centre_x

private

copy of centre for axis(0)

Definition at line 66 of file RingProfile.h.

Referenced by checkInputsForNumericWorkspace(), checkInputsForSpectraWorkspace(), exec(), and getBinForPixel().

◆ centre_y

double Mantid::Algorithms::RingProfile::centre_y

private

copy of centre for axis(1)

Definition at line 68 of file RingProfile.h.

Referenced by checkInputsForNumericWorkspace(), checkInputsForSpectraWorkspace(), exec(), and getBinForPixel().

◆ centre_z

double Mantid::Algorithms::RingProfile::centre_z

private

copy of centre for axis(2)

Definition at line 70 of file RingProfile.h.

Referenced by checkInputsForSpectraWorkspace(), exec(), and getBinForPixel().

◆ clockwise

bool Mantid::Algorithms::RingProfile::clockwise

private

flag that indicate if Sense input was configure to clockwise

Definition at line 62 of file RingProfile.h.

Referenced by exec().

◆ m_progress

std::shared_ptr<API::Progress> Mantid::Algorithms::RingProfile::m_progress

protected

Definition at line 36 of file RingProfile.h.

Referenced by exec(), processInstrumentRingProfile(), and processNumericImageRingProfile().

◆ max_radius

double Mantid::Algorithms::RingProfile::max_radius

private

copy of the maxRadius input

Definition at line 58 of file RingProfile.h.

Referenced by exec(), and getBinForPixel().

◆ min_radius

double Mantid::Algorithms::RingProfile::min_radius

private

copy of the minRadius input

Definition at line 56 of file RingProfile.h.

Referenced by checkInputsForNumericWorkspace(), checkInputsForSpectraWorkspace(), and exec().

◆ num_bins

int Mantid::Algorithms::RingProfile::num_bins

private

copy of NumBins input

Definition at line 64 of file RingProfile.h.

Referenced by exec().

◆ start_angle

double Mantid::Algorithms::RingProfile::start_angle

private

copy of the StartAngle input

Definition at line 60 of file RingProfile.h.

Referenced by exec(), and fromAngleToBin().

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RingProfile()

Member Function Documentation

◆ category()

◆ checkInputsForNumericWorkspace()

◆ checkInputsForSpectraWorkspace()

◆ exec()

◆ fromAngleToBin()

◆ getBinForPixel() [1/2]

◆ getBinForPixel() [2/2]

◆ init()

◆ name()

◆ processInstrumentRingProfile()

◆ processNumericImageRingProfile()

◆ seeAlso()

◆ summary()

◆ version()

Member Data Documentation

◆ bin_size

◆ centre_x

◆ centre_y

◆ centre_z

◆ clockwise

◆ m_progress

◆ max_radius

◆ min_radius

◆ num_bins

◆ start_angle