Mantid::DataHandling::LoadISISNexusHelper Namespace Reference

Functions
std::tuple< NeXus::NXInt, NeXus::NXInt >	findDetectorIDsAndSpectrumNumber (const NeXus::NXEntry &entry, const bool hasVMSBlock)
	find detector ids and spectrum numbers More...
int64_t	findNumberOfSpectra (const NeXus::NXEntry &entry, const bool hasVMSBlock)
	find the number of spectra in the nexus file More...
void	loadRunDetails (API::Run &run, const NXEntry &entry, const bool hasVMSBlock)
	Load data about the run. More...
void	loadSampleGeometry (Sample &sample, const NXEntry &entry, const bool hasVMSBlock)
	Load geometrical data about the sample from the nexus entry into a workspace. More...
std::shared_ptr< HistogramData::HistogramX >	loadTimeData (const NXEntry &entry)
	Load the time data from nexus entry. More...

Function Documentation

findDetectorIDsAndSpectrumNumber()

std::tuple< NXInt, NXInt > Mantid::DataHandling::LoadISISNexusHelper::findDetectorIDsAndSpectrumNumber	(	const NXEntry &	entry,
		const bool	hasVMSBlock
	)

find detector ids and spectrum numbers

Find total number of spectra in the nexus file.

Parameters

entry	:: The Nexus entry
hasVMSBlock	:: Whether the current nexus entry has a vms_compat block

Returns

Returns a pair containing the Detector IDs corresponding Spectrum numbers

Definition at line 51 of file LoadISISNexusHelper.cpp.

References Mantid::NeXus::NXDataSetTyped< T >::load(), Mantid::NeXus::NXClass::openNXGroup(), and Mantid::NeXus::NXClass::openNXInt().

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

findNumberOfSpectra()

int64_t Mantid::DataHandling::LoadISISNexusHelper::findNumberOfSpectra	(	const NXEntry &	entry,
		const bool	hasVMSBlock
	)

find the number of spectra in the nexus file

Find total number of spectra in the nexus file.

Parameters

entry	:: The Nexus entry
hasVMSBlock	:: Whether the current nexus entry has a vms_compat block

Returns

Total number of spectra

Definition at line 26 of file LoadISISNexusHelper.cpp.

References Mantid::NeXus::NXDataSet::dim0(), Mantid::NeXus::NXDataSetTyped< T >::load(), Mantid::NeXus::NXClass::openNXGroup(), and Mantid::NeXus::NXClass::openNXInt().

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

loadRunDetails()

void Mantid::DataHandling::LoadISISNexusHelper::loadRunDetails	(	API::Run &	run,
		const NXEntry &	entry,
		const bool	hasVMSBlock
	)

Load data about the run.

Parameters

run	:: The run where the information will be stored
entry	:: The Nexus entry
hasVMSBlock	:: Whether the current nexus entry has a vms_compat

Definition at line 124 of file LoadISISNexusHelper.cpp.

References Mantid::API::LogManager::addProperty(), Mantid::NeXus::NXObject::attributes, Mantid::NeXus::NXClass::close(), Mantid::NeXus::NXClass::getFloat(), Mantid::NeXus::NXClass::getInt(), Mantid::NeXus::NXClass::getString(), Mantid::NeXus::NXDataSetTyped< T >::load(), Mantid::NeXus::NXClass::openNXChar(), Mantid::NeXus::NXClass::openNXFloat(), Mantid::NeXus::NXClass::openNXGroup(), Mantid::NeXus::NXClass::openNXInt(), Mantid::API::Run::setProtonCharge(), and std::to_string().

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

loadSampleGeometry()

void Mantid::DataHandling::LoadISISNexusHelper::loadSampleGeometry	(	Sample &	sample,
		const NXEntry &	entry,
		const bool	hasVMSBlock
	)

Load geometrical data about the sample from the nexus entry into a workspace.

Parameters

sample	:: The sample which the geometrical data will be saved into
entry	:: The Nexus entry
hasVMSBlock	:: Whether the current nexus entry has a vms_compat block

Definition at line 80 of file LoadISISNexusHelper.cpp.

References Mantid::NeXus::NXClass::getFloat(), Mantid::NeXus::NXClass::getString(), height, Mantid::NeXus::NXDataSetTyped< T >::load(), Mantid::NeXus::NXClass::openNXFloat(), Mantid::NeXus::NXClass::openNXGroup(), Mantid::NeXus::NXClass::openNXInt(), Mantid::API::Sample::setGeometryFlag(), Mantid::API::Sample::setHeight(), Mantid::API::Sample::setThickness(), and Mantid::API::Sample::setWidth().

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

loadTimeData()

std::shared_ptr< HistogramData::HistogramX > Mantid::DataHandling::LoadISISNexusHelper::loadTimeData

(

const NXEntry &

entry

)

Load the time data from nexus entry.

Parameters

entry

:: The Nexus entry

Returns

Returns a shared pointer to a HistogramX instance storing the time bins.

Definition at line 203 of file LoadISISNexusHelper.cpp.

References Mantid::NeXus::NXDataSet::dim0(), Mantid::NeXus::NXClass::openNXFloat(), and Mantid::NeXus::NXClass::openNXGroup().

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