Loads an ILL IN4/5/6/Panther NeXus file into a Mantid workspace. More...

#include <LoadILLTOF3.h>

Inheritance diagram for Mantid::DataHandling::LoadILLTOF3:

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

int	confidence (Nexus::NexusDescriptor &descriptor) const override
	Returns a confidence value that this algorithm can load a file.

	LoadILLTOF3 ()
	Constructor.

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

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.

Public Member Functions inherited from Mantid::API::IFileLoader< Nexus::NexusDescriptor >
virtual bool	loadMutipleAsOne ()
	Returns a value indicating whether or not loader wants to load multiple files into a single workspace.

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

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

Private Member Functions
void	addAllNexusFieldsAsProperties (const std::string &filename)
	Goes through all the fields of the NeXus file and adds them as parameters in the workspace.

void	addEnergyToRun ()
	Calculates the incident energy from the wavelength and adds it as sample log 'Ei'.

void	addFacility ()
	Adds facility info to the sample logs.

void	addPulseInterval ()
	Calculates and adds the pulse intervals for the run.

void	exec () override
	Executes the algorithm.

void	fillScanWorkspace (const Nexus::NXEntry &entry, const std::vector< std::string > &monitorList)
	Fills scan workspace with data and monitor data counts.

void	fillStaticWorkspace (const Nexus::NXEntry &entry, const std::vector< std::string > &monitorList, bool convertToTOF)
	Fills the non-scan measurement data into the workspace, including that from the monitor.

std::vector< std::string >	getMonitorInfo (const Nexus::NXEntry &firstEntry)
	Finds monitor data names and stores them in a vector.

void	init () override
	Initialises the algorithm.

void	initWorkspace (const Nexus::NXEntry &entry)
	Creates the workspace and initialises member variables with the corresponding values.

void	loadInstrumentDetails (const Nexus::NXEntry &)
	Sets the instrument name along with its address in the nexus file.

void	loadTimeDetails (const Nexus::NXEntry &entry)
	Load the time details from the nexus file.

std::vector< double >	prepareAxis (const Nexus::NXEntry &entry, bool convertToTOF)
	Prepares X axis for the workspace being loaded.

Private Attributes
double	m_channelWidth

std::string	m_instrumentAddress
	Name of the instrument address.

std::string	m_instrumentName
	Name of the instrument.

bool	m_isScan

API::MatrixWorkspace_sptr	m_localWorkspace

std::string	m_monitorName

size_t	m_numberOfChannels

size_t	m_numberOfHistograms

size_t	m_numberOfMonitors

size_t	m_numberOfPixelsPerTube

size_t	m_numberOfTubes

double	m_timeOfFlightDelay

double	m_wavelength

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Kernel::Logger	m_log
	Logger for this algorithm.

Kernel::Logger &	g_log

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

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

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

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

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

Detailed Description

Loads an ILL IN4/5/6/Panther NeXus file into a Mantid workspace.

Definition at line 20 of file LoadILLTOF3.h.

Constructor & Destructor Documentation

◆ LoadILLTOF3()

Mantid::DataHandling::LoadILLTOF3::LoadILLTOF3 ( )

Constructor.

Definition at line 61 of file LoadILLTOF3.cpp.

Member Function Documentation

◆ addAllNexusFieldsAsProperties()

void Mantid::DataHandling::LoadILLTOF3::addAllNexusFieldsAsProperties ( const std::string & filename )

private

Goes through all the fields of the NeXus file and adds them as parameters in the workspace.

Parameters

filename The NeXus file

Definition at line 261 of file LoadILLTOF3.cpp.

