Mantid::NeXus Namespace Reference

Namespaces
namespace	NeXusIOHelper

Classes
class	NexusFileIO
	Utility method for saving NeXus format of Mantid Workspace This class interfaces to the C Nexus API. More...
class	NXAttributes
	Nexus attributes. More...
class	NXBinary
	Implements NXnote Nexus class with binary data. More...
class	NXClass
	The base class for a Nexus class (group). More...
struct	NXClassInfo
	Information about a Nexus class. More...
class	NXData
	Implements NXdata Nexus class. More...
class	NXDataSet
	Abstract base class for a Nexus data set. More...
class	NXDataSetTyped
	Templated class implementation of NXDataSet. More...
class	NXDetector
	Implements NXdetector Nexus class. More...
class	NXDiskChopper
	Implements NXdisk_chopper Nexus class. More...
class	NXEntry
	Implements NXentry Nexus class. More...
struct	NXInfo
	C++ implementation of NeXus classes. More...
class	NXInstrument
	Implements NXinstrument Nexus class. More...
class	NXLog
	Implements NXlog Nexus class. More...
class	NXMainClass
	Main class is the one that can contain auxiliary classes. More...
class	NXNote
	Implements NXnote Nexus class. More...
class	NXObject
	The base abstract class for NeXus classes and data sets. More...
class	NXRoot
	Implements NXroot Nexus class. More...

Typedefs
template<typename T >
using	container_T = std::conditional_t< std::is_same< T, bool >{}, boost::container::vector< bool >, std::vector< T > >
using	NexusFileIO_sptr = std::shared_ptr< NexusFileIO >
	Helper typedef for a shared pointer of a NexusFileIO. More...
using	NXChar = NXDataSetTyped< char >
	The char dataset type. More...
using	NXDouble = NXDataSetTyped< double >
	The double dataset type. More...
using	NXFloat = NXDataSetTyped< float >
	The float dataset type. More...
using	NXInt = NXDataSetTyped< int >
	The integer dataset type. More...
using	NXSize = NXDataSetTyped< std::size_t >
	The size_t dataset type. More...
using	NXUInt = NXDataSetTyped< unsigned int >
	The size_t dataset type. More...

Functions
MANTID_NEXUS_DLL int	getNexusEntryTypes (const std::string &fileName, std::vector< std::string > &entryName, std::vector< std::string > &definition)
	Get all the Nexus entry types for a file. More...

Variables
const int	g_processed_blocksize = 8
	LoadNexusProcessed and SaveNexusProcessed need to share some attributes, put them at namespace level here. More...

Typedef Documentation

container_T

template<typename T >

using Mantid::NeXus::container_T = typedef std::conditional_t<std::is_same<T, bool>{}, boost::container::vector<bool>, std::vector<T> >

Definition at line 198 of file NexusClasses.h.

NexusFileIO_sptr

using Mantid::NeXus::NexusFileIO_sptr = typedef std::shared_ptr<NexusFileIO>

Helper typedef for a shared pointer of a NexusFileIO.

Definition at line 370 of file NexusFileIO.h.

NXChar

using Mantid::NeXus::NXChar = typedef NXDataSetTyped<char>

The char dataset type.

Definition at line 469 of file NexusClasses.h.

NXDouble

using Mantid::NeXus::NXDouble = typedef NXDataSetTyped<double>

The double dataset type.

Definition at line 467 of file NexusClasses.h.

NXFloat

using Mantid::NeXus::NXFloat = typedef NXDataSetTyped<float>

The float dataset type.

Definition at line 465 of file NexusClasses.h.

NXInt

using Mantid::NeXus::NXInt = typedef NXDataSetTyped<int>

The integer dataset type.

Definition at line 463 of file NexusClasses.h.

NXSize

using Mantid::NeXus::NXSize = typedef NXDataSetTyped<std::size_t>

The size_t dataset type.

Definition at line 471 of file NexusClasses.h.

NXUInt

using Mantid::NeXus::NXUInt = typedef NXDataSetTyped<unsigned int>

The size_t dataset type.

Definition at line 473 of file NexusClasses.h.

Function Documentation

getNexusEntryTypes()

int Mantid::NeXus::getNexusEntryTypes	(	const std::string &	fileName,
		std::vector< std::string > &	entryName,
		std::vector< std::string > &	definition
	)

Get all the Nexus entry types for a file.

Try to open named Nexus file and return all entries plus the definition found for each. If definition not found, try and return "analysis" field (Muon V1 files) Closes file on exit.

Parameters

fileName	:: file to open
entryName	:: vector that gets filled with strings with entry names
definition	:: vector that gets filled with the "definition" or "analysis" string.

Returns

count of entries if OK, -1 failed to open file.

Definition at line 1163 of file NexusFileIO.cpp.

References value.

Referenced by Mantid::DataHandling::LoadNexus::exec(), Mantid::WorkflowAlgorithms::SANSSensitivityCorrection::fileCheck(), and Mantid::DataHandling::whichNexusType().

Variable Documentation

g_processed_blocksize

const int Mantid::NeXus::g_processed_blocksize = 8

LoadNexusProcessed and SaveNexusProcessed need to share some attributes, put them at namespace level here.

Default block size for reading and writing processed files

Definition at line 69 of file NexusClasses.h.