neurolabusc / surf-ice

GLSL surface rendering source code. Compiled versions available from NITRC. Loads 3DS, CTM, DXF, FreeSurfer, GII (GIfTI), GTS, LWO2, MS3D, MZ3, NV (BrainNetViewer), OBJ, OFF, PLY, STL, VTK. Tractography formats include BFloat, PDB, TCK, TRK, and VTK. Also NIfTI format voxelwise images.

Surf Ice

About

Surf Ice is an open source surface render. It can be compiled for the Linux, Macintosh OSX, and Windows operating systems. For details and compiled versions visit the NITRC wiki. You can also get a compiled version from the Github releases page.

Supported mesh formats include 3DO, 3DS, AC, BYU, CTM, DAE, DXF, FreeSurfer, GII (GIfTI), GTS, LWO2, MS3D, MZ3, NV (BrainNetViewer), OBJ, OFF, PLY, PLY2, STL, VTK, WFR. Online converters can convert meshes from other formats to one of these. Tractography formats include BFloat, PDB, TCK, TRK, and VTK. Supported volume formats include those supported by i2nii: AFNI Brik(.head), Analyze(.hdr), Bio-Rad PIC(.pic), Blender Voxel data(.bvox), BrainVoyager VMR(.vmr, .v16), DeltaVision(.dv), ECAT(.v), FreeSurfer MGH/MGZ Volume(.mgh/.mgz), Guys Image Processing Lab(.gipl), ICS Image Cytometry Standard(.ics), Interfile(.varies, limited support), ITK MHA/MHD(.mha/.mhd), MRTrix Volume(.mif/.mih; not all variants supported), NIfTI(.hdr/.nii/.nii.gz/.voi), NRRD(.nhdr/.nrrd), POV-Ray Density_File(.df3), Spectroscopic Imaging, Visualization and Computing (SIVIC)(.idf), Stimulate Sdt(.spr/.sdt), Vaa3D(.v3draw), VTK Legacy Voxel Format(.vtk). Tools like dcm2niix can help convert voxel-based DICOM images to NIfTI.

Installing

Compiled releases are provided for Linux, MacOS and Windows.

You can get MRIcroGL using three methods:

• Download from NITRC.
• Download from Github.
• Run the following command to get the latest version for Linux, Macintosh or Windows:
  • curl -fLO https://github.com/neurolabusc/surf-ice/releases/latest/download/surfice_linux.zip
  • curl -fLO https://github.com/neurolabusc/surf-ice/releases/latest/download/surfice_macOS.dmg
  • curl -fLO https://github.com/neurolabusc/surf-ice/releases/latest/download/surfice_windows.zip

The Windows and Linux releases includes two versions of Surf Ice: "Surfice" requires OpenGL 3.3 or later, while "SurficeOld" runs on older computers (requiring OpenGL 2.1). A wiki provides a full manual and troubleshooting advice.

Compiling

This project is built using the open source FreePascal Lazarus compiler and integrated development environment. You will need to have the LazOpenGLContext package installed. To do this, launch the Lazarus application and choose Packages/InstallPackages. You will want to select these two packages from the "Available for installation" list. Finally, click the "Save and rebuild" button. Once these are installed, you can load this package and compile it using the Run/Run menu option.

The software allows Python Scripting. By default, it will use PythonBridge with all the required files included.

Alternatively, the surfice_py4laz project usesPython-for-Lazarus package. While PythonBridge statitcally links Python for macOS and Linux, Python-For-Lazarus leverages an existing installation (both use dynamic linked libraries for Windows). Unfortunately, the recent releases no longer support to legacy Python 2.7. If you want to support both Python 2.7 and modern Python 3.x, you will need to install a special version of this package. You may have to comment out the line {$DEFINE PY27} in the opts.inc file unless you use this special version. Once you download the package, you can install it in the same way as LazOpenGLContext (described above). Alternatively, if you do not want to enable Python, edit the opts.inc file by removing the line {$DEFINE MYPY}.

You can also edit your opts.inc file to build either of the flavors of Surfice. Uncomment the line {$DEFINE COREGL} for OpenGL 3.3 Core specification, or comment the line //{$DEFINE COREGL} for OpenGL 2.1.

You can also add the required packages from the command line:

lazbuild --verbose-pkgsearch lazopenglcontext
if [ $? -eq 0 ]
then
    echo "required packages already installed"
else
    echo "installing packages"
    lazbuild --add-package lazopenglcontext --build-ide=
fi
if [[ "$OSTYPE" == "darwin"* ]]; then
	echo "macOS compiling for Cocoa, instead of default Carbon widgetset"
	lazbuild  -B --ws=cocoa ./simplelaz.lpr
else
	lazbuild -B ./simplelaz.lpi
fi

You can also build this project from the command line (assuming you have FPC Lazarus and the required packages installed):

 lazbuild surfice.lpr

Versions

The releases page provides version notes.

License

This software includes a BSD license