Calculates anvred correction factors for attenuation due to absorption and scattering in a spherical sample. More...

#include <AnvredCorrection.h>

Inheritance diagram for Mantid::Crystal::AnvredCorrection:

Public Member Functions
	AnvredCorrection ()
	(Empty) Constructor

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 (these are not validated) algorithms related to this algorithm.A default implementation is provided.

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

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

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.

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

bool	isRecordingHistoryForChild ()

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

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

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

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

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

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

void	cancel () override
	Raises the cancel flag.

bool	getCancel () const
	Returns the cancellation state.

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

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

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

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

int	getLoggingOffset () const override
	returns the logging priority offset

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

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

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

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

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

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

virtual std::shared_ptr< Algorithm >	createChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
	Create a Child Algorithm.

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

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

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

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

virtual bool	processGroups ()
	Process WorkspaceGroup inputs.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	clear () override
	Clears all properties under management.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const std::string	workspaceMethodName () const override

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

const std::string	workspaceMethodInputProperty () const override

AlgorithmID	getAlgorithmID () const override
	Algorithm ID.

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

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

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

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

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

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

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

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

bool	isPropertyEnabled (const std::string &name) const
	Test if a given property should be enabled.

bool	isPropertyVisible (const std::string &name) const
	Test if a given property should be visible.

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 const > settings)
	Add a PropertySettings instance to the chain of settings for a given property.

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

virtual	~IPropertyManager ()=default

Static Public Member Functions
static double	calc_Astar (const double theta, const double mur)

static double	slantPathLength (const Geometry::Instrument_const_sptr &inst, const Geometry::ComponentInfo &componentInfo, const std::string &bankName, const double L2, const double depth)
	Slant path length through the detector, derived from the calibrated sample-to-panel distance.

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.

Protected Member Functions
virtual void	defineProperties ()
	A virtual function in which additional properties of an algorithm should be declared.

virtual void	retrieveProperties ()
	A virtual function in which additional properties should be retrieved into member variables.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
DataObjects::EventWorkspace_sptr	eventW
	Shared pointer to the event workspace.

API::MatrixWorkspace_sptr	m_inputWS
	A pointer to the input workspace.

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

bool	m_recordHistoryForProcessGroups = false
	Opt-in for overridden processGroups() implementations that want the parent algorithm history recorded on group outputs.

Private Member Functions
double	absor_sphere (const double twoth, const double wl, bool &muRTooLarge)
	function to calculate a spherical absorption correction and tbar.

void	BuildLamdaWeights ()
	Build the list of weights corresponding to different wavelengths.

void	cleanup ()
	Algorithm cleanup.

void	exec () override
	Execution code.

void	execEvent ()
	Event execution code.

double	getEventWeight (const double lamda, const double two_theta, bool &muRTooLarge)
	Get the weight factor that would be used for an event occuring at the specified wavelength, with the specified two_theta value.

void	init () override
	Initialisation code.

void	retrieveBaseProperties ()
	Fetch the properties and set the appropriate member variables.

double	scale_exec (std::string &bankName, const double lambda, const double depth, const Geometry::Instrument_const_sptr &inst, const double pathlength, double eventWeight)

std::map< std::string, std::string >	validateInputs () override
	validate inputs

Private Attributes
double	m_amu
	linear absoprtion coefficient in 1/cm

std::vector< double >	m_lamda_weight
	lmabda weights

bool	m_onlySphericalAbsorption

double	m_power_th
	Power of lamda in BuildLamdaWeights.

double	m_radius
	sample radius in cm

bool	m_returnTransmissionOnly

double	m_smu
	linear scattering coefficient in 1/cm

bool	m_useScaleFactors

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.

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

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

Detailed Description

Calculates anvred correction factors for attenuation due to absorption and scattering in a spherical sample.

Properties:

InputWorkspace - The name of the input workspace.
OutputWorkspace - The name of the output workspace. Can be the same as the input one.
PreserveEvents - Keep the output workspace as an EventWorkspace, if the input has events.
OnlySphericalAbsorption - All corrections done if false (default). If true, only the spherical absorption correction.
LinearScatteringCoef - Linear scattering coefficient in 1/cm
LinearAbsorptionCoef - Linear absorption coefficient at 1.8 Angstroms in 1/cm.
Radius - Radius of the sample in centimeters.

Author: Vickie Lynch, Dennis Mikkelson SNS

Date: 06/14/2011

Definition at line 80 of file AnvredCorrection.h.

Constructor & Destructor Documentation

◆ AnvredCorrection()

