Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

vu1712< SIZE > Class Template Reference

The base class for fourier unimodal 3d data in the vuVolume data tree. More...

#include <3d.h>

Inheritance diagram for vu1712< SIZE >:

Inheritance graph
[legend]
Collaboration diagram for vu1712< SIZE >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vu1712 ()
 The default constructor.
 vu1712 (const vu1712< SIZE > &inst)
 The copy constructor.
vu1712< SIZE > & operator= (const vu1712< SIZE > &rhs)
 The assignment operator.
dword getDim1Size (void) const
 Returns the size of the data along the first dimension.
dword getDim2Size (void) const
 Returns the size of the data along the second dimension.
dword getDim3Size (void) const
 Returns the size of the data along the third dimension.
dword getSpacing (void) const
 Returns the spacing of the 3d grid.
int getDim1Origin (void) const
 Returns the origin of the data in the first dimension.
int getDim2Origin (void) const
 Returns the origin of the data in the second dimension.
int getDim3Origin (void) const
 Returns the origin of the data in the third dimension.
vuVector getCenter () const
 returns the center of the dataset (virtual in volume.h)

Static Public Member Functions

bool readData (FILE *file, float *vol, dword XX, dword YY, dword ZZ, dword XXsmall, dword YYsmall, dword ZZsmall)
bool writeData (FILE *file, float *vol, dword XX, dword YY, dword ZZ, dword XXsmall, dword YYsmall, dword ZZsmall)
floatpad (float *v, dword n)
bool writeHeader (FILE *file, dword XSize, dword YSize, dword ZSize)
bool readHeader (FILE *file, dword &XSize, dword &YSize, dword &ZSize)

Protected Member Functions

virtual bool readHeader (FILE *file)
virtual bool writeHeader (FILE *file)

Protected Attributes

dword m_Dim1Size
 The size of the first dimension of the data set.
dword m_Dim2Size
 the sizeof the second dimension of the data set
dword m_Dim3Size
 the size of the third dimension of the data set
dword m_Spacing
 The spacing of the grid.
int m_Dim1Origin
 The origin of the first dimension of the data set.
int m_Dim2Origin
 The origin of the second dimensino of the data set.
int m_Dim3Origin
 the origin of the third dimension of the data set

Detailed Description

template<int SIZE>
class vu1712< SIZE >

The base class for fourier unimodal 3d data in the vuVolume data tree.

Definition at line 9 of file Fourier/Unimodal/3d/3d.h.


Constructor & Destructor Documentation

template<int S>
vu1712< S >::vu1712  ) 
 

The default constructor.

Definition at line 10 of file Fourier/Unimodal/3d/3d.cpp.

References vu1712< SIZE >::m_Dim1Origin, vu1712< SIZE >::m_Dim1Size, vu1712< SIZE >::m_Dim2Origin, vu1712< SIZE >::m_Dim2Size, vu1712< SIZE >::m_Dim3Origin, vu1712< SIZE >::m_Dim3Size, and vu1712< SIZE >::m_Spacing.

template<int SIZE>
vu1712< SIZE >::vu1712 const vu1712< SIZE > &  inst  ) 
 

The copy constructor.


Member Function Documentation

template<int SIZE>
vuVector vu1712< SIZE >::getCenter  )  const [inline, virtual]
 

returns the center of the dataset (virtual in volume.h)

Reimplemented from vu1.

Definition at line 41 of file Fourier/Unimodal/3d/3d.h.

References vu1712< SIZE >::m_Dim1Size, vu1712< SIZE >::m_Dim2Size, and vu1712< SIZE >::m_Dim3Size.

template<int S>
int vu1712< S >::getDim1Origin void   )  const
 

Returns the origin of the data in the first dimension.

Definition at line 93 of file Fourier/Unimodal/3d/3d.cpp.

template<int S>
dword vu1712< S >::getDim1Size void   )  const
 

Returns the size of the data along the first dimension.

Definition at line 69 of file Fourier/Unimodal/3d/3d.cpp.

References dword.

template<int S>
int vu1712< S >::getDim2Origin void   )  const
 

Returns the origin of the data in the second dimension.

Definition at line 99 of file Fourier/Unimodal/3d/3d.cpp.

template<int S>
dword vu1712< S >::getDim2Size void   )  const
 

Returns the size of the data along the second dimension.

Definition at line 75 of file Fourier/Unimodal/3d/3d.cpp.

References dword.

template<int S>
int vu1712< S >::getDim3Origin void   )  const
 

Returns the origin of the data in the third dimension.

Definition at line 105 of file Fourier/Unimodal/3d/3d.cpp.

template<int S>
dword vu1712< S >::getDim3Size void   )  const
 

Returns the size of the data along the third dimension.

Definition at line 81 of file Fourier/Unimodal/3d/3d.cpp.

References dword.

template<int S>
dword vu1712< S >::getSpacing void   )  const
 

Returns the spacing of the 3d grid.

This is the spacing between the data values in each of the dimensions. This value is uniform in all dimensions since this is a fourier grid.

Definition at line 87 of file Fourier/Unimodal/3d/3d.cpp.

References dword.

template<int S>
vu1712< S > & vu1712< S >::operator= const vu1712< SIZE > &  rhs  ) 
 

