Main Page | Packages | Class Hierarchy | Class List | Directories | Class Members

IDVR.Volume.DataLoader Class Reference

#include <DataLoader.h>

List of all members.


Detailed Description

Class to load the entire data structure from a specified data file.

This class is part of the main namespace Volume in which it is the only memeber class besides the subnamespace DataStructure.

With this class the loading of the entire volume data set from an arbitrary choosen *.dat file (ordinary ASCII-Textfile with the file extension .dat) will be easily achived. Only the valid file name and file path must be specified outside of this class structure in an instance of the main GUI class Neu.

Furthermore, this class contains the essantial member object of the class VolumeData which is the controll class of the stored volume data structure after the loading process. Every class which accesses this volume data structure has to do this by using this member object.
Note that with the deleting of the instance of this class also the current loaded volume data structure will be lost.

See also:
Neu - the main GUI class.

VolumeData - the main datastructure class.

Author:
Bernhard Pflugfelder
Version:
1.0
Date:
02-19-2005


Public Member Functions

 DataLoader (void)
 This is the standard constructor.
 ~DataLoader (void)
 This is the standard deconstructor.
void readDataFile (void)
 Reads the entire volume data structure from file and initialze the actual data structure.
unsigned short readMaskFile (String *n_ObjectDescription)
 Reads the mask data from file and sets the corresponding voxel object ID numbers.
void calculateGradients (void)
 Calculates all gradient vector values of the volume data structure.
void clearDataSet (void)
 Delets the entire data structure for saving memory.
void resetObjectIDs (void)
 Resets the object IDs of all voxels of the volume data structure to the general object.
__property void set_FileName (String *n_FileName)
 Sets a new file name and file path for upcoming loading processes.
__property String * get_FileName (void)
 Returns the current file name and file path.
__property void set_GradientEstimationMode (unsigned char n_GradientEstimationMode)
 Sets a new gradient calculation mode for upcoming loading processes.
VolumeDatagetDataset (void)
 Returns the current volume data structure.

Public Attributes

VolumeDatam_Dataset
 Saves the current volume data structure.

Private Types

enum  voxelIndices
 Constant index values for the three components of the three dimensional volume data set.

Private Attributes

unsigned char m_GradientEstimationMode
 Saves the current gradient calculation mode.
String * m_FileName
 Saves the current file name and file path.


Constructor & Destructor Documentation

DataLoader::DataLoader void   ) 
 

This is the standard constructor.

All member variables of this new instance will be set to zero/null.

DataLoader::~DataLoader void   ) 
 

This is the standard deconstructor.

All member variables will be deleted.


Member Function Documentation

void DataLoader::calculateGradients void   ) 
 

Calculates all gradient vector values of the volume data structure.

This function will be only used if the current data set is not too big because the saving of the gradients consumes lot of memory. Thus, if the current data set is actually too big (see DataLoader::MaxUsableMemory for the maximum usable memory size) the gradients will be calculated during the rendering process.

The member variable DataLoader.m_GradientEstimationMode gives information about which gradient calculation mode should be used (defined in the GradientEstimationSW class).

See also:
GradientEstimationSW

void DataLoader::clearDataSet void   ) 
 

Delets the entire data structure for saving memory.

String * DataLoader::get_FileName void   ) 
 

Returns the current file name and file path.

Returns:
The current saved file path and name.

VolumeData * DataLoader::getDataset void   ) 
 

Returns the current volume data structure.

Returns:
An instance of the class VolumeData.

void DataLoader::readDataFile void   ) 
 

Reads the entire volume data structure from file and initialze the actual data structure.

This function encapsulates the main task of this class which is the loading of the volume data structure from the already specified file name (see DataLoader.set_FileName). The loaded data will be automatically saved in an instance of the class VolumeData which is the member object DataLoader.m_Dataset.

unsigned short DataLoader::readMaskFile String *  n_ObjectDescription  ) 
 

Reads the mask data from file and sets the corresponding voxel object ID numbers.

This function loads the mask data from the already specified file name (see DataLoader.set_FileName) and updates the current member object DataLoader.m_Dataset. This means a new volume data object has to be created and the corresponding voxel object ID keys have to be set.

Parameters:
n_ObjectDescription the description of the new volume data object.
Returns:
The unique object ID of the newly created volume data object.

void DataLoader::resetObjectIDs void   ) 
 

Resets the object IDs of all voxels of the volume data structure to the general object.

See also:
DataObject

void DataLoader::set_FileName String *  n_FileName  ) 
 

Sets a new file name and file path for upcoming loading processes.

Parameters:
n_FileName the new file path and name.

void DataLoader::set_GradientEstimationMode unsigned char  n_GradientEstimationMode  ) 
 

Sets a new gradient calculation mode for upcoming loading processes.

Parameters:
n_GradientEstimationMode the new gradient calculation mode.
See also:
GradientEstimationSW


The documentation for this class was generated from the following files:
Generated on Sat Apr 9 11:51:01 2005 for RayCaster wiht Importance Driven Volume Rendering (IDVR) by  doxygen 1.4.1