| SoVRLdmFileReader Class |
LDM file reader.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.LDM.ReadersSoVolumeReader
OIV.LDM.ReadersSoLDMReader
OIV.LDM.ReadersSoVRLdmFileReader
OIV.LDM.ReadersSoVRLdmFileBorderReader
Namespace: OIV.LDM.Readers
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoVRLdmFileReader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVRLdmFileReader | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| CloseAllHandles | Close all resources that are locked by the reader. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| 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). |
| 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. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetBbox | Returns the bounding box of the data associated with the specified file ID. |
| GetBorderFlag | Obsolete. Returns the border flag. |
| GetCenter | Returns the center of the data associated with the specified file ID. |
| GetConfiguredWriter | (Inherited from SoLDMReader.) |
| GetCoordinateType | Returns coordinate type used by the data set. |
| GetDataChar | Gets the characteristics (file header) of the data volume. |
| GetDimension | Returns the dimension of the data. |
| GetDirectCoordSys | Return whether the coordinate system used is direct or not. |
| GetDirectCoordSysAutoDetection | Return automatic detection value. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetFilename | Returns the path of the file. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetHistogram(Queue) | Obsolete.
Returns histogram if stored in file.
(Inherited from SoVolumeReader.) |
| GetHistogram(IListInt64) | Returns the distribution of data values, i.e., the number of voxels per data value. |
| GetMinMax(Double, Double) | Returns the minimum and maximum data values (for float values). |
| GetMinMax(Int32, Int32) | Obsolete. (Overrides SoLDMReaderGetMinMax(Int32, Int32).) |
| GetMinMax(Int64, Int64) | Returns the minimum and maximum data values. |
| GetName | Returns the name of an instance. |
| GetNumSignificantBits | Returns the number of significant bits. |
| GetNumVoxels | Utility function provided by OIV.LDM.Readers.SoVolumeReader for subclass readers to call. |
| GetOriginalFilename | Returns original file name from which the data has been converted to LDM format if stored in file. |
| GetReaderType | Returns the reader type. |
| GetRectilinearCoordinates | Returns the coordinates for the specified axis. |
| GetSize | Returns the bounding box of the total data in world coordinates. |
| GetSizeToAllocate | Utility function provided by OIV.LDM.Readers.SoVolumeReader for subclass readers to call. |
| GetStringName | (Inherited from SoBase.) |
| GetSubSlice(SbBox2i32, Int32, SoBufferObject) | Same as OIV.LDM.Readers.SoVolumeReader.GetSubSlice(OIV.Inventor.SbBox2i32, System.Int32, OIV.Inventor.Generic.SbNativeArray{{System.Byte}}) but using an OIV.Inventor.Devices.SoBufferObject as the target of the data. |
| GetSubSlice(SbBox2i32, Int32, SbNativeArrayByte) | Obsolete. (Overrides SoLDMReaderGetSubSlice(SbBox2i32, Int32, SbNativeArrayByte).) |
| GetTileMinMax | Returns the minimum and maximum data values for the given tile. |
| GetTileSize | Returns the size of a data tile. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetXmlTag | Gets the first occurrence of the XML element whose tag name is specified by tagName. |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsIgnoredFile | Should return true if at least one file has been ignored during reading. |
| IsLittleEndian | Returns whether the bytes of the data are stored in big or little endian order. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| ReadTile(Int32, SbBox3i32) | Given an index, reads a tile if the data is organized in tiles (for LDM). |
| ReadTile(Int32, SbNativeArrayByte, SbBox3i32) | Obsolete. (Inherited from SoLDMReader.) |
| ReadTile(Int32, SoBufferObject, SbBox3i32) | Obsolete. Same as OIV.LDM.Readers.SoVolumeReader.ReadTile(System.Int32, OIV.Inventor.Generic.SbNativeArray{{System.Byte}}, OIV.Inventor.SbBox3i32) but using an OIV.Inventor.Devices.SoBufferObject (allocated by LDM) as the target of the data. |
| ReadXSliceInTile | Read directly from the LDM data source, an orthoslice on the X axis inside a tile. |
| ReadXTraceInTile | Read directly from the LDM data source, a trace inside a tile. |
| ReadYSliceInTile | Read directly from the LDM data source, an orthoslice on the Y axis inside a tile. |
| ReadZSliceInTile | Read directly from the LDM data source, an orthoslice on the Z axis inside a tile. |
| ReloadTileMinMax | (Inherited from SoVolumeReader.) |
| RestoreAllHandles | Restore resources that were closed by OIV.LDM.Readers.SoVolumeReader.CloseAllHandles(). |
| 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. |
| SetDirectCoordSysAutoDetection | Sets whether or not the reader should automatically try to detect if the coordinate system used is direct or not. |
| SetDirectCoorSys | Specify if the coordinate system used is direct or not. |
| SetFilename | Specifies the path of the file. |
| SetInputDataRange | Requests that the input be converted from the specified range to the range depending on the output data type. |
| SetName | (Inherited from SoBase.) |
| SetOutputDataType | Sets the output data type. |
| SetRectilinearCoordinates | Sets rectilinear coordinates for the data set. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| SetUserData | Obsolete.
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. |
Properties| Name | Description | |
|---|---|---|
 | DataConverted |
true if the data is already organized in tiles for the LDM module.
In other words, all drivers that directly support the GetTile() method should
set DataConverted to true.
If true, VolumeViz will use the ReadTile method and will NOT call GetSubSlice().
(Inherited from SoVolumeReader.) |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| IsRGBA | Returns true if the data set contains RGBA color values. |
| IsThreadSafe | Return true as this reader is thread safe. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksLDM is a format for storing hierarchical multi-resolution volume data, defined by VSG. VolumeViz includes a utility program that can convert other formats (supported by VolumeViz) into this format. Preprocessing volume data into this format provides the maximum benefits from the VolumeViz large data management (LDM) features.
The default VolumeViz LDM file format is based on an octree topology. The data is stored in tiles of different subsampling resolution.
The first tile in the file represents the entire volume at its lowest resolution and corresponds to the root of the octree. The next 8 tiles represent octants of the entire volume at a lower subsample step. There is another set of 8 tiles for each of these tiles, and so on, until reaching tiles of full resolution.
The tile index starts at 0 for the root and increments linearly into the octree (1 to 8 for octree children, 9 to 16 for children of tile 1, and so on).
The data of a tile is accessed with the OIV.LDM.Readers.SoLDMReader.ReadTile(System.Int32, OIV.Inventor.SbBox3i32) function by passing an index and allocated buffer.
See Also