Mantid::API::SpectrumInfoItem< T > Class Template Reference

SpectrumInfoItem. More...

#include <SpectrumInfoItem.h>

Public Member Functions
bool	hasDetectors () const
bool	hasUniqueDetector () const
bool	isMasked () const
bool	isMonitor () const
double	l2 () const
Mantid::Kernel::V3D	position () const
void	setMasked (bool masked)
double	signedTwoTheta () const
const Mantid::SpectrumDefinition &	spectrumDefinition () const
	SpectrumInfoItem (T &spectrumInfo, const size_t index)
double	twoTheta () const

Public Attributes
size_t	m_index
T *	m_spectrumInfo

Detailed Description

template<typename T>
class Mantid::API::SpectrumInfoItem< T >

SpectrumInfoItem.

SpectrumInfoItem is only created by SpectrumInfoIterator and allows users of the SpectrumInfoIterator object access to data from SpectrumInfo. The available methods include:

• isMonitor()
• isMaksed()
• twoTheta()
• signedTwoTheta()
• l2()
• hasUniqueDetector()
• spectrumDefinition()
• position()

Author

Bhuvan Bezawada, STFC

Date

2018

Definition at line 37 of file SpectrumInfoItem.h.

Constructor & Destructor Documentation

SpectrumInfoItem()

template<typename T >

Mantid::API::SpectrumInfoItem< T >::SpectrumInfoItem ( T &  spectrumInfo, const size_t  index  )

inline

Definition at line 64 of file SpectrumInfoItem.h.

Member Function Documentation

hasDetectors()

template<typename T >

bool Mantid::API::SpectrumInfoItem< T >::hasDetectors ( ) const

inline

Definition at line 58 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

hasUniqueDetector()

template<typename T >

bool Mantid::API::SpectrumInfoItem< T >::hasUniqueDetector ( ) const

inline

Definition at line 56 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

isMasked()

template<typename T >

bool Mantid::API::SpectrumInfoItem< T >::isMasked ( ) const

inline

Definition at line 43 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

isMonitor()

template<typename T >

bool Mantid::API::SpectrumInfoItem< T >::isMonitor ( ) const

inline

Definition at line 41 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

l2()

template<typename T >

double Mantid::API::SpectrumInfoItem< T >::l2 ( ) const

inline

Definition at line 54 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

position()

template<typename T >

Mantid::Kernel::V3D Mantid::API::SpectrumInfoItem< T >::position ( ) const

inline

Definition at line 62 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

setMasked()

template<typename T >

void Mantid::API::SpectrumInfoItem< T >::setMasked ( bool  masked )

inline

Definition at line 45 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

signedTwoTheta()

template<typename T >

double Mantid::API::SpectrumInfoItem< T >::signedTwoTheta ( ) const

inline

Definition at line 52 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

spectrumDefinition()

template<typename T >

const Mantid::SpectrumDefinition & Mantid::API::SpectrumInfoItem< T >::spectrumDefinition ( ) const

inline

Definition at line 60 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

twoTheta()

template<typename T >

double Mantid::API::SpectrumInfoItem< T >::twoTheta ( ) const

inline

Definition at line 50 of file SpectrumInfoItem.h.

References Mantid::API::SpectrumInfoItem< T >::m_index, and Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo.

Member Data Documentation

m_index

template<typename T >

size_t Mantid::API::SpectrumInfoItem< T >::m_index

Definition at line 69 of file SpectrumInfoItem.h.

Referenced by Mantid::API::SpectrumInfoItem< T >::hasDetectors(), Mantid::API::SpectrumInfoItem< T >::hasUniqueDetector(), Mantid::API::SpectrumInfoItem< T >::isMasked(), Mantid::API::SpectrumInfoItem< T >::isMonitor(), Mantid::API::SpectrumInfoItem< T >::l2(), Mantid::API::SpectrumInfoItem< T >::position(), Mantid::API::SpectrumInfoItem< T >::setMasked(), Mantid::API::SpectrumInfoItem< T >::signedTwoTheta(), Mantid::API::SpectrumInfoItem< T >::spectrumDefinition(), and Mantid::API::SpectrumInfoItem< T >::twoTheta().

m_spectrumInfo

template<typename T >

T* Mantid::API::SpectrumInfoItem< T >::m_spectrumInfo

Definition at line 68 of file SpectrumInfoItem.h.

Referenced by Mantid::API::SpectrumInfoItem< T >::hasDetectors(), Mantid::API::SpectrumInfoItem< T >::hasUniqueDetector(), Mantid::API::SpectrumInfoItem< T >::isMasked(), Mantid::API::SpectrumInfoItem< T >::isMonitor(), Mantid::API::SpectrumInfoItem< T >::l2(), Mantid::API::SpectrumInfoItem< T >::position(), Mantid::API::SpectrumInfoItem< T >::setMasked(), Mantid::API::SpectrumInfoItem< T >::signedTwoTheta(), Mantid::API::SpectrumInfoItem< T >::spectrumDefinition(), and Mantid::API::SpectrumInfoItem< T >::twoTheta().

---

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

• Framework/API/inc/MantidAPI/SpectrumInfoItem.h