README.md

The X Toolkit: WebGL™ for Scientific Visualization

• XTK is easy, lightweight and fast !
• Native reading of a variety of scientific file formats (see File formats)
  
• Volume rendering, thresholding and cross-sectional slicing of 3d image data
  
• Label maps, color tables and surface overlays are supported, as well as Constructive Solid Geometry
  
• CDash + Google Closure driven build and test system

Demos

Knee Atlas

Fiber Atlas

Aneuriskweb

Brain Atlas

Mindboggle

Slice:Drop

Babybrains

Lessons

	Lesson 00: Hello cube! The most simple XTK lesson displays a white cube.		Lesson 01: Skin the cube and rotate it! This one adds a texture to the cube and activates spinning.
	Lesson 02: Constructive Solid Geometry is fun! Mesh primitives can be combined using boolean operations.		Lesson 03: We need more cubes! One thousand objects are rendered in a single scene.
	Lesson 04: The magic Porsche! This lesson loads a mesh from a .STL file and shows off the magic mode.		Lesson 05: Give me skull, baby! A visualization of a mesh loaded from a .VTK file.
	Lesson 06: Connectivity! Load and render brain fibers from a .TRK file.		Lesson 07: One renderer is not enough! Here multiple 3D renderers are showing the same object with different camera positions.
	Lesson 08: Surf free! Loading freesurfer meshes and brain fibers at the same time.		Lesson 09: Points to Spheres! Point data is loaded from a .VTK file and each point is displayed as a sphere.
	Lesson 10: Slice it! Load a .NRRD single-file DICOM volume and a segmentation mesh from a .VTK file.		Lesson 11: Slice it with colors! This one loads a .NRRD single-file DICOM volume and the corresponding segmentation as a label map colorized using a color lookup-table.
	Lesson 12: Curvature! Here we load a freesurfer mesh (.SMOOTHWM) and different curvature (.CRV) values as an overlay.		Lesson 13: I want 2D! This lesson links three 2D renderers to one 3D renderer and loads a .NRRD single-file DICOM and a label map.
	Lesson 14: Is it a cube? Zoom in to see the particles and some great effects!		Lesson 15: D-I-C-O-M! Here we visualize a brain MR scan read from DICOM files.

Download

       
Get it right here: xtk.js or include it like this:

<script type="text/javascript" src="http://get.goXTK.com/xtk.js"></script>

Example Usage

// create a new 3d renderer
var r = new X.renderer3D();
r.init();
    
// create a mesh from a .vtk file
var skull = new X.mesh();
skull.file = 'skull.vtk';
    
// add the object
r.add(skull);
    
// .. and render it
r.render();

Check out the live version!

API Documentation

The full documentation of the API is available here.

More information...

...is available at Project X, the X Toolkit wiki system.

Need help?

We use http://stackoverflow.com/questions/tagged/xtk for user support. Please ask and tag ([xtk]) your question there!

Contribute?

Yes, please! See the Developer's Heads Up and the X:Future page.

License

Copyright (c) 2012 The X Toolkit Developers <[email protected]>

The X Toolkit (XTK) is licensed under the MIT License: http://www.opensource.org/licenses/mit-license.php

Affiliations and Sponsors