Load Event Nexus files. More...

#include <Nexus/LoadEventNexus.h>

Inheritance diagram for Mantid::DataHandling::LoadEventNexus:

Public Types
enum class	LoaderType { MPI , MULTIPROCESS , DEFAULT }

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

Public Member Functions
const std::string	category () const override
	Category. More...

int	confidence (Kernel::NexusHDF5Descriptor &descriptor) const override
	Return the confidence with with this algorithm can load the file. More...

	LoadEventNexus ()
	Empty default constructor. More...

const std::string	name () const override
	function to return a name of the algorithm, must be overridden in all algorithms 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	summary () const override
	Summary of algorithms purpose. More...

int	version () const override
	Version. More...

Public Member Functions inherited from Mantid::API::NexusFileLoader
virtual int	confidence (Kernel::NexusHDF5Descriptor &descriptor) const override=0
	Returns a confidence value that this algorithm can load a file. More...

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) override
	Create a Child Algorithm. More...

void	exec () override final
	Virtual method - must be overridden by concrete algorithm. More...

virtual void	execLoader ()=0

virtual const std::shared_ptr< Mantid::Kernel::NexusHDF5Descriptor >	getFileInfo () const noexcept
	Required to pass m_fileInfo to static functions Keeping it shared_ptr to match setFileInfo signature (although passing ownership is not the main goal). More...

virtual std::string	getFilenamePropertyName () const

virtual void	setFileInfo (std::shared_ptr< Mantid::Kernel::NexusHDF5Descriptor > fileInfo)

Public Member Functions inherited from Mantid::API::IFileLoader< Mantid::Kernel::NexusHDF5Descriptor >
virtual int	confidence (Mantid::Kernel::NexusHDF5Descriptor &descriptor) const=0
	Returns a confidence value that this algorithm can load a file. More...

virtual bool	loadMutipleAsOne ()
	Returns a value indicating whether or not loader wants to load multiple files into a single workspace. 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...

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

Static Public Member Functions
static void	checkForCorruptedPeriods (std::unique_ptr< Kernel::TimeSeriesProperty< int > > tempPeriodLog, std::unique_ptr< const Kernel::TimeSeriesProperty< int > > &periodLog, const int &nPeriods, const std::string &nexusfilename)
	Check for corrupted period logs If data is historical (1 periods, period is labelled 0) then change period labels to 1 If number of periods does not match expected number of periods then throw an error. More...

template<typename T >
static void	loadEntryMetadata (const std::string &nexusfilename, T WS, const std::string &entry_name, const Kernel::NexusHDF5Descriptor &descriptor)
	Load the run number and other meta data from the given bank. More...

template<typename T >
static bool	loadInstrument (const std::string &nexusfilename, T localWorkspace, const std::string &top_entry_name, Algorithm alg, const Kernel::NexusHDF5Descriptor descriptor=nullptr)
	Load instrument from Nexus file if possible, else from IDF spacified by Nexus file. More...

static void	loadSampleDataISIScompatibility (::NeXus::File &file, EventWorkspaceCollection &WS)
	Load information of the sample. More...

static std::string	readInstrumentFromISIS_VMSCompat (::NeXus::File &hFile)
	method used to return instrument name for some old ISIS files where it is not written properly within the instrument More...

template<>
bool	runLoadIDFFromNexus (const std::string &nexusfilename, EventWorkspaceCollection_sptr localWorkspace, const std::string &top_entry_name, Algorithm *alg)
	Load the instrument from the nexus file. More...

template<typename T >
static bool	runLoadIDFFromNexus (const std::string &nexusfilename, T localWorkspace, const std::string &top_entry_name, Algorithm *alg)
	Load instrument for Nexus file. More...

template<>
bool	runLoadInstrument (const std::string &nexusfilename, EventWorkspaceCollection_sptr localWorkspace, const std::string &top_entry_name, Algorithm alg, const Kernel::NexusHDF5Descriptor descriptor)
	Load the instrument definition file specified by info in the NXS file for a EventWorkspaceCollection. More...

template<typename T >
static bool	runLoadInstrument (const std::string &nexusfilename, T localWorkspace, const std::string &top_entry_name, Algorithm alg, const Kernel::NexusHDF5Descriptor descriptor=nullptr)
	Load instrument from IDF file specified by Nexus file. More...

template<>
std::shared_ptr< BankPulseTimes >	runLoadNexusLogs (const std::string &nexusfilename, EventWorkspaceCollection_sptr localWorkspace, API::Algorithm &alg, bool returnpulsetimes, int &nPeriods, std::unique_ptr< const TimeSeriesProperty< int > > &periodLog)
	Load the instrument from the nexus file. More...

template<>
std::shared_ptr< BankPulseTimes >	runLoadNexusLogs (const std::string &nexusfilename, EventWorkspaceCollection_sptr localWorkspace, API::Algorithm &alg, bool returnpulsetimes, int &nPeriods, std::unique_ptr< const TimeSeriesProperty< int > > &periodLog, const std::vector< std::string > &allow_list, const std::vector< std::string > &block_list)
	Load the instrument from the nexus file. More...

template<typename T >
static std::shared_ptr< BankPulseTimes >	runLoadNexusLogs (const std::string &nexusfilename, T localWorkspace, Algorithm &alg, bool returnpulsetimes, int &nPeriods, std::unique_ptr< const Kernel::TimeSeriesProperty< int > > &periodLog)
	Load the log from the nexus file. More...

