Package documentation:
User Manual (PDF)- A quick introduction to the XRaySim package. This document will helpyou get up and running within minutes and also walk you through gettingyour first scan out of XRaySim. Some of the advanced features are leftout for brevity's sake. The basic interface is explained, along with asimple example.Material script essentials (PDF) - Thisdocument lays down the fundamentals of the material scripting languageand describes how the system can be extended for use with custommaterials. The scripting system uses the fantastic Boost.Spirit parserframework.
Pre-compiled binaries:
Currently,pre-compiled binaries are provided for Microsoft Windows only. Theyhave been tested on Vista (32-bit) and XP (32-bit and 64-bit). Windows7 support is not guaranteed, though there is no reason why thesebinaries shouldn't work. In case of any trouble, please recompile thecode from scratch using the instructions in the sections below.The Windows versions were compiled using the Microsoft VC++ 2008 Express compiler and hence need the Microsoft Visual C++ 2008 redistributableto work. Please download and install the package applicable to your OSand CPu architecture. The redistributable files should comepreinstalled on Vista, and on later Service Packs for Windows XP.
Pleaseensure that your video card drivers are upto date. XRaySim needs OpenGL1.5 support to work correctly (for the use of Vertex arrays and VertexBuffer Objects). In the unlikely case that you have a much older card,please follow the configuration instructions below to disable VBOs/vertex arrays.
Compiling from source:
XRaySim depends on the following open-source libraries.FLTK (http://www.fltk.org)- FLTK is a platform-independent windowing system for easily writinguser-interfaces, released under the GNU GPL. XRaySim is written againstFLTK 2.0, which does not have astable release yet. In order toget compile, download a weekly snapshot from the website, or grab thelatest source from the FLTK repository.
Boost.Spirit (http://boost-spirit.com/home)- Boost.Spirit is a small and extremely versatile generic string parserframework. The scripting system controlling XRaySim's material systemuses Boost.Spirit extensively. Luckily, the package needs nocompilation, just get the sources from the website and point your IDE to the location of the headers before compiling.
CImg (http://cimg.sourceforge.net)- CImg is a generic, cross-platform and easy to use image loadinglibrary. It contains one header file (which is already included withthe XRaySim source), so you do not need to download anything extra.XRaySim is pre-configured to use the CImg header included with thesource distribution. In case you need to use a newer version of thelibrary (for implementing some advanced features), download andoverwrite the file in the XRaySim source distribution.
GLEW (http://glew.sourceforge.net)- GLEW is a very useful wrapper for using OpenGL extensions acrossplatforms without headaches. Pre-compiled GLEW libraries are availablefrom the website which need to be linked with the XRaySim source.
Depending on which IDE/ compiler combination you are using, instructions will vary.
Microsoft Windows :XRaySim has been succesfully compiled on Windows using the Visual C++2008 Express and the Visual C++ 2005 Express compilers. It should alsocompile with the MinGW compiler without any hassles. The use of an IDEis optional. The above libraries should be downloaded first. Point yoursearch directories to find the .c** .h and .lib files in them, andcompile the entire source distribution.
Linux/ MacOSX:Unfortunately, no precompiled binaries are available for theseplatforms as of yet. Using the gcc compiler, XRaySim should (ideally)compile on both of these platforms. A linux distribution is currentlyin the works and a MacOSX version should be in the works soon,depending on how early the author canget his hands on a system:-) . If you are interested in helping out with the Linux or Macreleases, please feel free to send the author an email (contactinformation is available at the bottom of this page)
Presentations:
The current version of XRaySim was first showcased at the NDE2009 conference. The slides from the original presentation are available here (PDF).Please note that all of the sub-modules are not open-sourced currently.The reconstruction module is still being used internally, and willhopefully find its way into the next stable release. For a full list ofcurrently available features, please visit the features page.A very brief presentation outlining some of custom developed algorithms is available here (PDF).This outlines the basic idea behind the imaging algorithms and revealssome implementation details. Citations are also provided at the end forfurther information.
