Load a .nxs file into a MDEventWorkspace. More...

#include <LoadMD.h>

Inheritance diagram for Mantid::MDAlgorithms::LoadMD:

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

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

	LoadMD ()
	Constructor.

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

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

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

int	version () const override
	Algorithm's version for identification.

Public Member Functions inherited from Mantid::API::NexusFileLoader
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.

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

virtual const std::shared_ptr< Mantid::Nexus::NexusDescriptor >	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).

virtual std::string	getFilenamePropertyName () const

virtual void	setFileInfo (std::shared_ptr< Mantid::Nexus::NexusDescriptor > fileInfo)

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

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

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor.

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

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

void	addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)

void	executeAsChildAlg () override
	Execute as a Child Algorithm.

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

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

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

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

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

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

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

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

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

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

bool	isRecordingHistoryForChild ()

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

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

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

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

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

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

void	cancel () override
	Raises the cancel flag.

bool	getCancel () const
	Returns the cancellation state.

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

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

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

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

int	getLoggingOffset () const override
	returns the logging priority offset

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

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

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

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

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

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

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

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

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

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

virtual bool	processGroups ()
	Process WorkspaceGroup inputs.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	clear () override
	Clears all properties under management.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const std::string	workspaceMethodName () const override

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

const std::string	workspaceMethodInputProperty () const override

AlgorithmID	getAlgorithmID () const override
	Algorithm ID.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual	~IPropertyManager ()=default

Private Member Functions
void	checkForRequiredLegacyFixup (const API::IMDWorkspace_sptr &ws)
	Checks if a worspace is a certain type of legacy file.

template<typename MDE , size_t nd>
void	doLoad (typename DataObjects::MDEventWorkspace< MDE, nd >::sptr ws)
	Helper method.

void	execLoader () override
	Run the algorithm.

void	init () override
	Initialise the properties.

void	loadAffineMatricies (const API::IMDWorkspace_sptr &ws)
	Load all the affine matricies.

API::CoordTransform *	loadAffineMatrix (const std::string &entry_name)
	Load a given affine matrix.

void	loadCoordinateSystem ()
	Load the coordinate system.

void	loadDimensions ()
	Load all the dimensions into this->m_dims.

void	loadDimensions2 ()
	Load all the dimensions into this->m_dims The dimensions are stored as an nxData array.

void	loadExperimentInfos (std::shared_ptr< Mantid::API::MultipleExperimentInfos > ws)

void	loadHisto ()
	Perform loading for a MDHistoWorkspace.

void	loadQConvention ()
	Load the convention for Q

template<typename NumT >
void	loadSlab (const std::string &name, NumT *data, const DataObjects::MDHistoWorkspace_sptr &ws, NXnumtype dataType)
	Load a slab of double data into a bare array.

void	loadVisualNormalization (const std::string &key, std::optional< Mantid::API::MDNormalization > &normalization)

std::vector< double >	qDimensions (const API::IMDWorkspace_sptr &ws)
	Negative scaling for Q dimensions.

void	setMDFrameOnWorkspaceFromLegacyFile (const API::IMDWorkspace_sptr &ws)
	Sets MDFrames for workspaces from legacy files.

Private Attributes
std::string	convention

bool	m_BoxStructureAndMethadata
	load only the box structure with empty boxes but do not tload boxes events

Kernel::SpecialCoordinateSystem	m_coordSystem
	Coordinate system.

std::vector< Mantid::Geometry::IMDDimension_sptr >	m_dims
	Each dimension object loaded.

boost::scoped_ptr< Nexus::File >	m_file
	Open file handle.

std::string	m_filename
	Name of that file.

size_t	m_numDims
	Number of dimensions in loaded file.

std::string	m_QConvention
	QConvention.

bool	m_requiresMDFrameCorrection
	MDFrame correction flag.

int	m_saveMDVersion
	Version of SaveMD used to save the file.

std::optional< Mantid::API::MDNormalization >	m_visualNormalization
	Visual normalization.

std::optional< Mantid::API::MDNormalization >	m_visualNormalizationHisto

