SoVRRasterStackReader Class

Raster stack reader.

Inheritance Hierarchy

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

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

Syntax

C++

Copy

public class SoVRRasterStackReader : SoVolumeReader

Public Class SoVRRasterStackReader
	Inherits SoVolumeReader

public ref class SoVRRasterStackReader : public SoVolumeReader

type SoVRRasterStackReader =  
    class
        inherit SoVolumeReader
    end

The SoVRRasterStackReader type exposes the following members.

Constructors

	Name	Description
	SoVRRasterStackReader	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.)
	GetBorderFlag	Obsolete. (Inherited from SoVolumeReader.)
	GetConfiguredWriter	(Inherited from SoVolumeReader.)
	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).)
	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 histogram if available. (Inherited from SoVolumeReader.)
	GetHistogram(Queue)	Obsolete. Returns histogram if stored in file. (Inherited from SoVolumeReader.)
	GetMinMax(Double, Double)	Returns min max for float data type, if available. (Inherited from SoVolumeReader.)
	GetMinMax(Int32, Int32)	Obsolete. (Inherited from SoVolumeReader.)
	GetMinMax(Int64, Int64)	Returns min and max for integer data type, if available. (Inherited from SoVolumeReader.)
	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. (Inherited from SoVolumeReader.)
	GetReaderType	Returns the reader type. (Overrides SoVolumeReaderGetReaderType.)
	GetRectilinearCoordinates	Returns the coordinates for the specified axis. (Inherited from SoVolumeReader.)
	GetSizeToAllocate	Utility function provided by OIV.LDM.Readers.SoVolumeReader for subclass readers to call. (Inherited from SoVolumeReader.)
	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. (Inherited from SoVolumeReader.)
	GetSubSlice(SbBox2i32, Int32, SbNativeArrayByte)	Must copy the rectangular part defined by subSlice of the XY slice sliceNumber to the memory referenced by data. (Overrides SoVolumeReaderGetSubSlice(SbBox2i32, Int32, SbNativeArrayByte).)
	GetTileMinMax	Returns the minimum and maximum data values for the given tile. (Inherited from SoVolumeReader.)
	GetTileSize	Returns tile dimensions in voxels when using data 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.)
	IsIgnoredFile	Should return true if at least one file has been ignored during reading. (Inherited from SoVolumeReader.)
	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, 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.)
	ReadTile(Int32, SbNativeArrayByte, SbBox3i32)	Obsolete. Given an index, reads a tile if the data is organized in tiles (for LDM). (Inherited from SoVolumeReader.)
	ReadXSliceInTile	Read directly from the data source, an orthoslice on the X axis (Zaxis == 0) inside a tile. (Inherited from SoVolumeReader.)
	ReadXTraceInTile	Read directly from the data source, a trace inside a tile. (Inherited from SoVolumeReader.)
	ReadYSliceInTile	Read directly from the data source, an orthoslice on the Y axis (Zaxis == 1) inside a tile. (Inherited from SoVolumeReader.)
	ReadZSliceInTile	Read directly from the data source, an orthoslice on the Z axis (Zaxis == 2) inside a tile. (Inherited from SoVolumeReader.)
	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.)
	SetChannelSelection	Selects channels to be used for data rendering.
	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.)
	SetDirectory	Specify a directory containing image files to load (jpg, png, tif,...).
	SetFilename	Specifies the path of the descriptive (.lst) file. (Overrides SoVolumeReaderSetFilename(String).)
	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.)
	SetSize	Defines the bounding box size in physical units of the data set.
	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. (Overrides SoVolumeReaderIsRGBA.)
	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

Reader for a volume defined by a "stack" of images.

A raster stack is a list of raster images (that is, containing pixels, not vector graphics) of the same size so as to create a voxel volume. This reader uses a descriptive file (.lst) including a header and a list of all the raster image filenames. The file is structured as follows:

 Parameters {
  Raw 0
  Dims 2048 2048 100
  Size 10.000000 10.000000 10.000000 1250.000000 1250.000000 500.000000
  Channel 2
}

C:/tmp/tiff/img00000.tiff
C:/tmp/tiff/img00001.tiff
C:/tmp/tiff/img00002.tiff
C:/tmp/tiff/img00003.tiff
C:/tmp/tiff/img00004.tiff
....

 Parameters {
  Raw 1
  Endianess 1
  HeaderLength 256
  PrimType 0
  Binary 0
  Dims 1024 1024 300
  Size 50.000000 50.000000 50.000000 1050.000000 1050.000000 250.000000
  Channel 1
}

img00000.raw
img00001.raw
img00002.raw
img00003.raw
img00004.raw
....

Header Description

Raw: 0 (formatted data file), 1 (raw data file).
Endianess: 0 (little endian), 1 (big endian) (for raw data only).
HeaderLength: length of header in characters/bytes (for raw data only).
PrimType: See OIV.LDM.Nodes.SoDataSet.DataTypes (for raw data only).
Binary: 0 (ASCII), 1 (binary) (for raw data only).
Dims: height, width, depth in pixels of the stack.
Size: Xmin Ymin Zmin Xmax Ymax Zmax, bounding box of the data set.
Channel: See OIV.VolumeViz.Readers.SoVRRasterStackReader.ChannelSelections.

Images in the list can be of different formats (uses all files formats supported by Open Inventor). VolumeViz can load image data in most common image formats including BMP, DDS, GIF, JPEG, JPEG2000, PNG and TIFF.

If images are different sizes, RD_UNSUPPORTED_DATA_TYPE_ERROR is returned by OIV.VolumeViz.Readers.SoVRRasterStackReader.GetDataChar(OIV.Inventor.SbBox3f@, OIV.LDM.Nodes.SoDataSet.DataTypes@, OIV.Inventor.SbVec3i32@).

The file path can be relative or absolute.

It is mandatory to have a line break after each property and/or filename otherwise VolumeViz could be unable to read the file properly.

Reference

OIV.VolumeViz.Readers Namespace