template<typename T >
static std::shared_ptr< BankPulseTimes >	runLoadNexusLogs (const std::string &nexusfilename, T localWorkspace, Algorithm &alg, bool returnpulsetimes, int &nPeriods, std::unique_ptr< const Kernel::TimeSeriesProperty< int > > &periodLog, const std::vector< std::string > &allow_list, const std::vector< std::string > &block_list)
	Load the log from the nexus file. More...

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
size_t	bad_tofs
	Count of all the "bad" tofs found. More...

double	compressTolerance
	Tolerance for CompressEvents; use -1 to mean don't compress. More...

size_t	discarded_events
	A count of events discarded because they came from a pixel that's not in the IDF. More...

Mantid::Types::Core::DateAndTime	filter_time_start
	Filter by start time. More...

Mantid::Types::Core::DateAndTime	filter_time_stop
	Filter by stop time. More...

double	filter_tof_max
	Filter by a maximum time-of-flight. More...

double	filter_tof_min
	Filter by a minimum time-of-flight. More...

double	longest_tof
	Limits found to tof. More...

std::shared_ptr< BankPulseTimes >	m_allBanksPulseTimes
	Pulse times for ALL banks, taken from proton_charge log. More...

std::unique_ptr<::NeXus::File >	m_file

std::string	m_filename
	The name and path of the input file. More...

int32_t	m_specMax
	Maximum spectrum to load. More...

int32_t	m_specMin
	Minimum spectrum to load. More...

std::mutex	m_tofMutex
	Mutex protecting tof limits. More...

std::string	m_top_entry_name
	name of top level NXentry to use More...

std::shared_ptr< EventWorkspaceCollection >	m_ws
	The workspace being filled out. More...

double	shortest_tof
	Limits found to tof. 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
Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const override
	Get correct execution mode based on input storage modes for an MPI run. More...

Protected Member Functions inherited from Mantid::API::ParallelAlgorithm
Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const override
	Get correct execution mode based on input storage modes for an MPI run. More...

	~ParallelAlgorithm ()=default

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

Private Member Functions
DataObjects::EventWorkspace_sptr	createEmptyEventWorkspace ()

void	createSpectraMapping (const std::string &nxsfile, const bool monitorsOnly, const std::vector< std::string > &bankNames=std::vector< std::string >())
	Create the required spectra mapping. More...

LoadEventNexus::LoaderType	defineLoaderType (const bool haveWeights, const bool oldNeXusFileNames, const std::string &classType) const
	The parallel loader currently has no support for a series of special cases, as indicated by the return value of this method. More...

void	deleteBanks (const EventWorkspaceCollection_sptr &workspace, const std::vector< std::string > &bankNames)
	Deletes banks for a workspace given the bank names. More...

void	execLoader () override
	Execution code. More...

template<>
void	filterDuringPause (EventWorkspaceCollection_sptr workspace)

template<typename T >
void	filterDuringPause (T workspace)

template<>
EventWorkspaceCollection_sptr	filterEventsByTime (EventWorkspaceCollection_sptr workspace, Mantid::Types::Core::DateAndTime &startTime, Mantid::Types::Core::DateAndTime &stopTime)

template<typename T >
T	filterEventsByTime (T workspace, Mantid::Types::Core::DateAndTime &startTime, Mantid::Types::Core::DateAndTime &stopTime)
	Filter the events by pulse time - no in place version so have to return workspace. More...

void	init () override
	Intialisation code. More...

void	loadEvents (API::Progress *const prog, const bool monitors)
	Load events from the file. More...

std::unique_ptr< std::pair< std::vector< int32_t >, std::vector< int32_t > > >	loadISISVMSSpectraMapping (const std::string &entry_name)
	Load a spectra mapping from the given file. More...

void	runLoadMonitors ()
	Load the Monitors from the NeXus file into a workspace. More...

void	safeOpenFile (const std::string &fname)
	to open the nexus file with specific exception handling/message More...

void	setTimeFilters (const bool monitors)
	Set the filters on TOF. More...

void	setTopEntryName ()
	Set the top entry field name. More...

Private Attributes
bool	event_id_is_spec
	True if the event_id is spectrum no not pixel ID. More...

bool	loadlogs
	Do we load the sample logs? More...

bool	m_instrument_loaded_correctly
	Was the instrument loaded? More...

Additional Inherited Members
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...

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

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

Load Event Nexus files.

Required Properties:

Filename - The name of and path to the input NeXus file
Workspace - The name of the workspace to output

Date: Sep 27, 2010

Definition at line 76 of file LoadEventNexus.h.

Member Enumeration Documentation

◆ LoaderType

enum class Mantid::DataHandling::LoadEventNexus::LoaderType

strong

Enumerator
MPI
MULTIPROCESS
DEFAULT

Definition at line 829 of file LoadEventNexus.cpp.

Constructor & Destructor Documentation

◆ LoadEventNexus()

Mantid::DataHandling::LoadEventNexus::LoadEventNexus ( )

Empty default constructor.

Definition at line 81 of file LoadEventNexus.cpp.

Member Function Documentation

◆ category()

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

inlineoverridevirtual

Category.

Reimplemented from Mantid::API::Algorithm.