Static Private Attributes
static const std::string	VISUAL_NORMALIZATION_KEY = "visual_normalization"
	Named entry.

static const std::string	VISUAL_NORMALIZATION_KEY_HISTO = "visual_normalization_histo"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Kernel::Logger	m_log
	Logger for this algorithm.

Kernel::Logger &	g_log

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

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

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

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

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

Detailed Description

Load a .nxs file into a MDEventWorkspace.

Author: Janik Zikovsky

Date: 2011-07-12

Definition at line 28 of file LoadMD.h.

Constructor & Destructor Documentation

◆ LoadMD()

Mantid::MDAlgorithms::LoadMD::LoadMD ( )

Constructor.

Definition at line 52 of file LoadMD.cpp.

Member Function Documentation

◆ category()

const std::string Mantid::MDAlgorithms::LoadMD::category ( ) const

inlineoverridevirtual

Algorithm's category for identification.

Reimplemented from Mantid::API::Algorithm.

Definition at line 41 of file LoadMD.h.

◆ checkForRequiredLegacyFixup()

void Mantid::MDAlgorithms::LoadMD::checkForRequiredLegacyFixup ( const API::IMDWorkspace_sptr & ws )

private

Checks if a worspace is a certain type of legacy file.

Check for required legacy fix up for certain file types.

Namely the case where all MDFrames were stored as MDFrames

Definition at line 714 of file LoadMD.cpp.

References index, m_coordSystem, m_requiresMDFrameCorrection, Mantid::Kernel::None, and Mantid::Geometry::UnknownFrame::UnknownFrameName.

Referenced by execLoader(), and loadHisto().

◆ confidence()

int Mantid::MDAlgorithms::LoadMD::confidence ( Nexus::NexusDescriptor & descriptor ) const

overridevirtual

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

Return the confidence with which 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 63 of file LoadMD.cpp.

References confidence(), Mantid::Nexus::NexusDescriptor::getAllEntries(), and Mantid::Nexus::NexusDescriptor::isEntry().

Referenced by confidence().

◆ doLoad()

template<typename MDE , size_t nd>

void Mantid::MDAlgorithms::LoadMD::doLoad ( typename DataObjects::MDEventWorkspace< MDE, nd >::sptr ws )

private

Helper method.

Do the loading.

The m_file should be open at the entry level at this point.

Parameters

ws	:: MDEventWorkspace of the given type

Definition at line 462 of file LoadMD.cpp.

Referenced by execLoader().

◆ execLoader()

void Mantid::MDAlgorithms::LoadMD::execLoader ( )

overrideprivatevirtual

Run the algorithm.

Execute the algorithm.

Implements Mantid::API::NexusFileLoader.

Definition at line 111 of file LoadMD.cpp.

