

            LONI / CCB ShapeTools   - SurfaceWarpTools 



The files accompanying this document enable you
to apply the Surface Warp protocol to a set of input data files.
Most of the information in this file, and much more, may be found in the html files
stored in the "Documentation" folder on this cd. These files are a snapshot
of the web pages found at this URL:

    http://www.loni.ucla.edu/twiki/bin/viewauth/CCB/SurfaceWarpProtocol

Please refer to this URL for up to date versions of these files.

   
RUN THE PROTOCOL:
----------------------------

  To run the protcol using the sample data supplied, using the Pipeline:

     1) Copy the "sample" directory to your local data folder.  This is necessary
        because the final output cannot be written to the CD.

     2) Obtain a copy of the LONI Pipeline.  If you have not already done so, 
         the LONI Pipeline workflow application may be downloaded from this web URL:

             http://www.pipeline.loni.ucla.edu

     3) See the  QuickStart guide, Documents/SurfaceWarpProtocolQuickStart.html, 
         for details aboout which Pipeline workflow protocol to choose.
         After starting the Pipeline, you will need to edit the global pipeline
         variable "QUICKSTART_DIR", to let the Pipeline know where you have copied
         the "sample" data.  To do so:

           a) Right click with your mouse on any white space on the Pipeline diagram.
           b) Select "Variables" from the pop-up menu that appears.
           c) Find the line containing the definition of "QUICKSTART_DIR", and
              left - click the variable value (it defaults to 'SurfaceWarpToosl/sample")
              and type in the correct path for your computer.
           d) dismiss the global variable dialog screen by using your computers's 
              window close conventions.

           e) verify that the paths and files are correct by running the Pipeline's
              "Validate" command. Click the "Execute" menu, then choose "Validate"
              If all is well, you will see the text "Validation Complete" appear
              in the lower right hand side of the Pipeline GUI. Errors are reported
              in the "Validation Exceptions" window, whose text is printed in red. 

        The pipeline is now ready to perform the analysis.  Choose "Run" from the "Execute"
        menu. When the analysis is complete, each individual subject directory will 
        contain an ouptut file named "warped_surface.obj"


  To run the protcol using the sample data supplied, on your computer, without the Pipeline:

     1) copy the entire contents of the CD to a local computer disk.
     2) See the  QuickStart guide, Documents/SurfaceWarpProtocolQuickStart.html, 
        for more details on how to run the scripts. You'll need a unix compatible
        'sh' scripting shell, and you will probably need to edit the scripts to your local
        filesystem paths.



CD CONTENTS:
----------------------------
data                -  Data files used in the SurfaceWarpTools protocol. Please leave unchanged.
Documentation       -  Local copies of the SurfaceWarpTools web page documentation.
jars                -  The software that performs the warping protocol.
modules             -  Support modules used by the Pipeline workflows. Please leave unchanged.
sample              -  A small set of sample data, used to illustrate the protocol.
scripts             -  Supporting Unix shell scripts, used to perform the protocol.
workflows           -  The LONI Pipeline workflows that perfrom the warping protcol.


WORKFLOW DESCRIPTIONS:
----------------------------

OctahedralSurfaceWarp_LocalData_Cranium.pipe   - Uses the LONI GRID Pipeline server to warp data stored on
                                                 your local computer, via the Octahedral Surface warp protocol.

OctahedralSurfaceWarp_Cranium.pipe             - Uses the LONI GRID Pipeline server to warp data stored on
                                                 LONI filesystem disks, via the Octahedral Surface warp protocol.

OctahedralSurfaceWarp_Local.pipe               - Uses your local computer to warp warp data stored locally,
                                                 via the Octahedral Surface warp protocol. Note: significant
                                                     computing time will be needed.

DualSurfaceWarp_Cranium.pipe                   - Uses the LONI GRID Pipeline server to warp data stored on 
                                                 LONI filesystem disks, via the dual surface protocol.
   
     
     

Acknowledgements:
----------------------------

The SurfaceWarpTools protocol and it's data analysis applications are the product of 
the LONI / CCB ShapeTools group. Our web pages , describing many other tools, 
are here:  

       http://www.loni.ucla.edu/twiki/bin/view/CCB/ShapeToolLibraryProgram

14 July 2008

