SoVRVoxFileReader Class

VOX file reader.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.LDM.ReadersSoVolumeReader
            OIV.VolumeViz.ReadersSoVRVoxFileReader

Namespace: OIV.VolumeViz.Readers
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 10.12.3.0 (10.12.3.0)

Syntax

C++

Copy

public class SoVRVoxFileReader : SoVolumeReader

Public Class SoVRVoxFileReader
	Inherits SoVolumeReader

public ref class SoVRVoxFileReader : public SoVolumeReader

type SoVRVoxFileReader =  
    class
        inherit SoVolumeReader
    end

The SoVRVoxFileReader type exposes the following members.

Constructors

	Name	Description
	SoVRVoxFileReader	Constructor.

Top

Methods

	Name	Description
	CloseAllHandles	Close all file handles currently opened by the reader. (Inherited from SoVolumeReader.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetBorderFlag	Returns border flag if stored in file. (Inherited from SoVolumeReader.)
	GetConfiguredWriter	Returns a writer that correspond to this reader (same format, same parameters, etc...). (Inherited from SoVolumeReader.)
	GetDataChar	(Overrides SoVolumeReaderGetDataChar(SbBox3f, SoDataSetDataTypes, SbVec3i32).)
	GetDirectCoordSys	Return whether the coordinate system used is direct or not. (Inherited from SoVolumeReader.)
	GetDirectCoordSysAutoDetection	Return automatic detection value. (Inherited from SoVolumeReader.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetHistogram	Returns histogram if stored in file. (Inherited from SoVolumeReader.)
	GetMinMax(Double, Double)	Returns min max if stored in file for float data type (Inherited from SoVolumeReader.)
	GetMinMax(Int32, Int32)	Returns min max if stored in file (obsolete) (Inherited from SoVolumeReader.)
	GetMinMax(Int64, Int64)	Returns min max if stored in file for integer data type (Inherited from SoVolumeReader.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNumSignificantBits	This method is optional. It returns the number of significant bits of the volume data. (Inherited from SoVolumeReader.)
	GetOriginalFilename	Returns original file name from which the data has been converted to LDM format if stored in file. (Inherited from SoVolumeReader.)
	GetReaderType	Returns type of reader. (Inherited from SoVolumeReader.)
	GetStringName	(Inherited from SoBase.)
	GetSubSlice	Method required by VolumeViz 3.0. Must copy the rectangular part defined by subSlice of the XY slice sliceNumber to the memory pointed to by data. Slices will not always be read sequentially. (Inherited from SoVolumeReader.)
	GetTileMinMax	Returns the minimum and maximum data values for the given tile. Used only if data is organized for the LDM module. It allows to profit of optimizations such as SoLDMGlobalResourceParameters.setIgnoreFullyTransparentTiles(). Default implementation return new SbVec2d(System.Double.MaxValue, -System.Double.MaxValue)) (Inherited from SoVolumeReader.)
	GetTileSize	Returns tile size if using data stored in tiles. Return FALSE if data is not stored in tiles. (Inherited from SoVolumeReader.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	ReadTile(Int32, SbBox3i32)	Given an index, reads a tile if the data is organized in tiles (for LDM). (Inherited from SoVolumeReader.)
	ReadTile(Int32, SbNativeArrayByte, SbBox3i32)	Obsolete. Given an index, reads a tile if the data is organized in tiles (for LDM). In the default LDM architecture, the LDM data is based on an octree topology (see SoVRLdmFileReader). The index passed is 0 for the tile of lowest resolution representing the entire volume (octree root node). The index increments linearly going down through the octree. (Inherited from SoVolumeReader.)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetDirectCoordSysAutoDetection	Sets whether or not the reader should automatically try to detect if the coordinate system used is direct or not. The function will return FALSE if the feature is not supported by the current reader. Default is false. (Inherited from SoVolumeReader.)
	SetDirectCoorSys	Specify if the coordinate system used is direct or not. The function will return FALSE if the feature is not supported by the current reader. Default is false. (Inherited from SoVolumeReader.)
	SetFilename	Specifies the path of the file. Returns 0 for success. Any other return value indicates failure. (Inherited from SoVolumeReader.)
	SetName	(Inherited from SoBase.)
	SetOutputDataType	Sets the output data type. Returns FALSE if the reader does not support this feature. (Inherited from SoVolumeReader.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	SetUserData	Stores the userData (for example the filename string) in the m_data protected variable. (Inherited from SoVolumeReader.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoBase.)

Top

Properties

	Name	Description
	DataConverted	The returned boolean indicates if the data is already organized for the LDM module. If TRUE, VolumeViz will use the readTile method. (Inherited from SoVolumeReader.)
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	IsThreadSafe	Let the system know if the reader is thread safe or not. this function is called by VolumeViz when using the multiIO mode. (Inherited from SoVolumeReader.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

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.

Reference

OIV.VolumeViz.Readers Namespace