References CALL_MDEVENT_FUNCTION, checkForRequiredLegacyFixup(), convention, Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::DataObjects::MDEventFactory::CreateMDWorkspace(), doLoad(), Mantid::API::g_log, Mantid::API::NexusFileLoader::getFileInfo(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::Logger::information(), loadCoordinateSystem(), loadDimensions(), loadDimensions2(), Mantid::DataObjects::MDBoxFlatTree::loadExperimentInfos(), loadHisto(), loadQConvention(), loadVisualNormalization(), m_BoxStructureAndMethadata, m_file, m_filename, m_numDims, m_QConvention, m_requiresMDFrameCorrection, m_saveMDVersion, m_visualNormalization, m_visualNormalizationHisto, qDimensions(), RDWR, READ, setMDFrameOnWorkspaceFromLegacyFile(), Mantid::Kernel::IPropertyManager::setProperty(), tmp, VISUAL_NORMALIZATION_KEY, and VISUAL_NORMALIZATION_KEY_HISTO.

◆ init()

void Mantid::MDAlgorithms::LoadMD::init ( )

overrideprivatevirtual

Initialise the properties.

Initialize the algorithm's properties.

Implements Mantid::API::Algorithm.

Definition at line 80 of file LoadMD.cpp.

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

◆ loadAffineMatricies()

void Mantid::MDAlgorithms::LoadMD::loadAffineMatricies ( const API::IMDWorkspace_sptr & ws )

private

Load all the affine matricies.

Load all of the affine matrices from the file, create the appropriate coordinate transform and set those on the workspace.

Parameters

ws	: workspace to set the coordinate transforms on

Definition at line 591 of file LoadMD.cpp.

References loadAffineMatrix(), and m_file.

Referenced by doLoad(), and loadHisto().

◆ loadAffineMatrix()

CoordTransform * Mantid::MDAlgorithms::LoadMD::loadAffineMatrix ( const std::string & entry_name )

private

Load a given affine matrix.

Do that actual loading and manipulating of the read data to create the affine matrix and then the appropriate transformation.

This is currently limited to CoordTransformAffine transforms.

Parameters

entry_name : the entry point in the NeXus file to read

Returns: the coordinate transform object

Definition at line 612 of file LoadMD.cpp.

References Mantid::API::g_log, Mantid::Kernel::Logger::information(), m_file, and vec.

Referenced by loadAffineMatricies().

◆ loadCoordinateSystem()

void Mantid::MDAlgorithms::LoadMD::loadCoordinateSystem ( )

private

Load the coordinate system.

Definition at line 423 of file LoadMD.cpp.

References m_coordSystem, and m_file.

Referenced by execLoader().

◆ loadDimensions()

void Mantid::MDAlgorithms::LoadMD::loadDimensions ( )

private

Load all the dimensions into this->m_dims.

Definition at line 350 of file LoadMD.cpp.

References Mantid::Geometry::createDimension(), Mantid::Geometry::d, m_dims, m_file, m_numDims, and m_requiresMDFrameCorrection.

Referenced by execLoader().

◆ loadDimensions2()

void Mantid::MDAlgorithms::LoadMD::loadDimensions2 ( )

private

Load all the dimensions into this->m_dims The dimensions are stored as an nxData array.

Definition at line 370 of file LoadMD.cpp.

References Mantid::Geometry::d, m_dims, m_file, m_numDims, m_requiresMDFrameCorrection, Mantid::Geometry::makeMDFrameFactoryChain(), and Mantid::Geometry::UnknownFrame::UnknownFrameName.

Referenced by execLoader().

◆ loadExperimentInfos()

void Mantid::MDAlgorithms::LoadMD::loadExperimentInfos ( std::shared_ptr< Mantid::API::MultipleExperimentInfos > ws )

private

◆ loadHisto()

void Mantid::MDAlgorithms::LoadMD::loadHisto ( )

private

Perform loading for a MDHistoWorkspace.

The entry should be open already.

Definition at line 285 of file LoadMD.cpp.

References checkForRequiredLegacyFixup(), Mantid::API::NexusFileLoader::createChildAlgorithm(), NXnumtype::FLOAT64, Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), NXnumtype::INT8, loadAffineMatricies(), Mantid::DataObjects::MDBoxFlatTree::loadExperimentInfos(), loadSlab(), m_coordSystem, m_dims, m_file, m_filename, m_numDims, m_QConvention, m_requiresMDFrameCorrection, m_saveMDVersion, m_visualNormalization, qDimensions(), setMDFrameOnWorkspaceFromLegacyFile(), Mantid::Kernel::IPropertyManager::setProperty(), and tmp.

Referenced by execLoader().

◆ loadQConvention()

void Mantid::MDAlgorithms::LoadMD::loadQConvention ( )

private

Load the convention for Q

Definition at line 447 of file LoadMD.cpp.

References m_file, and m_QConvention.

Referenced by execLoader().

◆ loadSlab()

template<typename NumT >

void Mantid::MDAlgorithms::LoadMD::loadSlab	(	const std::string &	name,
		NumT *	data,
		const DataObjects::MDHistoWorkspace_sptr &	ws,
		NXnumtype	dataType
	)

private

Load a slab of double data into a bare array.

Checks that the size is correct.

Parameters

name
data	bare pointer to double array
ws
dataType