The assignment operator.

Definition at line 46 of file Fourier/Unimodal/3d/3d.cpp.

References vu1712< SIZE >::m_Dim1Origin, vu1712< SIZE >::m_Dim1Size, vu1712< SIZE >::m_Dim2Origin, vu1712< SIZE >::m_Dim2Size, vu1712< SIZE >::m_Dim3Origin, vu1712< SIZE >::m_Dim3Size, vu1712< SIZE >::m_Spacing, and vu1::operator=().

Here is the call graph for this function:

template<int S>
float * vu1712< S >::pad float v,
dword  n
[static]
 

Definition at line 404 of file Fourier/Unimodal/3d/3d.cpp.

References dword.

Referenced by vu1712< SIZE >::readData().

template<int S>
bool vu1712< S >::readData FILE *  file,
float vol,
dword  XX,
dword  YY,
dword  ZZ,
dword  XXsmall,
dword  YYsmall,
dword  ZZsmall
[static]
 

Definition at line 168 of file Fourier/Unimodal/3d/3d.cpp.

References dword, vu1712< SIZE >::pad(), and size.

Referenced by vuFourierVolume_IO< S >::getSpatialDataFromVUF(), and vu1712_1< SIZE >::read().

Here is the call graph for this function:

template<int S>
bool vu1712< S >::readHeader FILE *  file,
dword XSize,
dword YSize,
dword ZSize
[static]
 

Definition at line 307 of file Fourier/Unimodal/3d/3d.cpp.

References dword.

template<int S>
bool vu1712< S >::readHeader FILE *  file  )  [protected, virtual]
 

Definition at line 116 of file Fourier/Unimodal/3d/3d.cpp.

References dword, vu1712< SIZE >::m_Dim1Origin, vu1712< SIZE >::m_Dim1Size, vu1712< SIZE >::m_Dim2Origin, vu1712< SIZE >::m_Dim2Size, vu1712< SIZE >::m_Dim3Origin, vu1712< SIZE >::m_Dim3Size, vu1712< SIZE >::m_Spacing, vu1::read(), vu1::setError(), and vu1::setInvalidFormatError().

Referenced by vuFourierVolume_IO< S >::getSpatialDataFromVUF(), and vu1712_1< SIZE >::read().

Here is the call graph for this function:

template<int S>
bool vu1712< S >::writeData FILE *  file,
float vol,
dword  XX,
dword  YY,
dword  ZZ,
dword  XXsmall,
dword  YYsmall,
dword  ZZsmall
[static]
 

Definition at line 248 of file Fourier/Unimodal/3d/3d.cpp.

References dword, and size.

Referenced by vuFourierVolume_IO< S >::scaleAndWriteToFourierFile(), and vu1712_1< SIZE >::write().

template<int S>
bool vu1712< S >::writeHeader FILE *  file,
dword  XSize,
dword  YSize,
dword  ZSize
[static]
 

Definition at line 287 of file Fourier/Unimodal/3d/3d.cpp.

template<int S>
bool vu1712< S >::writeHeader FILE *  file  )  [protected, virtual]
 

Definition at line 215 of file Fourier/Unimodal/3d/3d.cpp.

References vuString::c_str(), dword, vuString::isEmpty(), vu1712< SIZE >::m_Dim1Origin, vu1712< SIZE >::m_Dim1Size, vu1712< SIZE >::m_Dim2Origin, vu1712< SIZE >::m_Dim2Size, vu1712< SIZE >::m_Dim3Origin, vu1712< SIZE >::m_Dim3Size, vu1712< SIZE >::m_Spacing, vu1::setWriteError(), and vu1::write().

Referenced by vuFourierVolume_IO< S >::scaleAndWriteToFourierFile(), and vu1712_1< SIZE >::write().

Here is the call graph for this function:


Member Data Documentation

template<int SIZE>
int vu1712< SIZE >::m_Dim1Origin [protected]
 

The origin of the first dimension of the data set.

Definition at line 76 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().

template<int SIZE>
dword vu1712< SIZE >::m_Dim1Size [protected]
 

The size of the first dimension of the data set.

Definition at line 66 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::getCenter(), vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().

template<int SIZE>
int vu1712< SIZE >::m_Dim2Origin [protected]
 

The origin of the second dimensino of the data set.

Definition at line 78 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().

template<int SIZE>
dword vu1712< SIZE >::m_Dim2Size [protected]
 

the sizeof the second dimension of the data set

Definition at line 68 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::getCenter(), vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().

template<int SIZE>
int vu1712< SIZE >::m_Dim3Origin [protected]
 

the origin of the third dimension of the data set

Definition at line 80 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().

template<int SIZE>
dword vu1712< SIZE >::m_Dim3Size [protected]
 

the size of the third dimension of the data set

Definition at line 70 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::getCenter(), vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().

template<int SIZE>
dword vu1712< SIZE >::m_Spacing [protected]
 

The spacing of the grid.

Definition at line 73 of file Fourier/Unimodal/3d/3d.h.

Referenced by vu1712< SIZE >::operator=(), vu1712< SIZE >::readHeader(), vu1712< SIZE >::vu1712(), and vu1712< SIZE >::writeHeader().


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:21:11 2004 for vuVolume by  doxygen 1.3.9.1