BALL::DSN6File Class Reference
[File
Formats]
DSN6
density map file format. More...
#include <DSN6File.h>
Inheritance diagram for BALL::DSN6File:
[legend]
Public Member Functions |
|
|
Constructors and Destructor
|
|
| DSN6File () | |
| Default constructor. |
|
| DSN6File (const DSN6File &file) throw (Exception::FileNotFound) | |
| Copy constructor. |
|
| DSN6File (const String &name, File::OpenMode open_mode=std::ios::in) | |
| Detailed constructor. |
|
| virtual | ~DSN6File () |
| Destructor. |
|
|
Assignment
|
|
| const DSN6File & | operator= (const DSN6File &file) |
| Assignment operator. |
|
| virtual void | clear () |
| Clear method. |
|
|
Predicates
|
|
| bool | operator== (const DSN6File &file) const |
| Equality operator. |
|
| bool | isSwappingBytes () const |
|
Public methods for file handling
|
|
| virtual bool | open (const String &name, File::OpenMode open_mode=std::ios::in) throw (Exception::FileNotFound) |
| open a DSN6File |
|
| virtual bool | readHeader () |
| Read the header of an existing file.
|
|
| virtual bool | read (RegularData3D &map) |
| Read the file into a RegularData3D
field. |
|
| virtual bool | writeHeader () |
| Write a header Return true if the
header could be written successfully, false ow. |
|
Protected Member Functions |
|
| short int | readHeaderValue_ (char *header, Position pos) |
| void | convertBrick_ (char *brick) |
Protected Attributes |
|
| bool | swap_bytes_ |
| a flag indicating that we have to
swap bytes when reading header values |
|
| Vector3 | start_ |
| the start coordinates in grid
coordinates, i.e. indices |
|
| Vector3 | extent_ |
| the extent of the map |
|
| Vector3 | sampling_rate_ |
| the sampling rates used for the
map |
|
| Vector3 | crystal_dimension_ |
| dimension of the crystal unit cell
in Angstrom/sample |
|
| Angle | alpha_ |
| angles of the crystal unit
cell |
|
| Angle | beta_ |
| Angle | gamma_ |
| float | cell_scaling_ |
| scaling factor for the cell
geometry |
|
| float | prod_ |
| conversion factors for the density
map |
|
| float | plus_ |
| Vector3 | origin_ |
| geometry in cartesian
coordinates |
|
| Vector3 | xaxis_ |
| Vector3 | yaxis_ |
| Vector3 | zaxis_ |
Detailed Description
DSN6 density map file format.This class enables BALL to read and write DSN6 - type binary electron density maps as used by FRODO and O.
Member Function Documentation
| virtual bool BALL::DSN6File::read | ( | RegularData3D & | map | ) | [virtual] |
Read the file into a RegularData3D field.
| virtual bool BALL::DSN6File::readHeader | ( | ) | [virtual] |
Read the header of an existing file.
Return true if the header could be read successfully, false ow.