Definition at line 95 of file LoadEventNexus.h.

◆ checkForCorruptedPeriods()

void Mantid::DataHandling::LoadEventNexus::checkForCorruptedPeriods	(	std::unique_ptr< Kernel::TimeSeriesProperty< int > >	tempPeriodLog,
		std::unique_ptr< const Kernel::TimeSeriesProperty< int > > &	periodLog,
		const int &	nPeriods,
		const std::string &	nexusfilename
	)

static

Check for corrupted period logs If data is historical (1 periods, period is labelled 0) then change period labels to 1 If number of periods does not match expected number of periods then throw an error.

Parameters

tempPeriodLog	:: a temporary local copy of period logs, which will change
periodLog	:: unique pointer which will point to period logs once they have been changed
nPeriods	:: the value in the nperiods log of the run. Number of expected periods
nexusfilename	:: the filename of the run to load

Definition at line 747 of file LoadEventNexus.cpp.

References std::to_string().

Referenced by runLoadNexusLogs().

◆ confidence()

int Mantid::DataHandling::LoadEventNexus::confidence ( Kernel::NexusHDF5Descriptor & descriptor ) const

overridevirtual

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

Definition at line 93 of file LoadEventNexus.cpp.

References confidence(), Mantid::Kernel::NexusHDF5Descriptor::getAllEntries(), and Mantid::Kernel::NexusHDF5Descriptor::isEntry().

Referenced by confidence(), and Mantid::DataHandling::UpdateInstrumentFromFile::exec().

◆ createEmptyEventWorkspace()

DataObjects::EventWorkspace_sptr Mantid::DataHandling::LoadEventNexus::createEmptyEventWorkspace ( )

private

◆ createSpectraMapping()

void Mantid::DataHandling::LoadEventNexus::createSpectraMapping	(	const std::string &	nxsfile,
		const bool	monitorsOnly,
		const std::vector< std::string > &	bankNames = `std::vector<std::string>()`
	)

private

Create the required spectra mapping.

If the file contains an isis_vms_compat block then the mapping is read from there, otherwise a 1:1 map with the instrument is created (along with the associated spectra axis)

Parameters

nxsfile	:: The name of a nexus file to load the mapping from
monitorsOnly	:: Load only the monitors is true
bankNames	:: An optional bank name for loading specified banks

Definition at line 1391 of file LoadEventNexus.cpp.

