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

vlVolFioPGMVol Class Reference

#include <pgmvol.h>

Inheritance diagram for vlVolFioPGMVol:

vlVolFioFilter vlPlugin List of all members.

Public Member Functions

 vlVolFioPGMVol ()
 Default constructor.

virtual ~vlVolFioPGMVol ()
 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 Member Functions

template<class T> bool readDataT (T &dummy, vlVolInfo &info, vlVolData *const data, FILE *const fp, const std::string &filename)
template<class T> bool writeDataT (T &dummy, const vlVolInfo &info, const vlVolData *data, FILE *const fp, const std::string &filename)

Protected Attributes

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

Constructor & Destructor Documentation

vlVolFioPGMVol::vlVolFioPGMVol (   ) 
 

Definition at line 46 of file pgmvol.cpp.

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

vlVolFioPGMVol::~vlVolFioPGMVol (   )  [virtual]
 

Definition at line 59 of file pgmvol.cpp.

Member Function Documentation

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

Returns:
String with extensions associated with this file format.

Implements vlVolFioFilter.

Definition at line 70 of file pgmvol.cpp.

References m_fileExtensions.

bool vlVolFioPGMVol::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 128 of file pgmvol.cpp.

References callFunctionOnDataType, vlVolInfo::dataType(), vlVolData::dataType(), vlVolInfo::dim(), vlVolData::dim(), filename, vlVolInfo::isValid(), and readDataT().

template<class T>
bool vlVolFioPGMVol::readDataT (  T &  dummy,
vlVolInfo &  info,
vlVolData *const  data,
FILE *const  fp,
const std::string &  filename
)  [protected]
 

Definition at line 157 of file pgmvol.cpp.

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

Referenced by readData().

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

The idea here is to always return false since there is no way to read the correct information from a raw file. Instead, whatever possible information gathered from the file is loaded into vlVolInfo and a false is returned.

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

Implements vlVolFioFilter.

Definition at line 85 of file pgmvol.cpp.

References vlVolInfo::dim(), max, vlVolInfo::setDataType(), vlVolInfo::setDim(), uint16, and UnsignedInt8.

bool vlVolFioPGMVol::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 237 of file pgmvol.cpp.

References callFunctionOnDataType, vlVolData::dataType(), filename, and writeDataT().

template<class T>
bool vlVolFioPGMVol::writeDataT (  T &  dummy,
const vlVolInfo &  info,
const vlVolData *  data,
FILE *const  fp,
const std::string &  filename
)  [protected]
 

Definition at line 250 of file pgmvol.cpp.

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

Referenced by writeData().

bool vlVolFioPGMVol::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 219 of file pgmvol.cpp.

References vlVolInfo::bitsPerVoxel(), vlVolInfo::dim(), vlTriple< uint16 >::x(), vlTriple< uint16 >::y(), and vlTriple< uint16 >::z().

Member Data Documentation

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

Definition at line 69 of file pgmvol.h.

Referenced by getFileExtensions(), and vlVolFioPGMVol().

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