TeraRecon, Inc. Real Time Visualization June-19-2001 ======================= This document provides the information needed to install the VolumePro500 V2.10 software on to a Windows 2000 system. You must be "administrator" to install the software. This version of VolumePro 500 software comes as 2 separate installations. 1) VolumePro 500 driver - This will install driver and the library to your system. Follow the install instructions below. 2) VolumePro 500 Software Development Kit. (SDK) - This will install the sample application Revli, GfxSanity, sample datasets, documentation and other example files for software development with VolumePro 500. Double click CD\Windows_SDK\setup.exe SYSTEM REQUIREMENTS ==================== The following are the Windows 2000 minimum hardware and software requirements: * Windows 2000, Service Pack 1 or later * Pentium III or better processor * Minimum of 256Mb RAM memory * Minimum of 10 MB free disk space to install the VolumePro 500 software * 3D Graphics Accelerator Cards Compatible with VolumePro 500 (http://support.rtviz.com/support/documents/VolumePro 500 Release Notes) CHANGES IN THIS SOFTWARE ======================== 1. New settings for SW. (See SETTINGS below.) 2. Fixed bugs listed at the end of this document. 3. New file save, Threaded, and 7th point features are added. (See NEW FEATURES below.) 4. Serial number requires installing the SDK software. The serial number is "Real_SDK1" (Without the quotes). INSTALLING THE VOLUMEPRO 500 BOARD =================================== Turn the system power off and install the VolumePro board directly into the PCI slot. INSTALLING VOLUMEPRO SOFTWARE and the driver ============================================= 1. The VolumePro 500 board installed into the PCI slot. 2. Start your computer. 3. When New Hardware Wizard dialogs comes up. i) Next. ii) Select Search then Next. iii) Select 'CD ROM' and hit Next. iv) select vg500.inf and hit Next. v) follow the remaining prompts to install vgb.sys. vi) if only one VolumePro installed, Reboot vii) if more then one VolumePro installed DO NOT Reboot, repeat i) to v) for each VolumePro board installed, then Reboot 4. To install Software Development Kit, insert CD to CD-ROM drive, in Windows Explorer, navigate to your CD drive to \SDK double click setup.exe. The serial number is "Real_SDK1" (Without the quotes) It is not necessary to reboot after SDK software installation finishes. IF UPDATING FROM NT DRIVER TO 2000 DRIVER ========================================= 1. If you have NT VolumePro 500 Driver installed on your system, uninstall old version of the software. Go to Control Panel, Add/Remove Programs, select VolumePro click on Change/Remove button. Select Remove in Maintenance dialog. 2. Go to the device manager: i) Right click on the My Computer icon on the desktop. Select properties. ii) Select the Hardware tab. iii) Click on Device Manager. 3. Locate the 'Other device' under 'Multi media controller.' This will likely have a yellow exclamation point on it. Right click on it and select uninstall. Follow any prompts. 4. Reboot. 5. At boot you will be prompted to install a new device: i) Next. ii) Select Search then Next. iii) Select 'CD ROM' and hit Next. iv) select vg500.inf and hit Next. v) Follow the remaining prompts to install vgb.sys. vi) Select NO to Reboot, repeat i) to v) for the number of VolumePro board installed on your machine. 6. To install Software Development Kit, insert CD to CD-ROM drive, in Windows Explorer, navigate to your CD drive, double click setup.exe. It is not necessary to reboot after this installation finished. IF UPDATING WINDOWS 2000 DRIVER ========================================= 1) Insert CD. 2) Update drivers: i) right mouse click on 'My computer' icon on the Desktop ii) choose 'Properties' iii) choose ' Hardware' tab iv) click 'Device manager' button v) locate the 'VolumeProNet' under 'Sound,video and game controller' vi) right mouse click on the driver and choose 'Properties' vii) choose 'Driver' tab viii) click 'Update Driver' button ix) when New Hardware Wizard dialogs comes up: - Next. - Select Search then Next. - Select 'CD ROM' and hit Next. - select vg500.inf (in CD\W2K folder) and hit Next. - In the dialog "Driver Files Search Results" choose "Install one of the other drivers" option hit Next. - dialog "Driver files found" comes up with list of .inf files. - choose *.inf file with the latest date. - follow the remaining prompts to install vgb.sys. x) Reboot SETTINGS ========== 1. Change Max Angle Deviation settings Start>run...>regedt32>HKEY_LOCAL_MACHINE SOFTWARE > RTViz> VolumePro500> DEFAULT_MAX_ANGLE_BEHAVIOR in right pane. Change the value 0 and 1. If the value is 0, VLI will return kVLIErrMaxAngleDeviation error (VLI 2.0 behavior). If the value is 1, VLI will adjust the value of the angle to avoid the Max Angle Deviation. (VLI 1.2 behavior). Note: Max Angle settings also controllable from Revli or GfxSanity. See New Features below. 2. Set True size False to get better performance Start>run...>regedt32>HKEY_LOCAL_MACHINE SOFTWARE > RTViz> VolumePro500> true_size in right pain. set the value false = 00 (Performance get faster, VLI 1.2 behavior). This setting allows VLI to skip rendering small and very small sub-volumes of a large volume when rendering. When the large volume is split into sub-volumes for rendering, sub-volumes with one or more dimensions less than 32 voxels will be skipped. For example, a 512x512x512 volume will be rendered as eight 256x256x256 sub-volumes, with subvolumes with sizes of 256x256x6, 256x6x6 and 6x6x6 skipped. (This curious arithmetic is caused by the requirement of a three voxel overlap when splitting a volume into sub-volumes.) set the value true = 01 (Default setting, VLI 2.0 behavior). This setting asks VLI to render the full size of the volume, even when this requires rendering a number of small and very small sub-volumes. VLItrue_size only makes a difference when one or more dimensions of the volume are greater than 509. LIST OF THE FIXED BUGS ======================= 1. Previous version requires to be the "administrator" to run Revli or GfxSanity. To be "administrator" is not the requirement to use Applications with this version. 2. Opacity issue Opacity correction for Super sampling is fixed. 3. Lighting did not follow the volume rotation with Emissive 0. Lighting direction is now corrected to follow the camera. 4. Memory leak issues The Memory leaks in VLI are corrected. 5. Large Volume Load Software changed to load volume over 512x512x512~. 6. Performance improvement. 7. Revli, Animate Cut Plane distance problem corrected. 9. GfxSanity menu item changed. Remove routines associated with printing. Remove VLI Options for render done callbacks. Add VLI Options: "Use true size" and "Allow slight adjustment to size". These set "MaxIgnoredVoxels" to 0 and 31 respectively. 10. Revli menu item changed. Remove routines associated with printing. NEW FEATURES ============ 1. New VolumePro library and driver installed by vg500.inf file. 2. Driver Kernel memory allocation increased from 16MB to 32MB. 3. Revli, File save as XXXX.clut file also saves XXXX.set file "File->Save As...", this version of Revli will save a .set file in addition to the .clut file. (Note: Must use same file name as .vox file.) Any volume, which has a .set file with the same base file name as the .vox file, will save the following settings: Box Crop (min and max for X,Y, and Z). Window and Level Lights On/Off: TopLeft, BottomLeft, TopRight, BottomRight, HeadLight. Lighting Slider Positions: Intensity, Contrast, Diffuse, Specular, Emissive, Shininess Modulate Opacity On/Off Modulate Lighting On/Off 3. VLIThreaded control (see Threaded_Render.txt in CD\Docs or our web site). Threaded Render control from Options menu in Revli or VLIOptions in GfxSanity. 4. 7th point feature (see 7th_point.txt in CD/Docs). 5. Max Angle Behavior on and off switch. The switch to select either display next possible lender angle or return error. Max Angle settings controlled from Options Menu in Revli or VLIOptions in GfxSanity. The menu selection over rides the Registry setting. 6. Windows Software Postwarp using the VLIPlus library. (This library is not included in the CD. The package is available from our download site: http://support.rtviz.com/support/VolumePro Post Warp Software and Instructions. 7. VLItrue_size on and off swith. Now you can set VLItrue size values. (See SETTINGS above) KNOWN ISSUES / LIMITATIONS ========================== 1. User Guide / documentation are not updated with the latest version. NOTES ===== 1. REGISTRY KEYS ================ Our immediate customers may want to choose registry values different than the defaults to ensure the best operation of their product. We do not anticipate the final end user adjusting these registry values.They are under the hive HKEY_LOCAL_MACHINE/System/CurrentControlSet/Services/vgb/parameters. The keys are: KernelMemoryMB DWORD This key tells the device driver how much contiguous kernel memory to allocate when it starts up, in units of MB. The default value that we install is 16MB. This contiguous kernel memory is used for loading volumes into the VP500, and for holding the rendered texture maps. LogFileName String This key gives the name of a text file that the device driver may write logging information to. "IMPORTANT: LogFileName must be on the same file system type as Windows. \SystemRoot\vg500log.txt will always log to the windows boot directory. Use a fully qualified DOS filename to log to a specific drive, i.e. c:\vg500log.txt." name to log to a specific drive, i.e. c:\vg500log.txt." 2. HANG DURING BOOT =================== Some system BIOSes have a bug that can cause the system to hard hang as it switches into hi-resolution mode during boot. The screen would blank as normal but never recover. To date this problem has been noted only on SGI 550 Visual Workstations, although it may apply to other BIOSes. To overcome this, enable the jumper on the VolumePro 500 board. This will then allow the boot to continue normally. Note with this jumper(Jumper J1 - related document in VolumePro 500 User's Guide Chapter2, 2-5) enabled itis not possible for an application to directly map voxel memory. This is a system BIOS bug relating to PCI configuration and is beyond our control. Please let us know if you see this behavior on machines other than the SGI 550. 3. DRIVERS REFUSES TO LOAD ========================== Some system BIOSes have a 'feature' to disable PCI bus mastering and may ship with that as the default. The VolumePro 500 requires bus mastering and can not function with this disabled. If this situation is detected the driver will refuse to load and log an error. To determine if this problem exists, look for the driver log file (typically c:\vp500log.txt or c:\winnt\vp500log.txt.) If it exists and contains the line: Bus Mastering for this device is disabled. The VP500 can not run without this. If this error is found, look in the system BIOS for a PCI bus mastering option. Enable it for at least the slot the VolumePro 500 is in. If no BIOS option is found, you can try setting the registry flag: HKLM\\SYSTEM\CurrentControlSet\Services\vgb\Parameters\PCICommandOverride to 1 and rebooting. Note that this should be used with care since it is overriding the BIOS settings and should be avoided in a production environment. This problem has been seen on HP Kayak machines as well as some older Dell models.