Mantid::Crystal::AnvredCorrection::AnvredCorrection ( )

(Empty) Constructor

Definition at line 75 of file AnvredCorrection.cpp.

Member Function Documentation

◆ absor_sphere()

double Mantid::Crystal::AnvredCorrection::absor_sphere	(	const double	twoth,
		const double	wl,
		bool &	muRTooLarge
	)

private

function to calculate a spherical absorption correction and tbar.

based on values in:

Weber, K., Acta Cryst. B, 25.6 (1969)

in this paper, a is the transmission and a* = 1/a is the absorption correction.

input are the smu (scattering) and amu (absorption at 1.8 ang.) linear absorption coefficients, the radius r of the sample the theta angle and wavelength. the absorption (absn) and tbar are returned.

a. j. schultz, june, 2008

Parameters

twoth	scattering angle
wl	scattering wavelength
muRTooLarge	bool to warn in muR limit exceeded

Returns: absorption

Definition at line 465 of file AnvredCorrection.cpp.

References calc_Astar(), m_amu, m_radius, m_smu, and Mantid::Crystal::radtodeg.

Referenced by getEventWeight().

◆ BuildLamdaWeights()

void Mantid::Crystal::AnvredCorrection::BuildLamdaWeights ( )

private

Build the list of weights corresponding to different wavelengths.

Although the spectrum file need not have a fixed number of points, it MUST have the spectrum recorded as a histogram with one more bin boundary than the number of bins. The entries in the table produced are:

1/( lamda^power * spec(lamda) )

Where power was chosen to give a relatively uniform intensity display in 3D. The power is currently 3 if an incident spectrum is present and 2.4 if no incident spectrum is used.

Definition at line 531 of file AnvredCorrection.cpp.

References m_lamda_weight, m_power_th, Mantid::Crystal::NUM_WAVELENGTHS, and Mantid::Crystal::STEPS_PER_ANGSTROM.

Referenced by exec().

◆ calc_Astar()

double Mantid::Crystal::AnvredCorrection::calc_Astar	(	const double	theta,
		const double	mur
	)

static

Definition at line 496 of file AnvredCorrection.cpp.

References Mantid::Crystal::pc, and Mantid::Crystal::radtodeg.

Referenced by absor_sphere(), and Mantid::Crystal::SaveHKL::absorbSphere().

◆ category()

const std::string Mantid::Crystal::AnvredCorrection::category ( ) const

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Reimplemented from Mantid::API::Algorithm.

Definition at line 96 of file AnvredCorrection.h.

◆ cleanup()

void Mantid::Crystal::AnvredCorrection::cleanup ( )

private

Algorithm cleanup.

Definition at line 274 of file AnvredCorrection.cpp.

References m_lamda_weight.

Referenced by exec(), and execEvent().

◆ defineProperties()

virtual void Mantid::Crystal::AnvredCorrection::defineProperties ( )

inlineprotectedvirtual

A virtual function in which additional properties of an algorithm should be declared.

Called by init().

Definition at line 116 of file AnvredCorrection.h.

Referenced by init().

◆ exec()

void Mantid::Crystal::AnvredCorrection::exec ( )

overrideprivatevirtual

Execution code.

Implements Mantid::API::Algorithm.

Definition at line 144 of file AnvredCorrection.cpp.

References Mantid::API::LogManager::addProperty(), BuildLamdaWeights(), cleanup(), Mantid::Kernel::Unit::convertSingleFromTOF(), Mantid::Kernel::DeltaEMode::Elastic, eventW, execEvent(), Mantid::API::Algorithm::g_log, getEventWeight(), Mantid::API::Algorithm::getProperty(), Mantid::API::LogManager::getPropertyValueAsType(), Mantid::API::LogManager::hasProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), lambda, m_inputWS, m_onlySphericalAbsorption, m_radius, m_returnTransmissionOnly, m_useScaleFactors, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::ProgressBase::report(), retrieveBaseProperties(), scale_exec(), Mantid::Kernel::IPropertyManager::setProperty(), slantPathLength(), Mantid::Kernel::threadSafe(), std::to_string(), Mantid::DataObjects::TOF_SORT, Mantid::Kernel::Logger::warning(), and Mantid::Geometry::Y.

◆ execEvent()

void Mantid::Crystal::AnvredCorrection::execEvent ( )

private

Event execution code.

Definition at line 279 of file AnvredCorrection.cpp.