Definition at line 254 of file LoadMD.cpp.

References Mantid::Geometry::d, Mantid::Kernel::Logger::debug(), Mantid::API::g_log, m_file, and name().

Referenced by loadHisto().

◆ loadVisualNormalization()

void Mantid::MDAlgorithms::LoadMD::loadVisualNormalization	(	const std::string &	key,
		std::optional< Mantid::API::MDNormalization > &	normalization
	)

private

Definition at line 410 of file LoadMD.cpp.

References m_file.

Referenced by execLoader().

◆ name()

const std::string Mantid::MDAlgorithms::LoadMD::name ( ) const

inlineoverridevirtual

Algorithm's name for identification.

Implements Mantid::API::Algorithm.

Definition at line 33 of file LoadMD.h.

Referenced by loadSlab().

◆ qDimensions()

std::vector< double > Mantid::MDAlgorithms::LoadMD::qDimensions ( const API::IMDWorkspace_sptr & ws )

private

Negative scaling for Q dimensions.

Find scaling for Q dimensions.

Definition at line 739 of file LoadMD.cpp.

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

Referenced by execLoader(), and loadHisto().

◆ seeAlso()

const std::vector< std::string > Mantid::MDAlgorithms::LoadMD::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 39 of file LoadMD.h.

◆ setMDFrameOnWorkspaceFromLegacyFile()

void Mantid::MDAlgorithms::LoadMD::setMDFrameOnWorkspaceFromLegacyFile ( const API::IMDWorkspace_sptr & ws )

private

Sets MDFrames for workspaces from legacy files.

Set MDFrames for workspaces from legacy files.

Parameters

ws,:	poitner to the workspace which needs to be corrected

Definition at line 642 of file LoadMD.cpp.

References Mantid::API::NexusFileLoader::createChildAlgorithm(), Mantid::API::g_log, Mantid::Geometry::GeneralFrame::GeneralFrameName, Mantid::Kernel::HKL, Mantid::Geometry::HKL::HKLName, index, Mantid::Kernel::Logger::information(), m_coordSystem, Mantid::Kernel::QLab, Mantid::Geometry::QLab::QLabName, Mantid::Kernel::QSample, Mantid::Geometry::QSample::QSampleName, and Mantid::Kernel::Logger::warning().

Referenced by execLoader(), and loadHisto().

◆ summary()

const std::string Mantid::MDAlgorithms::LoadMD::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 35 of file LoadMD.h.

◆ version()

int Mantid::MDAlgorithms::LoadMD::version ( ) const

inlineoverridevirtual

Algorithm's version for identification.

Implements Mantid::API::Algorithm.

Definition at line 38 of file LoadMD.h.

Member Data Documentation

◆ convention

std::string Mantid::MDAlgorithms::LoadMD::convention

private

Definition at line 53 of file LoadMD.h.

Referenced by execLoader().

◆ m_BoxStructureAndMethadata

bool Mantid::MDAlgorithms::LoadMD::m_BoxStructureAndMethadata

private

load only the box structure with empty boxes but do not tload boxes events

Definition at line 104 of file LoadMD.h.

Referenced by doLoad(), and execLoader().

◆ m_coordSystem

Kernel::SpecialCoordinateSystem Mantid::MDAlgorithms::LoadMD::m_coordSystem

private

Coordinate system.

Definition at line 100 of file LoadMD.h.

Referenced by checkForRequiredLegacyFixup(), doLoad(), loadCoordinateSystem(), loadHisto(), and setMDFrameOnWorkspaceFromLegacyFile().

◆ m_dims

std::vector<Mantid::Geometry::IMDDimension_sptr> Mantid::MDAlgorithms::LoadMD::m_dims

private

Each dimension object loaded.

Definition at line 98 of file LoadMD.h.

Referenced by doLoad(), loadDimensions(), loadDimensions2(), and loadHisto().

◆ m_file

boost::scoped_ptr<Nexus::File> Mantid::MDAlgorithms::LoadMD::m_file

private

Open file handle.

Definition at line 89 of file LoadMD.h.

