******************************************************
******************************************************
LONI Brain Analysis Package (LBAP) v5.1 , 2004

README file for LBAP
******************************************************
******************************************************

This file contains important information for users of LBAP.
The first three sections (Requirements, Installation, and Running
LBAP) are of interest to all LBAP users.
The rest of this file applies only to developers of LBAP
applications.

** It is recommended that any previous version of LBAP be
** uninstalled before installing this version.

============
REQUIREMENTS
============

This version of LBAP for Windows 98/2000/XP and Unix/Linux
requires the following:

- Java 2 (Runtime or SDK) version 1.3.1 or later from Sun Microsystems 		(http://java.sun.com/j2se/index.jsp).  

- Java 3D(TM) version 1.3.1 from Sun Microsystems 		(http://java.sun.com/products/java-media/3D/)
        
	
============
INSTALLATION
============

Just unzip the zip file into one of your directory. In windows, LBAP does not update your registry, so if you want to uninstall it, just delete all the directories and files that correspond to LBAP. Follow the same procedure for unix/linux.


================
RUNNING LBAP
================
For windows, create a batch file, like the run.bat provided.
For unix/linux, create an executable shell file to run it, like the one provided (written for the c shell). 

LBAP can load img files representing 2D brain slices that will preferrably be zipped, since they take up a lot of space. These img filenames should be explicitly given in the batch file after invoking edu.ucla.loni.LOVE.LOVE (LOVE stands for LONI Visualization Environment, an older name for this software package). After the filename, the user should write the minimum and maximum dimensions for x, y and z and then the subsampling ratios in the three dimensions, a total of 9 numbers. These img files can be other read as 8 bits/pixel(e.g. MAP_Nissl.img.gz), 16 bits/pixel (e.g. MAP_Labels.img.gz) or 24 bits/pixel (e.g. mapBlock_rgb.img.gz). The LONI header file specifies information regarding this parameter, as well as parameters like modality, x,y and z dimensions, steps and start points. 

However, all the above images are static images, independent of time. If someone wants to load an img file representing the development of a brain through time, i.e. an fMRI image (e.g. 4D_SD_FLICKER_A.img.gz), he/she should clarify the fMRI modality in the *.lhd file. Note that the img 16-bit file which will represent the labels of the nodes of the hypergraph should have the string "Labels" somewhere in its filename (e.g.: MAP_Labels, Mouse_Labels_2003, etc.). Correspondingly, the img file which will represent the 2D textured slice in the 3D world, should have the string "MRI" somewhere in its filename (e.g: Mouse_MRI_2003, MAP_MRI, etc.). 

Now, if someone wants to load lightwave objects on the 3D world, he/she should provide their names in the batch file, preceding them with -lws (e.g: -lws BR.lws). The same principle applies for dxf objects, only that now their filenames should be preceded with -dxf (e.g. -dxf BR.dxf). 

The gml file that the hypergraph needs as its input, should be a tree and not a graph with loops. You should precede its name with -graph in the batch file (e.g. -graph MAP_BrainGraph.gml).


=====================
CONTRIBUTING TO LBAP
=====================
For code development and the implementation of several plugins to LBAP, please follow closely its API. For questions on code, style to follow, email: baecheol.shin@loni.ucla.edu.


==============
BUGS, FAQ
==============
- Background becomes black in Java3D Canvas.
- Two dialog instances on the hypergraph. 

If you discover any bugs, please email baecheol.shin@loni.ucla.edu



