View source for TeemSummary

== Description ==

Teem is a collection of libraries for representing, processing, and inspecting scientific raster data, as well as command-line tools that are built on top of the libraries. VTK and ITK have overlapping and much broader functionality; the utility of Teem is that its low-level functions can be directly and easily called with minimal overhead for getting data in and out, and its command-line tools allow useful work to get done without writing any code.

== Role in NAMIC ==

Teem is now included as part of Slicer, for the NRRD file format, as well as diffusion tensor processing. The "NrrdIO" stand-alone library for NRRD file support is included in ITK.

== Typical Usage ==

There are three ways that Teem is used in NAMIC:

# The NRRD file format is used for [[NAMIC_Wiki:DTI:Nrrd_format|DWI datasets ]], and can be read/written with Teem, as well as with Slicer or ITK.
# Command-line utilities included with Teem have proven effective for data pre-processing and inspection, for example with [[NAMIC_Wiki:DTI:TeemExamples|DWI data processing]].
#* "unu" is for low-level raster data processing (slicing, projecting, axis permuting, resampling, colormapping, simple arithmetic, etc.).
#* "tend" is for diffusion tensor processing (eddy current correction, tensor estimation, anisotropy metrics, eigensolutions).
# The '''Nrrd''' and '''Ten''' libraries (underlying "unu" and "tend", respectively) allow all the same operations to be done via simple and stable APIs. For example, <tt>tenEigensolve_d()</tt> computes eigenvalues/eigenvectors of diffusion tensors. Also, the '''Gage''' library supports convolution-based point-sampling of 3D fields (scalar, vector, tensor), for measuring values, gradients, hessians, curvature, tensor eigenvectors, and more.

== Languages ==

Teem is written entirely in C.

== Platforms ==

Since it's written in C, Teem is extremely portable. For example, the NrrdIO library extracted from Teem builds on all the platforms included in the [[http://www.itk.org/Testing/Dashboard/MostRecentResults-Nightly/Dashboard.html ITK dashboard]].

== Software Dependencies ==

Teem uses [http://www.cmake.org CMake] to build. Teem requires no external libraries other than the system's C math library, although it can optionally take advantage of the Gzip, Bzip2, PNG, and pthread libraries.

== Documentation, Tutorials and Examples ==

The [[http://teem.sourceforge.net/ Teem homepage]] includes links to some documentation which is continually under construction, including a [[http://teem.sourceforge.net/nrrd/demo.html collection of Nrrd/unu usage examples]]. More NAMIC-specific documentation is currently being developed.

== File Formats Supported ==

The Nrrd library can read and write PPM, PNG, and NRRD files (with raw, gzip, bzip2, or ascii data encoding), as well as basic support for VTK structured point files. Also, provided the file includes a raw data segment, NRRD headers can be wrapped around GE Signa, DICOM, Meta, and various other formats.

== Revision Control ==

Teem is currently managed via CVS at Sourceforge. Whether to stick with Sourceforge will be determined by how smoothly their [[http://sourceforge.net/docman/display_doc.php?group_id=1&docid=19242#january-2006 SVN transition goes]] in the next few months.

Teem Version 1.9.0 is included with Slicer. This version, as well as previous versions, can be [http://sourceforge.net/project/showfiles.php?group_id=85445 downloaded from Sourceforge].

A nearly up-to-date checkout can be obtained via:

 cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/teem login
 (hit return)
 cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/teem co teem

Unfortunately, the non-authenticated checkout lags by about 10 hours. If you have developer access (contact Gordon for this), you can

 cvs -d:ext:USERNAME@cvs.sourceforge.net:/cvsroot/teem co teem

Also, the source can also be viewed via [[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/teem/teem/ ViewCVS]].

== Size of Community ==

There about 40 subscribers to the [http://lists.sourceforge.net/lists/listinfo/teem-users teem-users mailing list], and there have been about [http://sourceforge.net/project/showfiles.php?group_id=85445#files 2500 downloads]. Teem's wider usage, however, includes its part in [http://software.sci.utah.edu/scirun.html SCIRun] and Slicer, wherein end-users generally don't know when Teem functions are being called.

== License ==

Teem uses a [http://teem.sourceforge.net/tree/src/LICENSE.txt modified LGPL] (Library/Lesser General Public License). This follows the example of [http://www.fltk.org/COPYING.php FLTK] in adding exceptions to the LGPL so that static linking is made practical, and is such is compatible with NA-MIC licensing guidelines.