---

cctbx::Miller::SymEquivIndex Class Reference

Class for symmetrically equivalent Miller indices. More...

#include <miller.h>

Inheritance diagram for cctbx::Miller::SymEquivIndex::

List of all members.

Public Methods
	SymEquivIndex ()
	Default constructor. Some data members are not initialized!
	SymEquivIndex (const Index &HR, int HT, int TBF)
	Constructor. More...
const Index &	HR () const
	Product of Miller index and rotation part of symmetry operation.
int	HT () const
	Product of Miller index and translation part of symmetry operation.
int	TBF () const
	Translation base factor. More...
template<class FloatType> FloatType	Phase_rad (const FloatType &phi) const
	Phase of this index in radians, given phase of input Miller index. More...
template<class FloatType> FloatType	Phase_deg (const FloatType &phi) const
	Phase of this index in degrees, given phase of input Miller index. More...
template<class FloatType> std::complex< FloatType >	ShiftPhase (const std::complex< FloatType > &F) const
	Complex value for this index, given complex value for input index. More...

---

Detailed Description

Class for symmetrically equivalent Miller indices.

---

Constructor & Destructor Documentation

cctbx::Miller::SymEquivIndex::SymEquivIndex (  const Index &    HR, int    HT, int    TBF )  [inline]

Constructor. HR is the product of the input index H and the rotation part of a symmetry operation. HT is the product of the input index H and the translation part of the symmetry operation, multiplied by the translation base-factor TBF in order to obtain an integer value for HT.

---

Member Function Documentation

template<class FloatType> FloatType cctbx::Miller::SymEquivIndex::Phase_deg (  const FloatType &    phi )  const [inline]

Phase of this index in degrees, given phase of input Miller index. Formula used: this_phi = phi - (2 * 180 * HT()) / TBF(); Reimplemented in cctbx::Miller::IndexTableLayoutAdaptor.

template<class FloatType> FloatType cctbx::Miller::SymEquivIndex::Phase_rad (  const FloatType &    phi )  const [inline]

Phase of this index in radians, given phase of input Miller index. Formula used: this_phi = phi - (2 * pi * HT()) / TBF(); Reimplemented in cctbx::Miller::IndexTableLayoutAdaptor.

template<class FloatType> std::complex<FloatType> cctbx::Miller::SymEquivIndex::ShiftPhase (  const std::complex< FloatType > &    F )  const [inline]

Complex value for this index, given complex value for input index. Formula used: this_F = F * exp(-2 * pi * j * HT() / TBF()); where j is the imaginary number. Reimplemented in cctbx::Miller::IndexTableLayoutAdaptor.

int cctbx::Miller::SymEquivIndex::TBF (    )  const [inline]

Translation base factor. This is the factor by which HT() is multiplied.

---

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

• sgtbx/miller.h

---