References Mantid::DataHandling::LoadHelper::addNexusFieldsToWsRun(), Mantid::API::LogManager::addProperty(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::LogManager::getPropertyValueAsType(), m_localWorkspace, and READ.

Referenced by exec().

◆ addEnergyToRun()

void Mantid::DataHandling::LoadILLTOF3::addEnergyToRun ( )

private

Calculates the incident energy from the wavelength and adds it as sample log 'Ei'.

Definition at line 282 of file LoadILLTOF3.cpp.

References Mantid::API::LogManager::addProperty(), Mantid::DataHandling::LoadHelper::calculateEnergy(), m_localWorkspace, and m_wavelength.

Referenced by exec().

◆ addFacility()

void Mantid::DataHandling::LoadILLTOF3::addFacility ( )

private

Adds facility info to the sample logs.

Definition at line 292 of file LoadILLTOF3.cpp.

References Mantid::API::LogManager::addProperty(), and m_localWorkspace.

Referenced by exec().

◆ addPulseInterval()

void Mantid::DataHandling::LoadILLTOF3::addPulseInterval ( )

private

Calculates and adds the pulse intervals for the run.

Definition at line 300 of file LoadILLTOF3.cpp.

References Mantid::API::LogManager::addProperty(), Mantid::API::LogManager::getPropertyAsSingleValue(), m_instrumentName, and m_localWorkspace.

Referenced by exec().

◆ category()

const std::string Mantid::DataHandling::LoadILLTOF3::category ( ) const

inlineoverridevirtual

Algorithm's category for identification.

Reimplemented from Mantid::API::Algorithm.

Definition at line 33 of file LoadILLTOF3.h.

◆ confidence()

int Mantid::DataHandling::LoadILLTOF3::confidence ( Nexus::NexusDescriptor & descriptor ) const

overridevirtual

Returns a confidence value that this algorithm can load a file.

Return the confidence with with this algorithm can load the file.

Parameters

descriptor A descriptor for the file

Returns: An integer specifying the confidence level. 0 indicates it will not be used

Implements Mantid::API::IFileLoader< Nexus::NexusDescriptor >.

Definition at line 43 of file LoadILLTOF3.cpp.

◆ exec()

void Mantid::DataHandling::LoadILLTOF3::exec ( )

overrideprivatevirtual

◆ fillScanWorkspace()

void Mantid::DataHandling::LoadILLTOF3::fillScanWorkspace	(	const Nexus::NXEntry &	entry,
		const std::vector< std::string > &	monitorList
	)

private

Fills scan workspace with data and monitor data counts.

Parameters

entry	The Nexus entry to load the data from
monitorList	Vector containing addresses to monitor data

Definition at line 426 of file LoadILLTOF3.cpp.

References Mantid::DataHandling::LoadHelper::fillStaticWorkspace(), Mantid::DataHandling::LoadHelper::getDoubleDataset(), Mantid::DataHandling::LoadHelper::getIntDataset(), index, m_localWorkspace, and prepareAxis().

Referenced by exec().

◆ fillStaticWorkspace()

void Mantid::DataHandling::LoadILLTOF3::fillStaticWorkspace	(	const Nexus::NXEntry &	entry,
		const std::vector< std::string > &	monitorList,
		bool	convertToTOF
	)

private

Fills the non-scan measurement data into the workspace, including that from the monitor.

Parameters

entry	The Nexus entry
monitorList	Vector containing addresses to monitor data
convertToTOF	Should the bin edges be converted to time of flight or keep the channel indexes

Definition at line 383 of file LoadILLTOF3.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::DataHandling::LoadHelper::fillStaticWorkspace(), Mantid::API::Algorithm::g_log, Mantid::DataHandling::LoadHelper::getIntDataset(), m_instrumentName, m_localWorkspace, m_numberOfPixelsPerTube, m_numberOfTubes, and prepareAxis().

Referenced by exec().

◆ getMonitorInfo()

std::vector< std::string > Mantid::DataHandling::LoadILLTOF3::getMonitorInfo ( const Nexus::NXEntry & firstEntry )

private

Finds monitor data names and stores them in a vector.

Parameters

firstEntry The NeXus entry

Returns: List of monitor data

Definition at line 118 of file LoadILLTOF3.cpp.

References Mantid::Nexus::NXClass::groups(), m_isScan, and m_numberOfMonitors.

Referenced by exec().

◆ init()

void Mantid::DataHandling::LoadILLTOF3::init ( )

overrideprivatevirtual

Initialises the algorithm.

Implements Mantid::API::Algorithm.

Definition at line 66 of file LoadILLTOF3.cpp.

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

◆ initWorkspace()

void Mantid::DataHandling::LoadILLTOF3::initWorkspace ( const Nexus::NXEntry & entry )

private

Creates the workspace and initialises member variables with the corresponding values.

Parameters

entry The NeXus entry

IN4 : Rosace detector is in a different field.

Definition at line 177 of file LoadILLTOF3.cpp.

References Mantid::Nexus::NXClass::containsDataSet(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::DataHandling::LoadHelper::getIntDataset(), Mantid::Kernel::SingletonHolder< T >::Instance(), m_instrumentName, m_isScan, m_localWorkspace, m_monitorName, m_numberOfChannels, m_numberOfHistograms, m_numberOfMonitors, m_numberOfPixelsPerTube, m_numberOfTubes, and Mantid::Nexus::NXClass::openNXGroup().

Referenced by exec().

◆ loadInstrumentDetails()

void Mantid::DataHandling::LoadILLTOF3::loadInstrumentDetails ( const Nexus::NXEntry & firstEntry )

private

Sets the instrument name along with its address in the nexus file.

Parameters

firstEntry The NeXus entry

Definition at line 142 of file LoadILLTOF3.cpp.

References Mantid::Nexus::NXClass::containsGroup(), Mantid::Kernel::Logger::debug(), Mantid::DataHandling::LoadHelper::findInstrumentNexusAddress(), Mantid::API::Algorithm::g_log, Mantid::DataHandling::LoadHelper::getStringFromNexusAddress(), m_instrumentAddress, m_instrumentName, and m_monitorName.

Referenced by exec().

◆ loadTimeDetails()

void Mantid::DataHandling::LoadILLTOF3::loadTimeDetails ( const Nexus::NXEntry & entry )

private

Load the time details from the nexus file.

Parameters

entry :: The Nexus entry

Definition at line 231 of file LoadILLTOF3.cpp.

References Mantid::Nexus::NXClass::containsDataSet(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::Nexus::NXClass::getFloat(), Mantid::Nexus::NXDataSetTyped< T >::load(), m_channelWidth, m_monitorName, m_timeOfFlightDelay, m_wavelength, Mantid::Nexus::NXClass::openNXFloat(), and Mantid::Nexus::NXClass::openNXGroup().

Referenced by exec().

◆ name()

const std::string Mantid::DataHandling::LoadILLTOF3::name ( ) const

inlineoverridevirtual

Algorithm's name.

Implements Mantid::API::Algorithm.

Definition at line 25 of file LoadILLTOF3.h.

◆ prepareAxis()

std::vector< double > Mantid::DataHandling::LoadILLTOF3::prepareAxis	(	const Nexus::NXEntry &	entry,
		bool	convertToTOF
	)

private

Prepares X axis for the workspace being loaded.

Parameters

entry	NeXus entry used to get scanned parameter values in the scan case
convertToTOF	Should the bin edges be converted to time of flight or keep the channel indices

Returns: Vector of doubles containing bin edges or point centres positions

Definition at line 334 of file LoadILLTOF3.cpp.

References Mantid::Nexus::NXClass::containsDataSet(), Mantid::Nexus::NXDataSet::dim0(), Mantid::DataHandling::LoadHelper::getDoubleDataset(), index, Mantid::Nexus::NXDataSetTyped< T >::load(), m_channelWidth, m_isScan, m_localWorkspace, m_monitorName, m_numberOfChannels, m_timeOfFlightDelay, m_wavelength, Mantid::Nexus::NXClass::openNXGroup(), and Mantid::Nexus::NXClass::openNXInt().

Referenced by fillScanWorkspace(), and fillStaticWorkspace().

◆ seeAlso()

const std::vector< std::string > Mantid::DataHandling::LoadILLTOF3::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 31 of file LoadILLTOF3.h.

◆ summary()

const std::string Mantid::DataHandling::LoadILLTOF3::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 27 of file LoadILLTOF3.h.

◆ version()

int Mantid::DataHandling::LoadILLTOF3::version ( ) const

inlineoverridevirtual

Algorithm's version.

Implements Mantid::API::Algorithm.

Definition at line 30 of file LoadILLTOF3.h.

Member Data Documentation

◆ m_channelWidth

double Mantid::DataHandling::LoadILLTOF3::m_channelWidth

private

Definition at line 74 of file LoadILLTOF3.h.

Referenced by loadTimeDetails(), and prepareAxis().

◆ m_instrumentAddress

std::string Mantid::DataHandling::LoadILLTOF3::m_instrumentAddress

private

Name of the instrument address.

Definition at line 63 of file LoadILLTOF3.h.

Referenced by loadInstrumentDetails().

◆ m_instrumentName

std::string Mantid::DataHandling::LoadILLTOF3::m_instrumentName

private

Name of the instrument.

Definition at line 62 of file LoadILLTOF3.h.

Referenced by addPulseInterval(), exec(), fillStaticWorkspace(), initWorkspace(), and loadInstrumentDetails().

◆ m_isScan

bool Mantid::DataHandling::LoadILLTOF3::m_isScan

private

Definition at line 77 of file LoadILLTOF3.h.

Referenced by exec(), getMonitorInfo(), initWorkspace(), and prepareAxis().

◆ m_localWorkspace

API::MatrixWorkspace_sptr Mantid::DataHandling::LoadILLTOF3::m_localWorkspace

private

Definition at line 60 of file LoadILLTOF3.h.

Referenced by addAllNexusFieldsAsProperties(), addEnergyToRun(), addFacility(), addPulseInterval(), exec(), fillScanWorkspace(), fillStaticWorkspace(), initWorkspace(), and prepareAxis().

◆ m_monitorName

std::string Mantid::DataHandling::LoadILLTOF3::m_monitorName

private

Definition at line 76 of file LoadILLTOF3.h.

Referenced by initWorkspace(), loadInstrumentDetails(), loadTimeDetails(), and prepareAxis().

◆ m_numberOfChannels

size_t Mantid::DataHandling::LoadILLTOF3::m_numberOfChannels

private

Definition at line 68 of file LoadILLTOF3.h.

Referenced by initWorkspace(), and prepareAxis().

◆ m_numberOfHistograms

size_t Mantid::DataHandling::LoadILLTOF3::m_numberOfHistograms

private

Definition at line 69 of file LoadILLTOF3.h.

Referenced by initWorkspace().

◆ m_numberOfMonitors

size_t Mantid::DataHandling::LoadILLTOF3::m_numberOfMonitors

private

Definition at line 70 of file LoadILLTOF3.h.

Referenced by getMonitorInfo(), and initWorkspace().

◆ m_numberOfPixelsPerTube

size_t Mantid::DataHandling::LoadILLTOF3::m_numberOfPixelsPerTube

private

Definition at line 67 of file LoadILLTOF3.h.

Referenced by fillStaticWorkspace(), and initWorkspace().

◆ m_numberOfTubes

size_t Mantid::DataHandling::LoadILLTOF3::m_numberOfTubes

private

Definition at line 66 of file LoadILLTOF3.h.

Referenced by fillStaticWorkspace(), and initWorkspace().

◆ m_timeOfFlightDelay

double Mantid::DataHandling::LoadILLTOF3::m_timeOfFlightDelay

private

Definition at line 75 of file LoadILLTOF3.h.

Referenced by loadTimeDetails(), and prepareAxis().

◆ m_wavelength

double Mantid::DataHandling::LoadILLTOF3::m_wavelength

private

Definition at line 73 of file LoadILLTOF3.h.

Referenced by addEnergyToRun(), loadTimeDetails(), and prepareAxis().

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

Framework/DataHandling/inc/MantidDataHandling/LoadILLTOF3.h
Framework/DataHandling/src/LoadILLTOF3.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LoadILLTOF3()

Member Function Documentation

◆ addAllNexusFieldsAsProperties()

◆ addEnergyToRun()

◆ addFacility()

◆ addPulseInterval()

◆ category()

◆ confidence()

◆ exec()

◆ fillScanWorkspace()

◆ fillStaticWorkspace()

◆ getMonitorInfo()

◆ init()

◆ initWorkspace()

◆ loadInstrumentDetails()

◆ loadTimeDetails()

◆ name()

◆ prepareAxis()

◆ seeAlso()

◆ summary()

◆ version()

Member Data Documentation

◆ m_channelWidth

◆ m_instrumentAddress

◆ m_instrumentName

◆ m_isScan

◆ m_localWorkspace

◆ m_monitorName

◆ m_numberOfChannels

◆ m_numberOfHistograms

◆ m_numberOfMonitors

◆ m_numberOfPixelsPerTube

◆ m_numberOfTubes

◆ m_timeOfFlightDelay

◆ m_wavelength