SoVRVoxFileReader Class Reference
[Readers]
VOX file reader.
More...
#include <VolumeViz/readers/SoVRVoxFileReader.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRVoxFileReader () | |
| virtual int | setFilename (const SbString &filename) |
| virtual ReadError | getDataChar (SbBox3f &size, SoDataSet::DataType &type, SbVec3i32 &dim) |
| virtual void | getSubSlice (const SbBox2i32 &subSlice, int sliceNumber, void *data) |
| virtual int | getNumSignificantBits () |
| virtual SoVolumeReader::ReaderType | getReaderType () |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
VOX file reader.
Reader for TeraRecon ".vox" data files (vox1999 format).
VOX is a volume interchange format defined by TeraRecon Inc. (www.terarecon.com). The VolumeViz reader can load "Vox1999a" files containing 8- or 16-bit voxels (first volume only).
The following attributes are supported:
- "Volume Size" which describes the size of the volume in voxels.
- "Voxel Size" which describes the size of voxel data (only 8-bit and 16-bit are supported).
- "Endian" which describes the endianness of the data (both little-endian and big-endian modes are supported).
- "Volume Scale" which describes the volume of one voxel.
- "Volume Position" which describes the origin position of the first voxel.
Since Open Inventor 10.3, the following custom attributes are supported when specified in the "Field" descriptor:
- Scale: Define a scaling to apply to data values.
- Offset: Define an offset to apply to data values.
If Scale and Offset are specified and are not exactly 1 and 0 respectively:
- The actual data value will be : newValue = Scale * fileValue + Offset.
- The volume data type is automatically changed to SIGNED_SHORT.
This means that, even if the file is specified as unsigned 8 bit, the data will be loaded as signed 16 bit values.
Other attributes have no effect on the reader and loaded data.
Constructor & Destructor Documentation
| SoVRVoxFileReader::SoVRVoxFileReader | ( | ) |
Constructor.
Member Function Documentation
| static SoType SoVRVoxFileReader::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVolumeReader.
| virtual ReadError SoVRVoxFileReader::getDataChar | ( | SbBox3f & | size, | |
| SoDataSet::DataType & | type, | |||
| SbVec3i32 & | dim | |||
| ) | [virtual] |
Gets the characteristics (file header) of the data volume.
See SoVolumeData. size is the size of the actual volume. type is the type of the data. dim is the dimension of the data.
Implements SoVolumeReader.
| virtual int SoVRVoxFileReader::getNumSignificantBits | ( | ) | [inline, virtual] |
This method is optional.
It returns the number of significant bits of the volume data.
If it is not implemented, the default return value is 0, meaning the number of bits depends on the data type. See the last parameter of SoVolumeData::setVolumeData(). This method is called immediately after getDataChar().
Reimplemented from SoVolumeReader.
| virtual SoVolumeReader::ReaderType SoVRVoxFileReader::getReaderType | ( | ) | [inline, virtual] |
Returns the reader type.
Reimplemented from SoVolumeReader.
| virtual void SoVRVoxFileReader::getSubSlice | ( | const SbBox2i32 & | subSlice, | |
| int | sliceNumber, | |||
| void * | data | |||
| ) | [virtual] |
New method required by VolumeViz 3.0 when using large volume support.
Must copy a rectangular part of an XY slice to the memory specified by data. Slices will not always be read sequentially.
Implements SoVolumeReader.
| virtual SoType SoVRVoxFileReader::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVolumeReader.
| virtual int SoVRVoxFileReader::setFilename | ( | const SbString & | filename | ) | [virtual] |
Specifies the path of the file.
Returns 0 for success. Any other return value indicates failure.
Reimplemented from SoVolumeReader.
The documentation for this class was generated from the following file:
- VolumeViz/readers/SoVRVoxFileReader.h