Visualization::Common::DatFile Class Reference

File with volume data. More...

List of all members.

Public Member Functions
	DatFile (string fileName)
	generates a new datfile object, from a VISLU formatted .dat file
bool	ReadFromFile ()
	reads from the file, without reporting progress to a worker
bool	ReadFromFile (BackgroundWorker worker)
	reads from the file, and reports progress to a worker
Vector3[,,]	GenerateGradients (BackgroundWorker worker)
	Generates the normalized Gradient Vectors from the DataSet.
Properties
string	FileNameFullPath [get]
	returns the full path of the .dat file
string	FileName [get]
	returns only the filename of the .dat file
Vector3[,,]	Gradients [get, set]
	returns the generated gradient vectors
float[]	gradients2 [get, set]
	returns the generated gradient vectors in onedimensional array
int	SizeZ [get]
	returns the Z size of the dataset
int	SizeY [get]
	returns the Y size of the dataset
int	SizeX [get]
	returns the X size of the dataset
float[]	Data [get]
	returns the full normalized DataSet as contained in the .dat file
int[]	DataInt [get]
	returns the non-normalized Data
byte[]	VolumeData [get]
	create volume data in Format, to produce grayscale image R = G = B, X = 255. thanks to the allmighty gamedev.net community.

---

Detailed Description

File with volume data.

---

Constructor & Destructor Documentation

Visualization::Common::DatFile::DatFile

(

string

fileName

)

[inline]

generates a new datfile object, from a VISLU formatted .dat file

Parameters:

fileName

path to the file

---

Member Function Documentation

Vector3 [, ,] Visualization::Common::DatFile::GenerateGradients

(

BackgroundWorker

worker

)

[inline]

Generates the normalized Gradient Vectors from the DataSet.

Parameters:

worker

The worker it reports progress to, or null

Returns:

the Gradient dataset

bool Visualization::Common::DatFile::ReadFromFile

(

BackgroundWorker

worker

)

[inline]

reads from the file, and reports progress to a worker

Returns:

true, if loading was successful

bool Visualization::Common::DatFile::ReadFromFile

(

)

[inline]

reads from the file, without reporting progress to a worker

Returns:

true, if loading was successful

---

Property Documentation

float [] Visualization::Common::DatFile::Data [get]

returns the full normalized DataSet as contained in the .dat file

int [] Visualization::Common::DatFile::DataInt [get]

returns the non-normalized Data

string Visualization::Common::DatFile::FileName [get]

returns only the filename of the .dat file

string Visualization::Common::DatFile::FileNameFullPath [get]

returns the full path of the .dat file

Vector3 [, ,] Visualization::Common::DatFile::Gradients [get, set]

returns the generated gradient vectors

float [] Visualization::Common::DatFile::gradients2 [get, set]

returns the generated gradient vectors in onedimensional array

int Visualization::Common::DatFile::SizeX [get]

returns the X size of the dataset

int Visualization::Common::DatFile::SizeY [get]

returns the Y size of the dataset

int Visualization::Common::DatFile::SizeZ [get]

returns the Z size of the dataset

byte [] Visualization::Common::DatFile::VolumeData [get]

create volume data in Format, to produce grayscale image R = G = B, X = 255. thanks to the allmighty gamedev.net community.

---

The documentation for this class was generated from the following file:

• C:/Users/thomas/Documents/Visual Studio 2008/Projects/VisOGL-svn/VisualizationLU/Visualization.Common/DatFile.cs