SoLDMReader Class

SoLDMReader Class

Base class for LDM data set readers.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.LDM.ReadersSoVolumeReader
            OIV.LDM.ReadersSoLDMReader
              OIV.LDM.ReadersSoVRLdmFileReader

Namespace: OIV.LDM.Readers
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2024.2.0.0 (2024.2.0)

Syntax

C++

Copy

public class SoLDMReader : SoVolumeReader

Public Class SoLDMReader
	Inherits SoVolumeReader

public ref class SoLDMReader : public SoVolumeReader

type SoLDMReader =  
    class
        inherit SoVolumeReader
    end

The SoLDMReader type exposes the following members.

Constructors

	Name	Description
	SoLDMReader	Constructor.

Top

Methods

	Name	Description
	CloseAllHandles	Close all resources that are locked 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.)
	GetBbox	Returns the bounding box of the data associated with the specified file ID.
	GetBorderFlag	Obsolete. Returns the border flag. (Overrides SoVolumeReaderGetBorderFlag.)
	GetCenter	Returns the center of the data associated with the specified file ID.
	GetConfiguredWriter	(Overrides SoVolumeReaderGetConfiguredWriter.)
	GetCoordinateType	Returns coordinate type used by the data set. (Inherited from SoVolumeReader.)
	GetDataChar	Gets the characteristics (file header) of the data volume. (Overrides SoVolumeReaderGetDataChar(SbBox3f, SoDataSetDataTypes, SbVec3i32).)
	GetDimension	Returns the dimension of the data.
	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.)
	GetFilename	Returns the path of the file. (Inherited from SoVolumeReader.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetHistogram(IListInt64)	Returns the distribution of data values, i.e., the number of voxels per data value. (Overrides SoVolumeReaderGetHistogram(IListInt64).)
	GetHistogram(Queue)	Obsolete. Returns histogram if stored in file. (Inherited from SoVolumeReader.)
	GetMinMax(Double, Double)	Returns the minimum and maximum data values (for float values). (Overrides SoVolumeReaderGetMinMax(Double, Double).)
	GetMinMax(Int32, Int32)	Obsolete. (Overrides SoVolumeReaderGetMinMax(Int32, Int32).)
	GetMinMax(Int64, Int64)	Returns the minimum and maximum data values. (Overrides SoVolumeReaderGetMinMax(Int64, Int64).)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNumSignificantBits	This method is optional. (Inherited from SoVolumeReader.)
	GetNumVoxels	Utility function provided by OIV.LDM.Readers.SoVolumeReader for subclass readers to call. (Inherited from SoVolumeReader.)
	GetOriginalFilename	Returns original file name from which the data has been converted to LDM format if stored in file. (Overrides SoVolumeReaderGetOriginalFilename.)
	GetReaderType	Returns the reader type. (Overrides SoVolumeReaderGetReaderType.)
	GetRectilinearCoordinates	Returns the coordinates for the specified axis. (Inherited from SoVolumeReader.)
	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. (Inherited from SoVolumeReader.)
	GetStringName	(Inherited from SoBase.)
	GetSubSlice(SbBox2i32, Int32, SbNativeArrayByte)	Note: OIV.LDM.Readers.SoLDMReader does not implement this method. (Overrides SoVolumeReaderGetSubSlice(SbBox2i32, Int32, SbNativeArrayByte).)
	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. (Inherited from SoVolumeReader.)
	GetTileMinMax	Returns the minimum and maximum data values for the given tile. (Overrides SoVolumeReaderGetTileMinMax(Int32).)
	GetTileSize	Returns the size of a data tile. (Overrides SoVolumeReaderGetTileSize(SbVec3i32).)
	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. (Inherited from SoFieldContainer.)
	IsIgnoredFile	Should return true if at least one file has been ignored during reading. (Inherited from SoVolumeReader.)
	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. (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). (Overrides SoVolumeReaderReadTile(Int32, SbBox3i32).)
	ReadTile(Int32, SbNativeArrayByte, SbBox3i32)	Obsolete. (Overrides SoVolumeReaderReadTile(Int32, SbNativeArrayByte, SbBox3i32).)
	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. (Inherited from SoVolumeReader.)
	ReadXSliceInTile	Read directly from the LDM data source, an orthoslice on the X axis inside a tile. (Overrides SoVolumeReaderReadXSliceInTile(Int32, SbNativeArrayByte, SbBox3i32, UInt32).)
	ReadXTraceInTile	Read directly from the LDM data source, a trace inside a tile. (Overrides SoVolumeReaderReadXTraceInTile(Int32, SbNativeArrayByte, SbBox3i32, SbVec2i32).)
	ReadYSliceInTile	Read directly from the LDM data source, an orthoslice on the Y axis inside a tile. (Overrides SoVolumeReaderReadYSliceInTile(Int32, SbNativeArrayByte, SbBox3i32, UInt32).)
	ReadZSliceInTile	Read directly from the LDM data source, an orthoslice on the Z axis inside a tile. (Overrides SoVolumeReaderReadZSliceInTile(Int32, SbNativeArrayByte, SbBox3i32, UInt32).)
	ReloadTileMinMax	(Inherited from SoVolumeReader.)
	RestoreAllHandles	Restore resources that were closed by OIV.LDM.Readers.SoVolumeReader.CloseAllHandles(). (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. (Inherited from SoVolumeReader.)
	SetDirectCoorSys	Specify if the coordinate system used is direct or not. (Inherited from SoVolumeReader.)
	SetFilename	Specifies the path of the file. (Inherited from SoVolumeReader.)
	SetInputDataRange	Requests that the input be converted from the specified range to the range depending on the output data type. (Inherited from SoVolumeReader.)
	SetName	(Inherited from SoBase.)
	SetOutputDataType	Sets the output data type. (Inherited from SoVolumeReader.)
	SetRectilinearCoordinates	Sets rectilinear coordinates for the data set. (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	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. (Inherited from SoBase.)

Top

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. (Inherited from SoVolumeReader.)
	IsThreadSafe	Return true as this reader is thread safe. (Overrides SoVolumeReaderIsThreadSafe.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

This is the base class for specific LDM readers.

See OIV.LDM.Readers.SoVRLdmFileReader for a specific implementation.

This class retrieves the XML tags from an LDM header file (usually a .ldm file) that are general to all LDM files, i.e. the tags that are interpreted by VolumeViz.

Custom tags for classes derived from OIV.LDM.Readers.SoLDMReader can be retrieved by overriding the () method.

General tags common for all LDM Readers are:

Copy

<?xml version="1.0" encoding="utf-8" ?>
<VolumeInformation>
 <OriginalFile>3dhead.vol</OriginalFile>
 <Size> //or dimension//
   <U>256</U>
   <V>256</V>
   <W>109</W>
 </Size>
 <TileSize>
   <U>64</U>
   <V>64</V>
   <W>64</W>
 </TileSize>
 <DataType>
    <Type>n</Type><Num>m</Num>
    ...
 <DataType>
 <DataFilename>3DHEAD.dat</DataFilename>//separate datafile//
 <WordFormat>1</WordFormat>//data stored in little/big endian//
 <CompletionFilename>3dhead.fcp</CompletionFilename>//if the conversion was interrupted, refer to this file

 <RectilinearMapping>
  <mapping axis="U">
   <map>-180</map>
   <map>-160</map>
   ... one entry per voxel on U axis
  </mapping>
   ... repeat for V, W axis
 </RectilinearMapping>

Note that the minimum tags that MUST be in the LDM header are <Size> or <Dimension> and <TileSize>. Otherwise the reader will throw a "tag missing" exception.

Reference

OIV.LDM.Readers Namespace