BALL::DSN6File Class Reference
[File Formats]

#include <BALL/FORMAT/DSN6File.h>

Inheritance diagram for BALL::DSN6File:

[legend]

List of all members.

Public Member Functions
Constructors and Destructor
	DSN6File ()
	Default constructor.
	DSN6File (const String &name, File::OpenMode open_mode=std::ios::in)
	Detailed constructor.
virtual	~DSN6File ()
	Destructor.
Assignment
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)
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_
Private Member Functions
const DSN6File &	operator= (const DSN6File &file)

---

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.

Definition at line 23 of file DSN6File.h.

---

Constructor & Destructor Documentation

BALL::DSN6File::DSN6File

(

)

Default 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
	)			[virtual]

open a DSN6File

Exceptions:

Exception::FileNotFound

if the file could not be opened

Reimplemented from BALL::File.

const DSN6File& BALL::DSN6File::operator=

(

const DSN6File &

file

)

[private]

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

Angle BALL::DSN6File::alpha_ [protected]

angles of the crystal unit cell

Definition at line 115 of file DSN6File.h.

Angle BALL::DSN6File::beta_ [protected]

Definition at line 115 of file DSN6File.h.

float BALL::DSN6File::cell_scaling_ [protected]

scaling factor for the cell geometry

Definition at line 118 of file DSN6File.h.

Vector3 BALL::DSN6File::crystal_dimension_ [protected]

dimension of the crystal unit cell in Angstrom/sample

Definition at line 112 of file DSN6File.h.

Vector3 BALL::DSN6File::extent_ [protected]

the extent of the map

Definition at line 106 of file DSN6File.h.

Angle BALL::DSN6File::gamma_ [protected]

Definition at line 115 of file DSN6File.h.

Vector3 BALL::DSN6File::origin_ [protected]

geometry in cartesian coordinates

Definition at line 125 of file DSN6File.h.

float BALL::DSN6File::plus_ [protected]

Definition at line 122 of file DSN6File.h.

float BALL::DSN6File::prod_ [protected]

conversion factors for the density map

Definition at line 121 of file DSN6File.h.

Vector3 BALL::DSN6File::sampling_rate_ [protected]

the sampling rates used for the map

Definition at line 109 of file DSN6File.h.

Vector3 BALL::DSN6File::start_ [protected]

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

Definition at line 103 of file DSN6File.h.

bool BALL::DSN6File::swap_bytes_ [protected]

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

Definition at line 100 of file DSN6File.h.

Vector3 BALL::DSN6File::xaxis_ [protected]

Definition at line 125 of file DSN6File.h.

Vector3 BALL::DSN6File::yaxis_ [protected]

Definition at line 125 of file DSN6File.h.

Vector3 BALL::DSN6File::zaxis_ [protected]

Definition at line 125 of file DSN6File.h.