BALL::DSN6File Class Reference

#include <BALL/FORMAT/DSN6File.h>

Inheritance diagram for BALL::DSN6File:
BALL::File

List of all members.

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 DSN6Fileoperator= (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)
virtual bool readHeader ()
virtual bool read (RegularData3D &map)
virtual bool writeHeader ()

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.


Constructor & Destructor Documentation

BALL::DSN6File::DSN6File ( )

Default constructor.

BALL::DSN6File::DSN6File ( const DSN6File file) throw (Exception::FileNotFound)

Copy constructor.

BALL::DSN6File::DSN6File ( const String name,
File::OpenMode  open_mode = std::ios::in 
)

Detailed constructor.

virtual BALL::DSN6File::~DSN6File ( ) [virtual]

Destructor.


Member Function Documentation

virtual void BALL::DSN6File::clear ( ) [virtual]

Clear method.

Reimplemented from BALL::File.

void BALL::DSN6File::convertBrick_ ( char *  brick) [protected]
bool BALL::DSN6File::isSwappingBytes ( ) const
virtual bool BALL::DSN6File::open ( const String name,
File::OpenMode  open_mode = std::ios::in 
) throw (Exception::FileNotFound) [virtual]

open a DSN6File

Reimplemented from BALL::File.

const DSN6File& BALL::DSN6File::operator= ( const DSN6File file)

Assignment operator.

bool BALL::DSN6File::operator== ( const DSN6File file) const

Equality operator.

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.

short int BALL::DSN6File::readHeaderValue_ ( char *  header,
Position  pos 
) [protected]
virtual bool BALL::DSN6File::writeHeader ( ) [virtual]

Write a header Return true if the header could be written successfully, false ow.


Member Data Documentation

angles of the crystal unit cell

scaling factor for the cell geometry

dimension of the crystal unit cell in Angstrom/sample

the extent of the map

geometry in cartesian coordinates

conversion factors for the density map

the sampling rates used for the map

the start coordinates in grid coordinates, i.e. indices

a flag indicating that we have to swap bytes when reading header values