References Mantid::API::LogManager::addProperty(), cleanup(), Mantid::Kernel::Unit::convertSingleFromTOF(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::DeltaEMode::Elastic, eventW, Mantid::API::Algorithm::g_log, getEventWeight(), Mantid::API::Algorithm::getPropertyValue(), Mantid::DataObjects::EventList::getWeightedEventsNoTime(), lambda, m_inputWS, m_onlySphericalAbsorption, m_radius, m_returnTransmissionOnly, m_useScaleFactors, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::Kernel::ProgressBase::report(), scale_exec(), Mantid::Kernel::IPropertyManager::setProperty(), slantPathLength(), Mantid::DataObjects::EventList::switchTo(), Mantid::Kernel::threadSafe(), std::to_string(), Mantid::DataObjects::TOF_SORT, value, Mantid::Kernel::Logger::warning(), and Mantid::API::WEIGHTED_NOTIME.

Referenced by exec().

◆ getEventWeight()

double Mantid::Crystal::AnvredCorrection::getEventWeight	(	const double	lamda,
		const double	two_theta,
		bool &	muRTooLarge
	)

private

Get the weight factor that would be used for an event occuring at the specified wavelength, with the specified two_theta value.

Parameters

lamda	The wavelength of an event.
two_theta	The scattering angle of the event.
muRTooLarge	bool to warn in muR limit exceeded in absorption correction

Returns: The weight factor for the specified position and wavelength.

Definition at line 420 of file AnvredCorrection.cpp.

References absor_sphere(), m_lamda_weight, m_onlySphericalAbsorption, m_radius, m_returnTransmissionOnly, and Mantid::Crystal::STEPS_PER_ANGSTROM.

Referenced by exec(), and execEvent().

◆ init()

void Mantid::Crystal::AnvredCorrection::init ( )

overrideprivatevirtual

Initialisation code.

Implements Mantid::API::Algorithm.

Definition at line 79 of file AnvredCorrection.cpp.

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

◆ name()

const std::string Mantid::Crystal::AnvredCorrection::name ( ) const

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 85 of file AnvredCorrection.h.

◆ retrieveBaseProperties()

void Mantid::Crystal::AnvredCorrection::retrieveBaseProperties ( )

private

Fetch the properties and set the appropriate member variables.

Definition at line 377 of file AnvredCorrection.cpp.

References Mantid::Kernel::Material::absorbXSection(), Mantid::EMPTY_DBL(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), m_amu, m_inputWS, m_power_th, m_radius, m_smu, Mantid::Kernel::Logger::notice(), Mantid::Kernel::Material::numberDensity(), Mantid::PhysicalConstants::NeutronAtom::ReferenceLambda, retrieveProperties(), rho, and Mantid::Kernel::Material::totalScatterXSection().

Referenced by exec().

◆ retrieveProperties()

virtual void Mantid::Crystal::AnvredCorrection::retrieveProperties ( )

inlineprotectedvirtual

A virtual function in which additional properties should be retrieved into member variables.

Definition at line 119 of file AnvredCorrection.h.

Referenced by retrieveBaseProperties().

◆ scale_exec()

double Mantid::Crystal::AnvredCorrection::scale_exec	(	std::string &	bankName,
		const double	lambda,
		const double	depth,
		const Geometry::Instrument_const_sptr &	inst,
		const double	pathlength,
		double	eventWeight
	)

private

Definition at line 580 of file AnvredCorrection.cpp.

References lambda.

Referenced by exec(), and execEvent().

◆ seeAlso()

const std::vector< std::string > Mantid::Crystal::AnvredCorrection::seeAlso ( ) const

inlineoverridevirtual

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

Reimplemented from Mantid::API::Algorithm.

Definition at line 94 of file AnvredCorrection.h.

◆ slantPathLength()

double Mantid::Crystal::AnvredCorrection::slantPathLength	(	const Geometry::Instrument_const_sptr &	inst,
		const Geometry::ComponentInfo &	componentInfo,
		const std::string &	bankName,
		const double	L2,
		const double	depth
	)

static

Slant path length through the detector, derived from the calibrated sample-to-panel distance.

Slant path length through the detector, used to correct for the oblique path through the scintillator glass away from the panel centre.

Static and public so that it can be asserted directly. An end-to-end test cannot isolate this term, because displacing a panel also changes L2 and the scattering angle, which move the correction through other factors whether or not the distance is taken from calibrated geometry.

Parameters

inst	:: the instrument, used only to identify CORELLI
componentInfo	:: the parameterized view of the instrument geometry
bankName	:: name of the bank holding the detector
L2	:: sample-to-detector distance
depth	:: thickness of the scintillator glass

Returns: the slant path length

Definition at line 563 of file AnvredCorrection.cpp.

References Mantid::Geometry::ComponentInfo::children(), Mantid::Kernel::V3D::distance(), Mantid::Geometry::ComponentInfo::indexOfAny(), Mantid::Geometry::ComponentInfo::position(), and Mantid::Geometry::ComponentInfo::samplePosition().

Referenced by exec(), and execEvent().

◆ summary()

const std::string Mantid::Crystal::AnvredCorrection::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 87 of file AnvredCorrection.h.

◆ validateInputs()

std::map< std::string, std::string > Mantid::Crystal::AnvredCorrection::validateInputs ( void )

overrideprivatevirtual

validate inputs

Reimplemented from Mantid::API::Algorithm.

Definition at line 123 of file AnvredCorrection.cpp.

References Mantid::EMPTY_DBL(), Mantid::API::Algorithm::getProperty(), and Mantid::Geometry::detail::ShapeInfo::SPHERE.

◆ version()

int Mantid::Crystal::AnvredCorrection::version ( ) const

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 93 of file AnvredCorrection.h.

Member Data Documentation

◆ eventW

DataObjects::EventWorkspace_sptr Mantid::Crystal::AnvredCorrection::eventW

protected

Shared pointer to the event workspace.

Definition at line 123 of file AnvredCorrection.h.

Referenced by exec(), and execEvent().

◆ m_amu

double Mantid::Crystal::AnvredCorrection::m_amu

private

linear absoprtion coefficient in 1/cm

Definition at line 146 of file AnvredCorrection.h.

Referenced by absor_sphere(), and retrieveBaseProperties().

◆ m_inputWS

API::MatrixWorkspace_sptr Mantid::Crystal::AnvredCorrection::m_inputWS

protected

A pointer to the input workspace.

Definition at line 121 of file AnvredCorrection.h.

Referenced by exec(), execEvent(), and retrieveBaseProperties().

◆ m_lamda_weight

std::vector<double> Mantid::Crystal::AnvredCorrection::m_lamda_weight

private

lmabda weights

Definition at line 149 of file AnvredCorrection.h.

Referenced by BuildLamdaWeights(), cleanup(), and getEventWeight().

◆ m_onlySphericalAbsorption

bool Mantid::Crystal::AnvredCorrection::m_onlySphericalAbsorption

private

Definition at line 150 of file AnvredCorrection.h.

Referenced by exec(), execEvent(), and getEventWeight().

◆ m_power_th

double Mantid::Crystal::AnvredCorrection::m_power_th

private

Power of lamda in BuildLamdaWeights.

Definition at line 148 of file AnvredCorrection.h.

Referenced by BuildLamdaWeights(), and retrieveBaseProperties().

◆ m_radius

double Mantid::Crystal::AnvredCorrection::m_radius

private

sample radius in cm

Definition at line 147 of file AnvredCorrection.h.

Referenced by absor_sphere(), exec(), execEvent(), getEventWeight(), and retrieveBaseProperties().

◆ m_returnTransmissionOnly

bool Mantid::Crystal::AnvredCorrection::m_returnTransmissionOnly

private

Definition at line 151 of file AnvredCorrection.h.

Referenced by exec(), execEvent(), and getEventWeight().

◆ m_smu

double Mantid::Crystal::AnvredCorrection::m_smu

private

linear scattering coefficient in 1/cm

Definition at line 145 of file AnvredCorrection.h.

Referenced by absor_sphere(), and retrieveBaseProperties().

◆ m_useScaleFactors

bool Mantid::Crystal::AnvredCorrection::m_useScaleFactors

private

Definition at line 152 of file AnvredCorrection.h.

Referenced by exec(), and execEvent().

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

Framework/Crystal/inc/MantidCrystal/AnvredCorrection.h
Framework/Crystal/src/AnvredCorrection.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AnvredCorrection()

Member Function Documentation

◆ absor_sphere()

◆ BuildLamdaWeights()

◆ calc_Astar()

◆ category()

◆ cleanup()

◆ defineProperties()

◆ exec()

◆ execEvent()

◆ getEventWeight()

◆ init()

◆ name()

◆ retrieveBaseProperties()

◆ retrieveProperties()

◆ scale_exec()

◆ seeAlso()

◆ slantPathLength()

◆ summary()

◆ validateInputs()

◆ version()

Member Data Documentation

◆ eventW

◆ m_amu

◆ m_inputWS

◆ m_lamda_weight

◆ m_onlySphericalAbsorption

◆ m_power_th

◆ m_radius

◆ m_returnTransmissionOnly

◆ m_smu

◆ m_useScaleFactors