Loads a file in a NeXus format and stores it in a 2D workspace. More...

#include <LoadISISNexus2.h>

Inheritance diagram for Mantid::DataHandling::LoadISISNexus2:

Classes
struct	SpectraBlock
	Spectra block descriptor. More...

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification overriding a virtual method. More...

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

	LoadISISNexus2 ()
	Default constructor. More...

const std::string	name () const override
	Algorithm's name for identification overriding a virtual method. 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
	Algorithm's version for identification overriding a virtual method. More...

Public Member Functions inherited from Mantid::API::IFileLoader< Kernel::NexusDescriptor >
virtual int	confidence (Kernel::NexusDescriptor &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...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
void	buildSpectraInd2SpectraNumMap (bool range_supplied, bool hasSpectraList, DataBlockComposite &dataBlockComposite)
	Build the list of spectra to load and include into spectra-detectors map. More...

bool	checkOptionalProperties (bool bseparateMonitors, bool bexcludeMonitor)
	Check the validity of the optional properties of the algorithm and identify if partial data should be loaded. More...

void	checkOverlappingSpectraRange ()
	Check if any of the spectra block ranges overlap. More...

void	createPeriodLogs (int64_t period, DataObjects::Workspace2D_sptr &local_workspace)
	Creates period log data in the workspace. More...

void	exec () override
	Overwrites Algorithm method. More...

bool	findSpectraDetRangeInFile (NeXus::NXEntry &entry, std::vector< specnum_t > &spectrum_index, int64_t ndets, int64_t n_vms_compat_spectra, std::map< specnum_t, std::string > &monitors, bool excludeMonitors, bool separateMonitors)
	Method takes input parameters which describe monitor loading and analyze them against spectra/monitor block information in the file. More...

void	init () override
	Overwrites Algorithm method. More...

bool	isMultipleTimeRegimeFile (const NeXus::NXEntry &entry) const
	Check if is the file is a multiple time regime file. More...

void	loadBlock (Mantid::NeXus::NXDataSetTyped< int > &data, int64_t blocksize, int64_t period, int64_t start, int64_t &hist, int64_t &spec_num, DataObjects::Workspace2D_sptr &local_workspace)
	Perform a call to nxgetslab, via the NexusClasses wrapped methods for a given block-size. More...

void	loadLogs (DataObjects::Workspace2D_sptr &ws)
	Load log data from the nexus file. More...

void	loadPeriodData (int64_t period, Mantid::NeXus::NXEntry &entry, DataObjects::Workspace2D_sptr &local_workspace, bool update_spectra2det_mapping=false)
	Load a given period into the workspace. More...

void	loadRunDetails (DataObjects::Workspace2D_sptr &local_workspace, Mantid::NeXus::NXEntry &entry)
	Load in details about the run. More...

void	loadSampleData (DataObjects::Workspace2D_sptr &, const Mantid::NeXus::NXEntry &entry)
	Load in details about the sample. More...

size_t	prepareSpectraBlocks (std::map< specnum_t, std::string > &monitors, DataBlockComposite &LoadBlock)
	Prepare a vector of SpectraBlock structures to simplify loading. More...

void	runLoadInstrument (DataObjects::Workspace2D_sptr &)
	Run LoadInstrument as a ChildAlgorithm. More...

void	validateMultiPeriodLogs (const Mantid::API::MatrixWorkspace_sptr &)
	Check for a set of synthetic logs associated with multi-period log data. More...

Static Private Member Functions
static double	dblSqrt (double in)
	Personal wrapper for sqrt to allow msvs to compile. More...

Private Attributes
DataBlockComposite	m_detBlockInfo

int64_t	m_entrynumber
	The number of the input entry. More...

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

bool	m_hasVMSBlock

bool	m_have_detector
	Is there a detector block. More...

std::string	m_instrument_name
	The instrument name from Nexus. More...

bool	m_load_selected_spectra
	if true, a spectra list or range of spectra is supplied More...

DataBlockComposite	m_loadBlockInfo

boost::scoped_ptr< ISISRunLogs >	m_logCreator
	A pointer to the ISISRunLogs creator. More...

DataBlockComposite	m_monBlockInfo

std::map< specnum_t, std::string >	m_monitors
	Monitors, map spectrum index to monitor group name. More...

boost::scoped_ptr< ::NeXus::File >	m_nexusFile

std::shared_ptr< API::Progress >	m_progress
	Progress reporting object. More...

std::string	m_samplename
	The sample name read from Nexus. More...

std::vector< specnum_t >	m_spec
	Spectra numbers. More...

API::SpectrumDetectorMapping	m_spec2det_map
	spectra Number to detector ID (multi)map More...

const specnum_t *	m_spec_end
	Pointer to one-past-the-end of spectrum number array (m_spec) More...

std::vector< SpectraBlock >	m_spectraBlocks
	List of disjoint data blocks to load. More...

std::shared_ptr< HistogramData::HistogramX >	m_tof_data
	Time channels. More...

std::map< int64_t, specnum_t >	m_wsInd2specNum_map
	map of workspace Index to spectra Number (spectraID) More...

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

Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr	fromString (const std::string &input)
	De-serialize an object from a string. More...

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

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

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

Protected Member Functions inherited from Mantid::API::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

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

Loads a file in a NeXus format and stores it in a 2D workspace.

LoadISISNexus2 is an algorithm and as such inherits from the Algorithm class, via DataHandlingCommand, and overrides the init() & exec() methods.

Required Properties:

Filename - The name of and path to the input NeXus file
OutputWorkspace - The name of the workspace in which to store the imported data (a multi-period file will store higher periods in workspaces called OutputWorkspace_PeriodNo)

Optional Properties: (note that these options are not available if reading a multi-period file)

SpectrumMin - The starting spectrum number
SpectrumMax - The final spectrum number (inclusive)
SpectrumList - An ArrayProperty of spectra to load

Author: Roman Tolchenov, Tessella plc

Definition at line 59 of file LoadISISNexus2.h.

Constructor & Destructor Documentation

◆ LoadISISNexus2()

Mantid::DataHandling::LoadISISNexus2::LoadISISNexus2 ( )

Default constructor.

Empty default constructor.

Definition at line 74 of file LoadISISNexus2.cpp.

Member Function Documentation

◆ buildSpectraInd2SpectraNumMap()

void Mantid::DataHandling::LoadISISNexus2::buildSpectraInd2SpectraNumMap	(	bool	range_supplied,
		bool	hasSpectraList,
		DataBlockComposite &	dataBlockComposite
	)

private

Build the list of spectra to load and include into spectra-detectors map.

The map should be built if the user either specified a range or if the user provided a list of spectrum numbers.

Parameters

range_supplied	if true specifies that the range of values provided below have to be processed rather then spectra list
hasSpectraList	did the user specify a spectrum list
dataBlockComposite	a data block composite specfiying the spectra intervals

Definition at line 607 of file LoadISISNexus2.cpp.

References Mantid::DataHandling::DataBlockComposite::getGenerator(), and m_wsInd2specNum_map.

Referenced by checkOptionalProperties(), and exec().

◆ category()

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

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Reimplemented from Mantid::API::Algorithm.

Definition at line 69 of file LoadISISNexus2.h.

◆ checkOptionalProperties()

bool Mantid::DataHandling::LoadISISNexus2::checkOptionalProperties	(	bool	bseparateMonitors,
		bool	bexcludeMonitor
	)

private

Check the validity of the optional properties of the algorithm and identify if partial data should be loaded.

Parameters

bseparateMonitors	flag indicating if the monitors are to be loaded separately
bexcludeMonitor	flag indicating if the monitors are to be excluded

Definition at line 419 of file LoadISISNexus2.cpp.

Referenced by exec().

◆ checkOverlappingSpectraRange()

void Mantid::DataHandling::LoadISISNexus2::checkOverlappingSpectraRange ( )

private

Check if any of the spectra block ranges overlap.

Check if any spectra block ranges overlap.

Iterate over the sorted list of spectra blocks and check if the last element of the preceeding block is less than the first element of the next block.

Definition at line 680 of file LoadISISNexus2.cpp.

References m_spectraBlocks.

Referenced by prepareSpectraBlocks().

◆ confidence()

int Mantid::DataHandling::LoadISISNexus2::confidence ( Kernel::NexusDescriptor & descriptor ) const

overridevirtual

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

Return the confidence criteria for 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< Kernel::NexusDescriptor >.

Definition at line 86 of file LoadISISNexus2.cpp.

References Mantid::Kernel::NexusDescriptor::pathOfTypeExists().

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

◆ createPeriodLogs()

void Mantid::DataHandling::LoadISISNexus2::createPeriodLogs	(	int64_t	period,
		DataObjects::Workspace2D_sptr &	local_workspace
	)

private

Creates period log data in the workspace.

Parameters

period	:: period number
local_workspace	:: workspace to add period log data to.

Definition at line 769 of file LoadISISNexus2.cpp.

References m_logCreator.

Referenced by exec().

◆ dblSqrt()

double Mantid::DataHandling::LoadISISNexus2::dblSqrt ( double in )

staticprivate

Personal wrapper for sqrt to allow msvs to compile.

Definition at line 913 of file LoadISISNexus2.cpp.

◆ exec()

void Mantid::DataHandling::LoadISISNexus2::exec ( )

overrideprivatevirtual

Overwrites Algorithm method.

Executes the algorithm.

Reading in the file and creating and populating the output workspace

Exceptions

Exception::FileError	If the Nexus file cannot be found/opened
std::invalid_argument	If the optional properties are set to invalid values

Implements Mantid::API::Algorithm.

Definition at line 143 of file LoadISISNexus2.cpp.

◆ findSpectraDetRangeInFile()

bool Mantid::DataHandling::LoadISISNexus2::findSpectraDetRangeInFile	(	NeXus::NXEntry &	entry,
		std::vector< specnum_t > &	spectrum_index,
		int64_t	ndets,
		int64_t	n_vms_compat_spectra,
		std::map< specnum_t, std::string > &	monitors,
		bool	excludeMonitors,
		bool	separateMonitors
	)

private

Method takes input parameters which describe monitor loading and analyze them against spectra/monitor block information in the file.

The result is the option if monitors can be loaded together with spectra or mast be treated separately and additional information on how to treat monitor spectra.

Parameters

entry	:: entry to the NeXus file, opened at root folder
spectrum_index	:: array of spectra indexes of the data present in the file
ndets	:: size of the spectrum index array
n_vms_compat_spectra	:: number of data entries containing common time bins (e.g. all spectra, or all spectra and monitors or some spectra (this is not fully supported)
monitors	:: map connecting monitor spectra ID against monitor group name in the file.
excludeMonitors	:: input property indicating if it is requested to exclude monitors from the target workspace
separateMonitors	:: input property indicating if it is requested to load monitors separately (and exclude them from target data workspace this way)

Returns: excludeMonitors :: indicator if monitors should or must be excluded from the main data workspace if they can not be loaded with the data (contain different number of time channels)

Definition at line 939 of file LoadISISNexus2.cpp.

References Mantid::DataHandling::DataBlockComposite::addDataBlock(), Mantid::NeXus::NXDataSet::dim0(), Mantid::NeXus::NXDataSet::dim2(), Mantid::API::g_log, Mantid::DataHandling::DataBlockComposite::getAllSpectrumNumbers(), Mantid::DataHandling::DataBlockComposite::getMaxSpectrumID(), Mantid::DataHandling::DataBlockComposite::getMinSpectrumID(), Mantid::DataHandling::DataBlockComposite::getNumberOfChannels(), Mantid::DataHandling::DataBlockComposite::getNumberOfPeriods(), Mantid::DataHandling::DataBlockComposite::getNumberOfSpectra(), isMultipleTimeRegimeFile(), m_detBlockInfo, m_loadBlockInfo, m_monBlockInfo, m_monitors, Mantid::NeXus::NXData::openIntData(), Mantid::NeXus::NXEntry::openNXData(), Mantid::NeXus::NXClass::openNXInt(), Mantid::DataHandling::populateDataBlockCompositeWithContainer(), Mantid::DataHandling::DataBlockComposite::removeSpectra(), and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ init()

void Mantid::DataHandling::LoadISISNexus2::init ( )

overrideprivatevirtual

Overwrites Algorithm method.

Initialization method.

Implements Mantid::API::Algorithm.

Definition at line 96 of file LoadISISNexus2.cpp.

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

◆ isMultipleTimeRegimeFile()

bool Mantid::DataHandling::LoadISISNexus2::isMultipleTimeRegimeFile ( const NeXus::NXEntry & entry ) const

private

Check if is the file is a multiple time regime file.

Determine if a file is a multiple time regime file.

Note that for a true multi-time regime file we need at least three time regime entries, since two time regimes are handled by vms_compat.

Parameters

entry a handle to the Nexus file

Returns: if the file has multiple time regimes or not

Definition at line 1053 of file LoadISISNexus2.cpp.

References Mantid::NeXus::NXClass::containsGroup(), and Mantid::NeXus::NXClass::openNXGroup().

Referenced by findSpectraDetRangeInFile().

◆ loadBlock()

void Mantid::DataHandling::LoadISISNexus2::loadBlock	(	Mantid::NeXus::NXDataSetTyped< int > &	data,
		int64_t	blocksize,
		int64_t	period,
		int64_t	start,
		int64_t &	hist,
		int64_t &	spec_num,
		DataObjects::Workspace2D_sptr &	local_workspace
	)

private

Perform a call to nxgetslab, via the NexusClasses wrapped methods for a given block-size.

Parameters

data	:: The NXDataSet object
blocksize	:: The block-size to use
period	:: The period number
start	:: The index within the file to start reading from (zero based)
hist	:: The workspace index to start reading into
spec_num	:: The spectrum number that matches the hist variable
local_workspace	:: The workspace to fill the data with

Definition at line 784 of file LoadISISNexus2.cpp.

References Mantid::API::SpectrumDetectorMapping::getDetectorIDsForSpectrumNo(), Mantid::DataHandling::DataBlockComposite::getNumberOfChannels(), Mantid::NeXus::NXDataSetTyped< T >::load(), m_detBlockInfo, m_load_selected_spectra, m_loadBlockInfo, m_progress, m_spec2det_map, m_tof_data, and m_wsInd2specNum_map.

Referenced by loadPeriodData().

◆ loadLogs()

void Mantid::DataHandling::LoadISISNexus2::loadLogs ( DataObjects::Workspace2D_sptr & ws )

private

Load log data from the nexus file.

Load logs from Nexus file.

Logs are expected to be in /raw_data_1/runlog group of the file. Call to this method must be done within /raw_data_1 group.

Parameters

ws	:: The workspace to load the logs to.

Definition at line 893 of file LoadISISNexus2.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), m_logCreator, and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ loadPeriodData()

void Mantid::DataHandling::LoadISISNexus2::loadPeriodData	(	int64_t	period,
		Mantid::NeXus::NXEntry &	entry,
		DataObjects::Workspace2D_sptr &	local_workspace,
		bool	update_spectra2det_mapping = `false`
	)

private

Load a given period into the workspace.

Parameters

period	:: The period number to load (starting from 1)
entry	:: The opened root entry node for accessing the monitor and data nodes
local_workspace	:: The workspace to place the data in
update_spectra2det_mapping	:: reset spectra-detector map to the one calculated earlier. (Warning! – this map has to be calculated correctly!)

Definition at line 701 of file LoadISISNexus2.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::NeXus::NXDataSet::dim0(), Mantid::API::g_log, Mantid::API::SpectrumDetectorMapping::getDetectorIDsForSpectrumNo(), Mantid::DataHandling::DataBlockComposite::getNumberOfChannels(), Mantid::API::Algorithm::getPropertyValue(), Mantid::NeXus::NXClass::getString(), Mantid::NeXus::NXDataSetTyped< T >::load(), loadBlock(), m_have_detector, m_monBlockInfo, m_progress, m_spec, m_spec2det_map, m_spec_end, m_spectraBlocks, m_wsInd2specNum_map, Mantid::NeXus::NXDataSet::open(), Mantid::NeXus::NXData::openIntData(), Mantid::NeXus::NXEntry::openNXData(), and Mantid::NeXus::NXClass::openNXFloat().

Referenced by exec().

◆ loadRunDetails()

void Mantid::DataHandling::LoadISISNexus2::loadRunDetails	(	DataObjects::Workspace2D_sptr &	local_workspace,
		Mantid::NeXus::NXEntry &	entry
	)

private

Load in details about the run.

Load data about the run.

Parameters

local_workspace	:: The workspace to load the run information in to
entry	:: The Nexus entry

Definition at line 861 of file LoadISISNexus2.cpp.

References Mantid::API::LogManager::addProperty(), Mantid::DataHandling::DataBlockComposite::getNumberOfChannels(), Mantid::DataHandling::DataBlockComposite::getNumberOfPeriods(), Mantid::DataHandling::DataBlockComposite::getNumberOfSpectra(), Mantid::DataHandling::LoadISISNexusHelper::loadRunDetails(), m_hasVMSBlock, and m_loadBlockInfo.

Referenced by exec().

◆ loadSampleData()

void Mantid::DataHandling::LoadISISNexus2::loadSampleData	(	DataObjects::Workspace2D_sptr &	local_workspace,
		const Mantid::NeXus::NXEntry &	entry
	)

private

Load in details about the sample.

Load data about the sample.

Parameters

local_workspace	:: The workspace to load the logs to.
entry	:: The Nexus entry

Definition at line 878 of file LoadISISNexus2.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, Mantid::DataHandling::LoadISISNexusHelper::loadSampleGeometry(), and m_hasVMSBlock.

Referenced by exec().

◆ name()

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

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 64 of file LoadISISNexus2.h.

◆ prepareSpectraBlocks()

size_t Mantid::DataHandling::LoadISISNexus2::prepareSpectraBlocks	(	std::map< specnum_t, std::string > &	monitors,
		DataBlockComposite &	LoadBlock
	)

private

Prepare a vector of SpectraBlock structures to simplify loading.

Analyze the spectra ranges and prepare a list contiguous blocks.

Each monitor must be in a separate block.

Returns: :: Number of spectra to load.

Definition at line 627 of file LoadISISNexus2.cpp.

References checkOverlappingSpectraRange(), Mantid::DataHandling::DataBlockComposite::getDataBlocks(), and m_spectraBlocks.

Referenced by exec().

◆ runLoadInstrument()

void Mantid::DataHandling::LoadISISNexus2::runLoadInstrument ( DataObjects::Workspace2D_sptr & localWorkspace )

private

Run LoadInstrument as a ChildAlgorithm.

Run the Child Algorithm LoadInstrument (or LoadInstrumentFromNexus)

Definition at line 811 of file LoadISISNexus2.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::g_log, Mantid::Kernel::Logger::information(), m_filename, m_instrument_name, and value.

Referenced by exec().

◆ seeAlso()

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

◆ summary()

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

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 71 of file LoadISISNexus2.h.

◆ validateMultiPeriodLogs()

void Mantid::DataHandling::LoadISISNexus2::validateMultiPeriodLogs ( const Mantid::API::MatrixWorkspace_sptr & ws )

private

Check for a set of synthetic logs associated with multi-period log data.

Raise warnings where necessary.

Definition at line 399 of file LoadISISNexus2.cpp.

References Mantid::API::g_log, Mantid::API::LogManager::hasProperty(), and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ version()

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

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 66 of file LoadISISNexus2.h.

Member Data Documentation

◆ m_detBlockInfo

DataBlockComposite Mantid::DataHandling::LoadISISNexus2::m_detBlockInfo

private

Definition at line 132 of file LoadISISNexus2.h.

Referenced by exec(), findSpectraDetRangeInFile(), and loadBlock().

◆ m_entrynumber

int64_t Mantid::DataHandling::LoadISISNexus2::m_entrynumber

private

The number of the input entry.

Definition at line 152 of file LoadISISNexus2.h.

Referenced by checkOptionalProperties(), and exec().

◆ m_filename

std::string Mantid::DataHandling::LoadISISNexus2::m_filename

private

The name and path of the input file.

Definition at line 125 of file LoadISISNexus2.h.

Referenced by exec(), and runLoadInstrument().

◆ m_hasVMSBlock

bool Mantid::DataHandling::LoadISISNexus2::m_hasVMSBlock

private

Definition at line 144 of file LoadISISNexus2.h.

Referenced by exec(), loadRunDetails(), and loadSampleData().

◆ m_have_detector

bool Mantid::DataHandling::LoadISISNexus2::m_have_detector

private

Is there a detector block.

Definition at line 142 of file LoadISISNexus2.h.

Referenced by exec(), and loadPeriodData().

◆ m_instrument_name

std::string Mantid::DataHandling::LoadISISNexus2::m_instrument_name

private

The instrument name from Nexus.

Definition at line 127 of file LoadISISNexus2.h.

Referenced by exec(), and runLoadInstrument().

◆ m_load_selected_spectra

bool Mantid::DataHandling::LoadISISNexus2::m_load_selected_spectra

private

if true, a spectra list or range of spectra is supplied

Definition at line 146 of file LoadISISNexus2.h.

Referenced by checkOptionalProperties(), exec(), and loadBlock().

◆ m_loadBlockInfo

DataBlockComposite Mantid::DataHandling::LoadISISNexus2::m_loadBlockInfo

private

Definition at line 140 of file LoadISISNexus2.h.

Referenced by checkOptionalProperties(), exec(), findSpectraDetRangeInFile(), loadBlock(), and loadRunDetails().

◆ m_logCreator

boost::scoped_ptr<ISISRunLogs> Mantid::DataHandling::LoadISISNexus2::m_logCreator

private

A pointer to the ISISRunLogs creator.

Definition at line 164 of file LoadISISNexus2.h.

Referenced by createPeriodLogs(), and loadLogs().

◆ m_monBlockInfo

DataBlockComposite Mantid::DataHandling::LoadISISNexus2::m_monBlockInfo

private

Definition at line 134 of file LoadISISNexus2.h.

Referenced by checkOptionalProperties(), exec(), findSpectraDetRangeInFile(), and loadPeriodData().

◆ m_monitors

std::map<specnum_t, std::string> Mantid::DataHandling::LoadISISNexus2::m_monitors

private

Monitors, map spectrum index to monitor group name.

Definition at line 162 of file LoadISISNexus2.h.

Referenced by exec(), and findSpectraDetRangeInFile().

◆ m_nexusFile

boost::scoped_ptr< ::NeXus::File> Mantid::DataHandling::LoadISISNexus2::m_nexusFile

private

Definition at line 171 of file LoadISISNexus2.h.

Referenced by exec().

◆ m_progress

std::shared_ptr<API::Progress> Mantid::DataHandling::LoadISISNexus2::m_progress

private

Progress reporting object.

Definition at line 166 of file LoadISISNexus2.h.

Referenced by exec(), loadBlock(), and loadPeriodData().

◆ m_samplename

std::string Mantid::DataHandling::LoadISISNexus2::m_samplename

private

The sample name read from Nexus.

Definition at line 129 of file LoadISISNexus2.h.

◆ m_spec

std::vector<specnum_t> Mantid::DataHandling::LoadISISNexus2::m_spec

private

Spectra numbers.

Definition at line 158 of file LoadISISNexus2.h.

Referenced by exec(), and loadPeriodData().

◆ m_spec2det_map

API::SpectrumDetectorMapping Mantid::DataHandling::LoadISISNexus2::m_spec2det_map

private

spectra Number to detector ID (multi)map

Definition at line 150 of file LoadISISNexus2.h.

Referenced by exec(), loadBlock(), and loadPeriodData().

◆ m_spec_end

const specnum_t* Mantid::DataHandling::LoadISISNexus2::m_spec_end

private

Pointer to one-past-the-end of spectrum number array (m_spec)

Definition at line 160 of file LoadISISNexus2.h.

Referenced by exec(), and loadPeriodData().

◆ m_spectraBlocks

std::vector<SpectraBlock> Mantid::DataHandling::LoadISISNexus2::m_spectraBlocks

private

List of disjoint data blocks to load.

Definition at line 154 of file LoadISISNexus2.h.

Referenced by checkOverlappingSpectraRange(), exec(), loadPeriodData(), and prepareSpectraBlocks().

◆ m_tof_data

std::shared_ptr<HistogramData::HistogramX> Mantid::DataHandling::LoadISISNexus2::m_tof_data

private

Time channels.

Definition at line 156 of file LoadISISNexus2.h.

Referenced by exec(), and loadBlock().

◆ m_wsInd2specNum_map

std::map<int64_t, specnum_t> Mantid::DataHandling::LoadISISNexus2::m_wsInd2specNum_map

private

map of workspace Index to spectra Number (spectraID)

Definition at line 148 of file LoadISISNexus2.h.

Referenced by buildSpectraInd2SpectraNumMap(), exec(), loadBlock(), and loadPeriodData().

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

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

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LoadISISNexus2()

Member Function Documentation

◆ buildSpectraInd2SpectraNumMap()

◆ category()

◆ checkOptionalProperties()

◆ checkOverlappingSpectraRange()

◆ confidence()

◆ createPeriodLogs()

◆ dblSqrt()

◆ exec()

◆ findSpectraDetRangeInFile()

◆ init()

◆ isMultipleTimeRegimeFile()

◆ loadBlock()

◆ loadLogs()

◆ loadPeriodData()

◆ loadRunDetails()

◆ loadSampleData()

◆ name()

◆ prepareSpectraBlocks()

◆ runLoadInstrument()

◆ seeAlso()

◆ summary()

◆ validateMultiPeriodLogs()

◆ version()

Member Data Documentation

◆ m_detBlockInfo

◆ m_entrynumber

◆ m_filename

◆ m_hasVMSBlock

◆ m_have_detector

◆ m_instrument_name

◆ m_load_selected_spectra

◆ m_loadBlockInfo

◆ m_logCreator

◆ m_monBlockInfo

◆ m_monitors

◆ m_nexusFile

◆ m_progress

◆ m_samplename

◆ m_spec

◆ m_spec2det_map

◆ m_spec_end

◆ m_spectraBlocks

◆ m_tof_data

◆ m_wsInd2specNum_map