Referenced by doLoad(), execLoader(), loadAffineMatricies(), loadAffineMatrix(), loadCoordinateSystem(), loadDimensions(), loadDimensions2(), loadHisto(), loadQConvention(), loadSlab(), and loadVisualNormalization().

◆ m_filename

std::string Mantid::MDAlgorithms::LoadMD::m_filename

private

Name of that file.

Definition at line 92 of file LoadMD.h.

Referenced by doLoad(), execLoader(), and loadHisto().

◆ m_numDims

size_t Mantid::MDAlgorithms::LoadMD::m_numDims

private

Number of dimensions in loaded file.

Definition at line 95 of file LoadMD.h.

Referenced by execLoader(), loadDimensions(), loadDimensions2(), loadHisto(), and qDimensions().

◆ m_QConvention

std::string Mantid::MDAlgorithms::LoadMD::m_QConvention

private

QConvention.

Definition at line 102 of file LoadMD.h.

Referenced by execLoader(), loadHisto(), and loadQConvention().

◆ m_requiresMDFrameCorrection

bool Mantid::MDAlgorithms::LoadMD::m_requiresMDFrameCorrection

private

MDFrame correction flag.

Definition at line 118 of file LoadMD.h.

Referenced by checkForRequiredLegacyFixup(), execLoader(), loadDimensions(), loadDimensions2(), and loadHisto().

◆ m_saveMDVersion

int Mantid::MDAlgorithms::LoadMD::m_saveMDVersion

private

Version of SaveMD used to save the file.

Definition at line 107 of file LoadMD.h.

Referenced by execLoader(), and loadHisto().

◆ m_visualNormalization

std::optional<Mantid::API::MDNormalization> Mantid::MDAlgorithms::LoadMD::m_visualNormalization

private

Visual normalization.

Definition at line 110 of file LoadMD.h.

Referenced by execLoader(), and loadHisto().

◆ m_visualNormalizationHisto

std::optional<Mantid::API::MDNormalization> Mantid::MDAlgorithms::LoadMD::m_visualNormalizationHisto

private

Definition at line 111 of file LoadMD.h.

Referenced by execLoader().

◆ VISUAL_NORMALIZATION_KEY

const std::string Mantid::MDAlgorithms::LoadMD::VISUAL_NORMALIZATION_KEY = "visual_normalization"

staticprivate

Named entry.

Definition at line 114 of file LoadMD.h.

Referenced by execLoader().

◆ VISUAL_NORMALIZATION_KEY_HISTO

const std::string Mantid::MDAlgorithms::LoadMD::VISUAL_NORMALIZATION_KEY_HISTO = "visual_normalization_histo"

staticprivate

Definition at line 115 of file LoadMD.h.

Referenced by execLoader().

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

Framework/MDAlgorithms/inc/MantidMDAlgorithms/LoadMD.h
Framework/MDAlgorithms/src/LoadMD.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LoadMD()

Member Function Documentation

◆ category()

◆ checkForRequiredLegacyFixup()

◆ confidence()

◆ doLoad()

◆ execLoader()

◆ init()

◆ loadAffineMatricies()

◆ loadAffineMatrix()

◆ loadCoordinateSystem()

◆ loadDimensions()

◆ loadDimensions2()

◆ loadExperimentInfos()

◆ loadHisto()

◆ loadQConvention()

◆ loadSlab()

◆ loadVisualNormalization()

◆ name()

◆ qDimensions()

◆ seeAlso()

◆ setMDFrameOnWorkspaceFromLegacyFile()

◆ summary()

◆ version()

Member Data Documentation

◆ convention

◆ m_BoxStructureAndMethadata

◆ m_coordSystem

◆ m_dims

◆ m_file

◆ m_filename

◆ m_numDims

◆ m_QConvention

◆ m_requiresMDFrameCorrection

◆ m_saveMDVersion

◆ m_visualNormalization

◆ m_visualNormalizationHisto

◆ VISUAL_NORMALIZATION_KEY

◆ VISUAL_NORMALIZATION_KEY_HISTO