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

vlVolFioDEN Class Reference

File IO for the "den" file format. More...

#include <den.h>

Inheritance diagram for vlVolFioDEN:

vlVolFioFilter vlPlugin List of all members.

Public Member Functions

 vlVolFioDEN ()
 Default constructor.

virtual ~vlVolFioDEN ()
 Default destructor.

const std::vector< std::string > & getFileExtensions () const
 Return the list of valid file extensions for this file format.

bool readInfo (vlVolInfo &info, FILE *const fp, const std::string &filename)
 Read info about the volume from the file.

bool readData (vlVolInfo &info, vlVolData *const data, FILE *const fp, const std::string &filename)
 Read volume data from the file.

bool writeInfo (const vlVolInfo &info, FILE *const fp, const std::string &filename)
 Write just the volume information to the file.

bool writeData (const vlVolInfo &info, const vlVolData *data, FILE *const fp, const std::string &filename)
 Write just the volume data to file.


Protected Attributes

std::vector< std::string > m_fileExtensions
 Extensions associated with the file format.


Static Private Attributes

const int16 MAP_CUR_VERSION = 1
 constants for .den magic number (map_version field)

const int16 MAP_CUR_VERSION_SWAB = 0x0100
 Byte-swapped version number.


Detailed Description

Files in this format were available from the Standford University along with the VolPack library.

Definition at line 39 of file den.h.


Constructor & Destructor Documentation

vlVolFioDEN::vlVolFioDEN  ) 
 

Definition at line 61 of file den.cpp.

References vlPlugin::infoRef(), m_fileExtensions, vlPluginInfo::setName(), vlPluginInfo::setService(), and vlPluginInfo::setVersion().

vlVolFioDEN::~vlVolFioDEN  )  [virtual]
 

Definition at line 74 of file den.cpp.


Member Function Documentation

const std::vector< std::string > & vlVolFioDEN::getFileExtensions  )  const [virtual]
 

Returns:
String with extensions associated with this file format.

Implements vlVolFioFilter.

Definition at line 85 of file den.cpp.

References m_fileExtensions.

bool vlVolFioDEN::readData vlVolInfo info,
vlVolData *const  data,
FILE *const  fp,
const std::string &  filename
[virtual]
 

Parameters:
data place to load the read data.
Returns:
true if loading data was successful, else false

Implements vlVolFioFilter.

Definition at line 211 of file den.cpp.

References vlVolInfo::dataType(), vlVolData::dataType(), vlVolInfo::dim(), vlVolData::dim(), vlVolInfo::isValid(), vlVolIterConst< DataType, Layout >::nextXYZ(), vlVolIter< DataType, Layout >::set(), uint32, uint8, vlTriple< uint16 >::x(), vlTriple< uint16 >::y(), and vlTriple< uint16 >::z().

bool vlVolFioDEN::readInfo vlVolInfo info,
FILE *const  fp,
const std::string &  filename
[virtual]
 

Parameters:
info place to load the volume information
Returns:
Always returns false.

Implements vlVolFioFilter.

Definition at line 97 of file den.cpp.

References vlVolInfo::dim(), int16, int32, MAP_CUR_VERSION, MAP_CUR_VERSION_SWAB, vlVolInfo::setBitsPerVoxel(), vlVolInfo::setBytesPerVoxel(), vlVolInfo::setDataType(), vlVolInfo::setDim(), vlVolInfo::setHeaderSize(), vlVolInfo::setStepping(), vlVolInfo::setUnits(), swapInt16(), swapInt32(), uint32, and UnsignedInt8.

bool vlVolFioDEN::writeData const vlVolInfo info,
const vlVolData data,
FILE *const  fp,
const std::string &  filename
[virtual]
 

Parameters:
info 
data 
fp 
filename 
Returns:

Implements vlVolFioFilter.

Definition at line 353 of file den.cpp.

References vlVolInfo::dataType(), vlVolIterConst< DataType, Layout >::get(), vlVolIterConst< DataType, Layout >::nextXYZ(), and UnsignedInt8.

bool vlVolFioDEN::writeInfo const vlVolInfo info,
FILE *const  fp,
const std::string &  filename
[virtual]
 

Parameters:
info Information to write.
fp 
filename 
Returns:

Implements vlVolFioFilter.

Definition at line 294 of file den.cpp.

References vlVolInfo::dataType(), vlVolInfo::dim(), int16, int32, UnsignedInt8, vlTriple< uint16 >::x(), vlTriple< uint16 >::y(), and vlTriple< uint16 >::z().


Member Data Documentation

std::vector<std::string> vlVolFioDEN::m_fileExtensions [protected]
 

Definition at line 65 of file den.h.

Referenced by getFileExtensions(), and vlVolFioDEN().

const int16 vlVolFioDEN::MAP_CUR_VERSION = 1 [static, private]
 

Definition at line 69 of file den.h.

Referenced by readInfo().

const int16 vlVolFioDEN::MAP_CUR_VERSION_SWAB = 0x0100 [static, private]
 

Definition at line 72 of file den.h.

Referenced by readInfo().


The documentation for this class was generated from the following files:
Generated on Fri Mar 18 11:33:20 2005 for OpenVL by doxygen 1.3.3