Mantid::Crystal::PeakCandidate Class Reference

#include <IndexSXPeaks.h>

Public Member Functions
void	addHKL (int h, int k, int l)
double	angle (const PeakCandidate &rhs) const
size_t	candidateHKLSize () const
void	clean (PeakCandidate &rhs, const Mantid::Geometry::UnitCell &uc, double tolerance)
void	delHKL (int h, int k, int l)
double	getdSpacing () const
Mantid::Kernel::V3D	getHKL () const
const Mantid::Kernel::V3D &	getQ () const
	PeakCandidate (double qx, double qy, double qz)
void	setFirst ()
void	setIndex (const std::set< index > &s)

Private Attributes
std::set< index >	_hkls
Mantid::Kernel::V3D	_Q

Friends
std::ostream &	operator<< (std::ostream &os, const PeakCandidate &rhs)

Detailed Description

Definition at line 62 of file IndexSXPeaks.h.

Constructor & Destructor Documentation

PeakCandidate()

Mantid::Crystal::PeakCandidate::PeakCandidate ( double  qx, double  qy, double  qz  )

inline

Definition at line 64 of file IndexSXPeaks.h.

Member Function Documentation

addHKL()

void Mantid::Crystal::PeakCandidate::addHKL ( int  h, int  k, int  l  )

inline

Definition at line 66 of file IndexSXPeaks.h.

References index.

angle()

double Mantid::Crystal::PeakCandidate::angle ( const PeakCandidate &  rhs ) const

inline

Definition at line 81 of file IndexSXPeaks.h.

References rhs.

candidateHKLSize()

size_t Mantid::Crystal::PeakCandidate::candidateHKLSize ( ) const

inline

Definition at line 74 of file IndexSXPeaks.h.

clean()

void Mantid::Crystal::PeakCandidate::clean ( PeakCandidate &  rhs, const Mantid::Geometry::UnitCell &  uc, double  tolerance  )

inline

Definition at line 93 of file IndexSXPeaks.h.

References Mantid::Crystal::index::_h, Mantid::Crystal::index::_k, Mantid::Crystal::index::_l, Mantid::Geometry::UnitCell::recAngle(), rhs, and tolerance.

delHKL()

void Mantid::Crystal::PeakCandidate::delHKL ( int  h, int  k, int  l  )

inline

Definition at line 75 of file IndexSXPeaks.h.

getdSpacing()

double Mantid::Crystal::PeakCandidate::getdSpacing ( ) const

inline

Definition at line 65 of file IndexSXPeaks.h.

getHKL()

Mantid::Kernel::V3D Mantid::Crystal::PeakCandidate::getHKL ( ) const

inline

Definition at line 67 of file IndexSXPeaks.h.

getQ()

const Mantid::Kernel::V3D & Mantid::Crystal::PeakCandidate::getQ ( ) const

inline

Definition at line 80 of file IndexSXPeaks.h.

setFirst()

void Mantid::Crystal::PeakCandidate::setFirst ( )

inline

Definition at line 86 of file IndexSXPeaks.h.

setIndex()

void Mantid::Crystal::PeakCandidate::setIndex ( const std::set< index > &  s )

inline

Definition at line 82 of file IndexSXPeaks.h.

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const PeakCandidate &  rhs  )

friend

Definition at line 119 of file IndexSXPeaks.h.

Member Data Documentation

_hkls

std::set<index> Mantid::Crystal::PeakCandidate::_hkls

private

Definition at line 127 of file IndexSXPeaks.h.

_Q

Mantid::Kernel::V3D Mantid::Crystal::PeakCandidate::_Q

private

Definition at line 126 of file IndexSXPeaks.h.

---

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

• Framework/Crystal/inc/MantidCrystal/IndexSXPeaks.h