References Mantid::API::Algorithm::communicator(), Mantid::Kernel::Logger::debug(), Mantid::DataHandling::LoadEventNexusIndexSetup::eventIDLimits(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::isDefault(), loadISISVMSSpectraMapping(), m_specMax, m_specMin, m_top_entry_name, m_ws, Mantid::DataHandling::LoadEventNexusIndexSetup::makeIndexInfo(), and Mantid::Kernel::Logger::warning().

Referenced by loadEvents().

◆ defineLoaderType()

LoadEventNexus::LoaderType Mantid::DataHandling::LoadEventNexus::defineLoaderType	(	const bool	haveWeights,
		const bool	oldNeXusFileNames,
		const std::string &	classType
	)		const

private

The parallel loader currently has no support for a series of special cases, as indicated by the return value of this method.

Definition at line 1630 of file LoadEventNexus.cpp.

References DEFAULT, filter_time_start, filter_time_stop, filter_tof_max, filter_tof_min, Mantid::API::Algorithm::getPropertyValue(), Mantid::API::Algorithm::isDefault(), m_ws, MPI, and MULTIPROCESS.

◆ deleteBanks()

void Mantid::DataHandling::LoadEventNexus::deleteBanks	(	const EventWorkspaceCollection_sptr &	workspace,
		const std::vector< std::string > &	bankNames
	)

private

Deletes banks for a workspace given the bank names.

Parameters

workspace	:: The workspace to contain the spectra mapping
bankNames	:: Bank names that are in Nexus file

Definition at line 1305 of file LoadEventNexus.cpp.

References Mantid::Geometry::d, and workspace.

◆ execLoader()

void Mantid::DataHandling::LoadEventNexus::execLoader ( )

overrideprivatevirtual

Execution code.

Executes the algorithm.

Reading in the file and creating and populating the output workspace

Implements Mantid::API::NexusFileLoader.

Definition at line 392 of file LoadEventNexus.cpp.

References compressTolerance, discarded_events, filterDuringPause(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::Logger::information(), loadEvents(), loadlogs, m_file, m_filename, m_ws, Mantid::Kernel::ProgressBase::report(), runLoadMonitors(), safeOpenFile(), Mantid::Kernel::IPropertyManager::setProperty(), and setTopEntryName().

◆ filterDuringPause() [1/2]

template<>

void Mantid::DataHandling::LoadEventNexus::filterDuringPause ( EventWorkspaceCollection_sptr workspace )

private

Definition at line 350 of file LoadEventNexus.cpp.

References workspace.

◆ filterDuringPause() [2/2]

template<typename T >

void Mantid::DataHandling::LoadEventNexus::filterDuringPause ( T workspace )

private

Definition at line 326 of file LoadEventNexus.cpp.

References Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::API::g_log, Mantid::Kernel::SingletonHolder< T >::Instance(), m_ws, Mantid::Kernel::Logger::notice(), and workspace.

Referenced by execLoader(), and runLoadMonitors().

◆ filterEventsByTime() [1/2]

template<>

EventWorkspaceCollection_sptr Mantid::DataHandling::LoadEventNexus::filterEventsByTime	(	EventWorkspaceCollection_sptr	workspace,
		Mantid::Types::Core::DateAndTime &	startTime,
		Mantid::Types::Core::DateAndTime &	stopTime
	)

private

Definition at line 377 of file LoadEventNexus.cpp.

References workspace.

◆ filterEventsByTime() [2/2]

template<typename T >

T Mantid::DataHandling::LoadEventNexus::filterEventsByTime	(	T	workspace,
		Mantid::Types::Core::DateAndTime &	startTime,
		Mantid::Types::Core::DateAndTime &	stopTime
	)

private

Filter the events by pulse time - no in place version so have to return workspace.

Definition at line 363 of file LoadEventNexus.cpp.

References Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::API::Algorithm::filterByTime(), Mantid::API::g_log, Mantid::Kernel::Logger::information(), and workspace.

◆ getParallelExecutionMode()

Parallel::ExecutionMode Mantid::DataHandling::LoadEventNexus::getParallelExecutionMode ( const std::map< std::string, Parallel::StorageMode > & storageModes ) const

overrideprotectedvirtual

Get correct execution mode based on input storage modes for an MPI run.

The default implementation returns ExecutionMode::Invalid. Classes inheriting from Algorithm can re-implement this if they support execution with multiple MPI ranks. May not return ExecutionMode::Serial, because that is not a "parallel" execution mode.

Reimplemented from Mantid::API::ParallelAlgorithm.

Definition at line 1657 of file LoadEventNexus.cpp.

◆ init()

void Mantid::DataHandling::LoadEventNexus::init ( )

overrideprivatevirtual

Intialisation code.

Initialisation method.

Implements Mantid::API::Algorithm.

Definition at line 109 of file LoadEventNexus.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_DBL(), Mantid::EMPTY_INT(), Mantid::Kernel::Direction::Input, Mantid::Kernel::IS_EQUAL_TO, Mantid::Kernel::IS_NOT_DEFAULT, Mantid::API::FileProperty::Load, Mantid::Kernel::Direction::Output, Mantid::Kernel::IPropertyManager::setPropertyGroup(), and Mantid::Kernel::IPropertyManager::setPropertySettings().

◆ loadEntryMetadata()

template<typename T >

void Mantid::DataHandling::LoadEventNexus::loadEntryMetadata	(	const std::string &	nexusfilename,
		T	WS,
		const std::string &	entry_name,
		const Kernel::NexusHDF5Descriptor &	descriptor
	)

static

Load the run number and other meta data from the given bank.

Definition at line 618 of file LoadEventNexus.h.

References Mantid::Kernel::NexusHDF5Descriptor::isEntry(), name(), std::to_string(), and value.

Referenced by Mantid::DataHandling::LoadTOFRawNexus::exec().

◆ loadEvents()

void Mantid::DataHandling::LoadEventNexus::loadEvents	(	API::Progress *const	prog,
		const bool	monitors
	)

private

Load events from the file.

Parameters

prog	:: A pointer to the progress reporting object
monitors	:: If true the events from the monitors are loaded and not the main banks

This also loads the instrument, but only if it has not been set in the workspace being used as input (m_ws data member). Same applies to the logs.

Definition at line 842 of file LoadEventNexus.cpp.

References Mantid::DataHandling::LoadHelper::addNexusFieldsToWsRun(), bad_tofs, Mantid::Kernel::DateAndTimeHelpers::createFromSanitizedISO8601(), createSpectraMapping(), Mantid::API::Progress::doReport(), Mantid::EMPTY_DBL(), Mantid::Kernel::Logger::error(), filter_time_start, filter_time_stop, Mantid::DataHandling::firstLastPulseTimes(), Mantid::API::g_log, Mantid::API::NexusFileLoader::getFileInfo(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::Logger::information(), Mantid::Kernel::SingletonHolder< T >::Instance(), loadInstrument(), loadlogs, loadSampleDataISIScompatibility(), m_allBanksPulseTimes, m_file, m_filename, m_instrument_loaded_correctly, m_top_entry_name, m_ws, Mantid::DataHandling::numEvents(), Mantid::Kernel::ProgressBase::report(), safeOpenFile(), setTimeFilters(), and tmp.

Referenced by execLoader().

◆ loadInstrument()

template<typename T >

bool Mantid::DataHandling::LoadEventNexus::loadInstrument	(	const std::string &	nexusfilename,
		T	localWorkspace,
		const std::string &	top_entry_name,
		Algorithm *	alg,
		const Kernel::NexusHDF5Descriptor *	descriptor = `nullptr`
	)

static

Load instrument from Nexus file if possible, else from IDF spacified by Nexus file.

Load the instrument from the nexus file if property LoadNexusInstrumentXML is set to true.

Parameters

nexusfilename	input nexus file name
localWorkspace	input
top_entry_name	e.g. /entry
alg	input algorithm executing this task
descriptor	input descriptor

Returns: true: success, false: failure

If instrument XML not found from the IDF file (specified by the info in the Nexus file) load the IDF.

Parameters

nexusfilename	:: The Nexus file name
localWorkspace	:: templated workspace in which to put the instrument geometry
top_entry_name	:: entry name at the top of the Nexus file
alg	:: Handle of the algorithm

Returns: true if successful

Definition at line 751 of file LoadEventNexus.h.

References Mantid::API::Algorithm::existsProperty(), and Mantid::API::Algorithm::getProperty().

Referenced by Mantid::DataHandling::LoadNexusMonitors2::exec(), and loadEvents().

◆ loadISISVMSSpectraMapping()

std::unique_ptr< std::pair< std::vector< int32_t >, std::vector< int32_t > > > Mantid::DataHandling::LoadEventNexus::loadISISVMSSpectraMapping ( const std::string & entry_name )

private

Load a spectra mapping from the given file.

This currently checks for the existence of an isis_vms_compat block in the file, if it exists it pulls out the spectra mapping listed there

Parameters

entry_name :: name of the NXentry to open.

Returns: True if the mapping was loaded or false if the block does not exist

Definition at line 1479 of file LoadEventNexus.cpp.

References Mantid::Kernel::Logger::debug(), event_id_is_spec, Mantid::API::g_log, and m_file.

Referenced by createSpectraMapping().

◆ loadSampleDataISIScompatibility()

void Mantid::DataHandling::LoadEventNexus::loadSampleDataISIScompatibility	(	::NeXus::File &	file,
		EventWorkspaceCollection &	WS
	)

static

Load information of the sample.

It is valid only for ISIS it get the information from the group isis_vms_compat.

If it does not find this group, it assumes that there is nothing to do. But, if the information is there, but not in the way it was expected, it will log the occurrence.

Note: : It does essentially the same thing of the method: LoadISISNexus2::loadSampleData

Parameters

file	: handle to the nexus file
WS	: pointer to the workspace

Definition at line 1577 of file LoadEventNexus.cpp.

References Mantid::DataHandling::EventWorkspaceCollection::setGeometryFlag(), Mantid::DataHandling::EventWorkspaceCollection::setHeight(), Mantid::DataHandling::EventWorkspaceCollection::setThickness(), and Mantid::DataHandling::EventWorkspaceCollection::setWidth().

Referenced by loadEvents().

◆ name()

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

inlineoverridevirtual

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

Implements Mantid::API::Algorithm.

Definition at line 81 of file LoadEventNexus.h.

Referenced by loadEntryMetadata().

◆ readInstrumentFromISIS_VMSCompat()

std::string Mantid::DataHandling::LoadEventNexus::readInstrumentFromISIS_VMSCompat ( ::NeXus::File & hFile )

static

method used to return instrument name for some old ISIS files where it is not written properly within the instrument

Parameters

hFile :: A reference to the NeXus file opened at the root entry

Definition at line 1254 of file LoadEventNexus.cpp.

Referenced by Mantid::DataHandling::LoadNexusMonitors2::exec(), and runLoadInstrument().

◆ runLoadIDFFromNexus() [1/2]

template<>

bool Mantid::DataHandling::LoadEventNexus::runLoadIDFFromNexus	(	const std::string &	nexusfilename,
		EventWorkspaceCollection_sptr	localWorkspace,
		const std::string &	top_entry_name,
		Algorithm *	alg
	)

static

Load the instrument from the nexus file.

Parameters

nexusfilename	:: The name of the nexus file being loaded
localWorkspace	:: EventWorkspaceCollection in which to put the instrument geometry
top_entry_name	:: entry name at the top of the Nexus file
alg	:: Handle of the algorithm

Returns: true if successful

Definition at line 1240 of file LoadEventNexus.cpp.

◆ runLoadIDFFromNexus() [2/2]

template<typename T >

bool Mantid::DataHandling::LoadEventNexus::runLoadIDFFromNexus	(	const std::string &	nexusfilename,
		T	localWorkspace,
		const std::string &	top_entry_name,
		Algorithm *	alg
	)

static

Load instrument for Nexus file.

Load the instrument from the nexus file.

Parameters

nexusfilename	:: The name of the nexus file being loaded
localWorkspace	:: templated workspace in which to put the instrument geometry
top_entry_name	:: entry name at the top of the Nexus file
alg	:: Handle of the algorithm

Returns: true if successful

Definition at line 778 of file LoadEventNexus.h.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::getLogger(), and Mantid::Kernel::Logger::information().

Referenced by Mantid::DataHandling::LoadISISNexus2::exec().

◆ runLoadInstrument() [1/2]

template<>

bool Mantid::DataHandling::LoadEventNexus::runLoadInstrument	(	const std::string &	nexusfilename,
		EventWorkspaceCollection_sptr	localWorkspace,
		const std::string &	top_entry_name,
		Algorithm *	alg,
		const Kernel::NexusHDF5Descriptor *	descriptor
	)

static

Load the instrument definition file specified by info in the NXS file for a EventWorkspaceCollection.

Parameters

nexusfilename	:: Used to pick the instrument.
localWorkspace	:: EventWorkspaceCollection in which to put the instrument geometry
top_entry_name	:: entry name at the top of the NXS file
alg	:: Handle of the algorithm
descriptor	:: input containing metadata information

Returns: true if successful

Definition at line 1289 of file LoadEventNexus.cpp.

◆ runLoadInstrument() [2/2]

template<typename T >

bool Mantid::DataHandling::LoadEventNexus::runLoadInstrument	(	const std::string &	nexusfilename,
		T	localWorkspace,
		const std::string &	top_entry_name,
		Algorithm *	alg,
		const Kernel::NexusHDF5Descriptor *	descriptor = `nullptr`
	)

static

Load instrument from IDF file specified by Nexus file.

Load the instrument definition file specified by info in the NXS file.

Parameters

nexusfilename	input nexus file name
localWorkspace	input
top_entry_name	e.g. /entry
alg	input algorithm executing this task
descriptor	input descriptor

Returns: true: success, false: failure

Parameters

nexusfilename	:: Used to pick the instrument.
localWorkspace	:: Templated workspace in which to put the instrument geometry
top_entry_name	:: entry name at the top of the NXS file
alg	:: Handle of the algorithm

Returns: true if successful

Definition at line 488 of file LoadEventNexus.h.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::Kernel::NexusHDF5Descriptor::getAllEntries(), Mantid::API::InstrumentFileFinder::getInstrumentFilename(), Mantid::API::Algorithm::getLogger(), Mantid::Kernel::Logger::information(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::DataHandling::LoadGeometry::isNexus(), n, readInstrumentFromISIS_VMSCompat(), and value.

Referenced by Mantid::DataHandling::LoadPreNexus::runLoadNexusLogs().

◆ runLoadMonitors()

void Mantid::DataHandling::LoadEventNexus::runLoadMonitors ( )

private

Load the Monitors from the NeXus file into a workspace.

The original workspace name is used and appended with _monitors.

Definition at line 1423 of file LoadEventNexus.cpp.

References Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::API::Algorithm::declareProperty(), filterDuringPause(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), m_filename, m_ws, Mantid::Kernel::Direction::Output, and Mantid::Kernel::IPropertyManager::setProperty().

Referenced by execLoader().

◆ runLoadNexusLogs() [1/4]

template<>

std::shared_ptr< BankPulseTimes > Mantid::DataHandling::LoadEventNexus::runLoadNexusLogs	(	const std::string &	nexusfilename,
		EventWorkspaceCollection_sptr	localWorkspace,
		API::Algorithm &	alg,
		bool	returnpulsetimes,
		int &	nPeriods,
		std::unique_ptr< const TimeSeriesProperty< int > > &	periodLog
	)

static

Load the instrument from the nexus file.

Parameters

nexusfilename	:: The name of the nexus file being loaded
localWorkspace	:: EventWorkspaceCollection in which to put the instrument geometry
alg	:: Handle of the algorithm
returnpulsetimes	:: flag to return shared pointer for BankPulseTimes, otherwise NULL.
nPeriods	: Number of periods (write to)
periodLog	: Period logs DateAndTime to int map.

Returns: Pulse times given in the DAS logs

Definition at line 747 of file LoadEventNexus.cpp.

◆ runLoadNexusLogs() [2/4]

template<>

std::shared_ptr< BankPulseTimes > Mantid::DataHandling::LoadEventNexus::runLoadNexusLogs	(	const std::string &	nexusfilename,
		EventWorkspaceCollection_sptr	localWorkspace,
		API::Algorithm &	alg,
		bool	returnpulsetimes,
		int &	nPeriods,
		std::unique_ptr< const TimeSeriesProperty< int > > &	periodLog,
		const std::vector< std::string > &	allow_list,
		const std::vector< std::string > &	block_list
	)

static

Load the instrument from the nexus file.

Parameters

nexusfilename	:: The name of the nexus file being loaded
localWorkspace	:: EventWorkspaceCollection in which to put the instrument geometry
alg	:: Handle of the algorithm
returnpulsetimes	:: flag to return shared pointer for BankPulseTimes, otherwise NULL.
nPeriods	: Number of periods (write to)
periodLog	: Period logs DateAndTime to int map.
allow_list	log entry that will be loaded
block_list	log entry that will be excluded

Returns: Pulse times given in the DAS logs

Definition at line 747 of file LoadEventNexus.cpp.

◆ runLoadNexusLogs() [3/4]

template<typename T >

std::shared_ptr< BankPulseTimes > Mantid::DataHandling::LoadEventNexus::runLoadNexusLogs	(	const std::string &	nexusfilename,
		T	localWorkspace,
		API::Algorithm &	alg,
		bool	returnpulsetimes,
		int &	nPeriods,
		std::unique_ptr< const Kernel::TimeSeriesProperty< int > > &	periodLog
	)

static

Load the log from the nexus file.

Parameters

nexusfilename	:: The name of the nexus file being loaded
localWorkspace	:: Templated workspace in which to put the instrument geometry
alg	:: Handle of the algorithm
returnpulsetimes	:: flag to return shared pointer for BankPulseTimes, otherwise NULL.
nPeriods	: Number of periods (write to)
periodLog	: Period logs DateAndTime to int map.

Returns: Pulse times given in the DAS logs

Attempt to make a gonoimeter from the logs

Definition at line 549 of file LoadEventNexus.cpp.

References checkForCorruptedPeriods(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::getLogger(), Mantid::API::LogManager::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::API::LogManager::getPropertyValueAsType(), Mantid::API::LogManager::hasProperty(), Mantid::Kernel::Logger::information(), Mantid::Geometry::Goniometer::makeUniversalGoniometer(), Mantid::Kernel::TimeSeriesProperty< TYPE >::timesAsVector(), Mantid::Kernel::Property::value(), and Mantid::Kernel::Logger::warning().

◆ runLoadNexusLogs() [4/4]

template<typename T >

std::shared_ptr< BankPulseTimes > Mantid::DataHandling::LoadEventNexus::runLoadNexusLogs	(	const std::string &	nexusfilename,
		T	localWorkspace,
		API::Algorithm &	alg,
		bool	returnpulsetimes,
		int &	nPeriods,
		std::unique_ptr< const Kernel::TimeSeriesProperty< int > > &	periodLog,
		const std::vector< std::string > &	allow_list,
		const std::vector< std::string > &	block_list
	)

static

Load the log from the nexus file.

Parameters

nexusfilename	:: The name of the nexus file being loaded
localWorkspace	:: Templated workspace in which to put the instrument geometry
alg	:: Handle of the algorithm
returnpulsetimes	:: flag to return shared pointer for BankPulseTimes, otherwise NULL.
nPeriods	: Number of periods (write to)
periodLog	: Period logs DateAndTime to int map.
allow_list	list of properties that will be loaded
block_list	list of properties that will be excluded from loading

Returns: Pulse times given in the DAS logs

Attempt to make a gonoimeter from the logs

Definition at line 649 of file LoadEventNexus.cpp.

References checkForCorruptedPeriods(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::getLogger(), Mantid::API::LogManager::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::API::LogManager::getPropertyValueAsType(), Mantid::API::LogManager::hasProperty(), Mantid::Kernel::Logger::information(), Mantid::Geometry::Goniometer::makeUniversalGoniometer(), Mantid::Kernel::TimeSeriesProperty< TYPE >::timesAsVector(), and Mantid::Kernel::Logger::warning().

◆ safeOpenFile()

void Mantid::DataHandling::LoadEventNexus::safeOpenFile ( const std::string & fname )

private

to open the nexus file with specific exception handling/message

Makes sure that m_file is a valid and open NeXus::File object.

Throws if there is an exception opening the file.

Parameters

fname name of the nexus file to open

Definition at line 1613 of file LoadEventNexus.cpp.

References m_file, and m_filename.

Referenced by execLoader(), and loadEvents().

◆ seeAlso()

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

◆ setTimeFilters()

void Mantid::DataHandling::LoadEventNexus::setTimeFilters ( const bool monitors )

private

Set the filters on TOF.

Parameters

monitors :: If true check the monitor properties else use the standard ones

Definition at line 1539 of file LoadEventNexus.cpp.

References Mantid::EMPTY_DBL(), filter_tof_max, filter_tof_min, and Mantid::API::Algorithm::getProperty().

Referenced by loadEvents().

◆ setTopEntryName()

void Mantid::DataHandling::LoadEventNexus::setTopEntryName ( )

private

Set the top entry field name.

set the name of the top level NXentry m_top_entry_name

Definition at line 297 of file LoadEventNexus.cpp.

References Mantid::Kernel::Logger::error(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), m_file, and m_top_entry_name.

Referenced by execLoader().

◆ summary()

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

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 84 of file LoadEventNexus.h.

◆ version()

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

inlineoverridevirtual

Version.

Implements Mantid::API::Algorithm.

Definition at line 91 of file LoadEventNexus.h.

Member Data Documentation

◆ bad_tofs

size_t Mantid::DataHandling::LoadEventNexus::bad_tofs

Count of all the "bad" tofs found.

These are events with TOF > 2e8 microsec

Definition at line 187 of file LoadEventNexus.h.

Referenced by loadEvents().

◆ compressTolerance

double Mantid::DataHandling::LoadEventNexus::compressTolerance

Tolerance for CompressEvents; use -1 to mean don't compress.

Definition at line 193 of file LoadEventNexus.h.

Referenced by execLoader().

◆ discarded_events

size_t Mantid::DataHandling::LoadEventNexus::discarded_events

A count of events discarded because they came from a pixel that's not in the IDF.

Definition at line 190 of file LoadEventNexus.h.

Referenced by execLoader().

◆ event_id_is_spec

bool Mantid::DataHandling::LoadEventNexus::event_id_is_spec

private

True if the event_id is spectrum no not pixel ID.

Definition at line 250 of file LoadEventNexus.h.

Referenced by loadISISVMSSpectraMapping().

◆ filter_time_start

Mantid::Types::Core::DateAndTime Mantid::DataHandling::LoadEventNexus::filter_time_start

Filter by start time.

Definition at line 174 of file LoadEventNexus.h.

Referenced by defineLoaderType(), and loadEvents().

◆ filter_time_stop

Mantid::Types::Core::DateAndTime Mantid::DataHandling::LoadEventNexus::filter_time_stop

Filter by stop time.

Definition at line 176 of file LoadEventNexus.h.

Referenced by defineLoaderType(), and loadEvents().

◆ filter_tof_max

double Mantid::DataHandling::LoadEventNexus::filter_tof_max

Filter by a maximum time-of-flight.

Definition at line 166 of file LoadEventNexus.h.

Referenced by defineLoaderType(), and setTimeFilters().

◆ filter_tof_min

double Mantid::DataHandling::LoadEventNexus::filter_tof_min

Filter by a minimum time-of-flight.

Definition at line 164 of file LoadEventNexus.h.

Referenced by defineLoaderType(), and setTimeFilters().

◆ loadlogs

bool Mantid::DataHandling::LoadEventNexus::loadlogs

private

Do we load the sample logs?

Definition at line 248 of file LoadEventNexus.h.

Referenced by execLoader(), and loadEvents().

◆ longest_tof

double Mantid::DataHandling::LoadEventNexus::longest_tof

Limits found to tof.

Definition at line 182 of file LoadEventNexus.h.

◆ m_allBanksPulseTimes

std::shared_ptr<BankPulseTimes> Mantid::DataHandling::LoadEventNexus::m_allBanksPulseTimes

Pulse times for ALL banks, taken from proton_charge log.

Definition at line 196 of file LoadEventNexus.h.

Referenced by loadEvents(), and Mantid::DataHandling::LoadBankFromDiskTask::loadPulseTimes().

◆ m_file

std::unique_ptr<::NeXus::File> Mantid::DataHandling::LoadEventNexus::m_file

Definition at line 200 of file LoadEventNexus.h.

Referenced by execLoader(), loadEvents(), loadISISVMSSpectraMapping(), safeOpenFile(), and setTopEntryName().

◆ m_filename

std::string Mantid::DataHandling::LoadEventNexus::m_filename

The name and path of the input file.

Definition at line 158 of file LoadEventNexus.h.

Referenced by execLoader(), loadEvents(), Mantid::DataHandling::LoadBankFromDiskTask::run(), runLoadMonitors(), and safeOpenFile().

◆ m_instrument_loaded_correctly

bool Mantid::DataHandling::LoadEventNexus::m_instrument_loaded_correctly

private

Was the instrument loaded?

Definition at line 245 of file LoadEventNexus.h.

Referenced by loadEvents().

◆ m_specMax

int32_t Mantid::DataHandling::LoadEventNexus::m_specMax

Maximum spectrum to load.

Definition at line 171 of file LoadEventNexus.h.

Referenced by createSpectraMapping(), and Mantid::DataHandling::LoadBankFromDiskTask::run().

◆ m_specMin

int32_t Mantid::DataHandling::LoadEventNexus::m_specMin

Minimum spectrum to load.

Definition at line 169 of file LoadEventNexus.h.

Referenced by createSpectraMapping(), and Mantid::DataHandling::LoadBankFromDiskTask::run().

◆ m_tofMutex

std::mutex Mantid::DataHandling::LoadEventNexus::m_tofMutex

Mutex protecting tof limits.

Definition at line 179 of file LoadEventNexus.h.

◆ m_top_entry_name

std::string Mantid::DataHandling::LoadEventNexus::m_top_entry_name

name of top level NXentry to use

Definition at line 199 of file LoadEventNexus.h.

Referenced by createSpectraMapping(), loadEvents(), Mantid::DataHandling::LoadBankFromDiskTask::run(), and setTopEntryName().

◆ m_ws

std::shared_ptr<EventWorkspaceCollection> Mantid::DataHandling::LoadEventNexus::m_ws

The workspace being filled out.

Definition at line 161 of file LoadEventNexus.h.

Referenced by createSpectraMapping(), defineLoaderType(), execLoader(), filterDuringPause(), loadEvents(), and runLoadMonitors().

◆ shortest_tof

double Mantid::DataHandling::LoadEventNexus::shortest_tof

Limits found to tof.

Definition at line 184 of file LoadEventNexus.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LoaderType

Constructor & Destructor Documentation

◆ LoadEventNexus()

Member Function Documentation

◆ category()

◆ checkForCorruptedPeriods()

◆ confidence()

◆ createEmptyEventWorkspace()

◆ createSpectraMapping()

◆ defineLoaderType()

◆ deleteBanks()

◆ execLoader()

◆ filterDuringPause() [1/2]

◆ filterDuringPause() [2/2]

◆ filterEventsByTime() [1/2]

◆ filterEventsByTime() [2/2]

◆ getParallelExecutionMode()

◆ init()

◆ loadEntryMetadata()

◆ loadEvents()

◆ loadInstrument()

◆ loadISISVMSSpectraMapping()

◆ loadSampleDataISIScompatibility()

◆ name()

◆ readInstrumentFromISIS_VMSCompat()

◆ runLoadIDFFromNexus() [1/2]

◆ runLoadIDFFromNexus() [2/2]

◆ runLoadInstrument() [1/2]

◆ runLoadInstrument() [2/2]

◆ runLoadMonitors()

◆ runLoadNexusLogs() [1/4]

◆ runLoadNexusLogs() [2/4]

◆ runLoadNexusLogs() [3/4]

◆ runLoadNexusLogs() [4/4]

◆ safeOpenFile()

◆ seeAlso()

◆ setTimeFilters()

◆ setTopEntryName()

◆ summary()

◆ version()

Member Data Documentation

◆ bad_tofs

◆ compressTolerance

◆ discarded_events

◆ event_id_is_spec

◆ filter_time_start

◆ filter_time_stop

◆ filter_tof_max

◆ filter_tof_min

◆ loadlogs

◆ longest_tof

◆ m_allBanksPulseTimes

◆ m_file

◆ m_filename

◆ m_instrument_loaded_correctly

◆ m_specMax

◆ m_specMin

◆ m_tofMutex

◆ m_top_entry_name

◆ m_ws

◆ shortest_tof