cell description (automatically converts to radians) More...
#include <cell.h>
Public Member Functions | |
| Cell_descr () | |
| null constructor | |
| Cell_descr (const ftype &a, const ftype &b, const ftype &c, const ftype &alpha=90.0f, const ftype &beta=90.0f, const ftype &gamma=90.0f) | |
| constructor: from cell parameters | |
| const ftype & | a () const |
| get a | |
| const ftype & | b () const |
| get b | |
| const ftype & | c () const |
| get c | |
| const ftype & | alpha () const |
| get alpha | |
| const ftype & | beta () const |
| get beta | |
| const ftype & | gamma () const |
| get gamma | |
| ftype | alpha_deg () const |
| get alpha in degrees | |
| ftype | beta_deg () const |
| get alpha in degrees | |
| ftype | gamma_deg () const |
| get gamma in degrees | |
| String | format () const |
| return formatted String representation | |
Protected Attributes | |
| ftype | a_ |
| ftype | b_ |
| ftype | c_ |
| ftype | alpha_ |
| ftype | beta_ |
| ftype | gamma_ |
Detailed Description
cell description (automatically converts to radians)
The cell description is a compact description of a cell, containing just the cell parameters. It is usually used to construct a full Cell object, which provides the expected functionality.
Constructor & Destructor Documentation
| clipper::Cell_descr::Cell_descr | ( | const ftype & | a, |
| const ftype & | b, | ||
| const ftype & | c, | ||
| const ftype & | alpha = 90.0f, |
||
| const ftype & | beta = 90.0f, |
||
| const ftype & | gamma = 90.0f |
||
| ) |
constructor: from cell parameters
- Parameters:
-
a A axis in Angstroms. b B axis in Angstroms. c C axis in Angstroms. alpha Angle between B and C axes in radians or degrees, default=90 beta Angle between A and C axes in radians or degrees, default=90 gamma Angle between A and C axes in radians or degrees, default=90
References a(), alpha(), b(), beta(), c(), clipper::Util::d2rad(), and gamma().
Member Function Documentation
| ftype clipper::Cell_descr::alpha_deg | ( | ) | const |
get alpha in degrees
- Returns:
- The cell angle in degrees
Reimplemented in clipper::Cell.
References clipper::Util::rad2d().
Referenced by format().
| ftype clipper::Cell_descr::beta_deg | ( | ) | const |
get alpha in degrees
- Returns:
- The cell angle in degrees
Reimplemented in clipper::Cell.
References clipper::Util::rad2d().
Referenced by format().
| ftype clipper::Cell_descr::gamma_deg | ( | ) | const |
get gamma in degrees
- Returns:
- The cell angle in degrees
Reimplemented in clipper::Cell.
References clipper::Util::rad2d().
Referenced by format().
| String clipper::Cell_descr::format | ( | ) | const |
return formatted String representation
- Returns:
- A string describing the cell
Reimplemented in clipper::Cell.
References a(), alpha_deg(), b(), beta_deg(), c(), and gamma_deg().
The documentation for this class was generated from the following files:
- cell.h
- cell.cpp
