Implements NXdetector Nexus class. More...

#include <NexusClasses.h>

Inheritance diagram for Mantid::Nexus::NXDetector:

Public Member Functions
std::string	NX_class () const override
	Nexus class id.

	NXDetector (const NXClass &parent, const std::string &name)
	Constructor.

NXFloat	openAzimuthalAngle ()
	Opens the dataset containing pixel azimuthal angles.

NXFloat	openDistance ()
	Opens the dataset containing pixel distances.

NXFloat	openPolarAngle ()
	Opens the dataset containing pixel polar angles.

Public Member Functions inherited from Mantid::Nexus::NXClass
void	close ()
	Close this class.

bool	containsDataSet (const std::string &query) const
	Returns whether an individual dataset is present.

bool	containsGroup (const std::string &query) const
	Returns whether an individual group (or group) is present.

std::vector< NXInfo > &	datasets () const
	Returns a list of all datasets in this NXClass.

NXInfo	getDataSetInfo (const std::string &name) const
	Returns NXInfo for a dataset.

double	getDouble (const std::string &name) const
	Returns a double.

float	getFloat (const std::string &name) const
	Returns a float.

int32_t	getInt (const std::string &name) const
	Returns a int.

std::string	getString (const std::string &name) const
	Returns a string.

std::vector< NXClassInfo > &	groups () const
	Returns a list of all classes (or groups) in this NXClass.

bool	isValid (const std::string &address) const
	Check if a address exists relative to the current class address.

	NXClass (NXClass const &parent, std::string const &name)
	Constructor.

void	open ()
	Opens this NXClass using File::openGroupAddress(). Can be slow (or is slow)

bool	openLocal (const std::string &nxclass="")
	Opens this NXClass using File::openGroup().

NXChar	openNXChar (const std::string &name) const
	Creates and opens a char dataset.

template<class NX >
NX	openNXClass (const std::string &name) const
	Templated method for creating derived NX classes.

template<class T >
NXDataSetTyped< T >	openNXDataSet (const std::string &name) const
	Templated method for creating datasets.

NXDouble	openNXDouble (const std::string &name) const
	Creates and opens a double dataset.

NXFloat	openNXFloat (const std::string &name) const
	Creates and opens a float dataset.

NXClass	openNXGroup (const std::string &name) const
	Creates and opens an arbitrary (non-standard) class (group).

NXInt	openNXInt (const std::string &name) const
	Creates and opens an integer dataset.

NXUInt64	openNXSize (const std::string &name) const
	Creates and opens a size_t dataset.

Public Member Functions inherited from Mantid::Nexus::NXObject
NexusAddress const &	address () const
	Returns the absolute address to the object.

std::string	name () const
	Returns the name of the object.

	NXObject (File fileID, NXClass const parent, std::string const &name)
	NXObject constructor.

	NXObject (std::shared_ptr< File > const &fileID, NXClass const *parent, std::string const &name)
	NXObject constructor.

virtual	~NXObject ()=default

Additional Inherited Members
Public Attributes inherited from Mantid::Nexus::NXObject
std::shared_ptr< File >	m_fileID
	Nexus file id.

Protected Member Functions inherited from Mantid::Nexus::NXClass
void	clear ()
	Deletes content of m_groups and m_datasets.

void	readAllInfo ()
	Fills in m_groups and m_datasets.

Protected Attributes inherited from Mantid::Nexus::NXClass
std::shared_ptr< std::vector< NXInfo > >	m_datasets
	Holds info about the datasets in this NXClass.

std::shared_ptr< std::vector< NXClassInfo > >	m_groups
	Holds info about the child NXClasses.

Protected Attributes inherited from Mantid::Nexus::NXObject
NexusAddress	m_address
	Keeps the absolute address to the object.

bool	m_open
	Set to true if the object has been open.

Detailed Description

Implements NXdetector Nexus class.

Definition at line 630 of file NexusClasses.h.

Constructor & Destructor Documentation

◆ NXDetector()

Mantid::Nexus::NXDetector::NXDetector	(	const NXClass &	parent,
		const std::string &	name
	)

inline

Constructor.

Parameters

parent	:: The parent Nexus class. In terms of HDF it is the group containing the NXClass.
name	:: The name of the NXClass relative to its parent

Definition at line 637 of file NexusClasses.h.

Member Function Documentation

◆ NX_class()

std::string Mantid::Nexus::NXDetector::NX_class ( ) const

inlineoverridevirtual

Nexus class id.

Reimplemented from Mantid::Nexus::NXClass.

Definition at line 639 of file NexusClasses.h.

◆ openAzimuthalAngle()

NXFloat Mantid::Nexus::NXDetector::openAzimuthalAngle ( )

inline

Opens the dataset containing pixel azimuthal angles.

Definition at line 643 of file NexusClasses.h.

◆ openDistance()

NXFloat Mantid::Nexus::NXDetector::openDistance ( )

inline

Opens the dataset containing pixel distances.

Definition at line 641 of file NexusClasses.h.

◆ openPolarAngle()

NXFloat Mantid::Nexus::NXDetector::openPolarAngle ( )

inline

Opens the dataset containing pixel polar angles.

Definition at line 645 of file NexusClasses.h.

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

Framework/Nexus/inc/MantidNexus/NexusClasses.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NXDetector()

Member Function Documentation

◆ NX_class()

◆ openAzimuthalAngle()

◆ openDistance()

◆ openPolarAngle()