SoVRRasterStackReader Class |
Raster stack reader.
Namespace: OIV.VolumeViz.Readers
The SoVRRasterStackReader type exposes the following members.
Name | Description | |
---|---|---|
SoVRRasterStackReader | Constructor. |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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).
(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. | |
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.
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.) | |
SetDirectory | Specify a directory containing image files to load (jpg, png, tif,...). | |
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.) | |
SetSize | Defines the bounding box size in physical units of the data set. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
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. |
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.) |
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 ....OR
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 ().
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.