Unix Instructions

  1. Binary download the archive to the directory you want BeamLab to reside
  2. Uncompress the archive: 
        unzip BeamLab200PR2.zip
  3. Decide where you want the BeamLab directory to reside. It will have
    a number of subdirectories and occupy at least 10 MB disk space.
  4. After you de-tar the file for your machine, you should have the
    following directory structure:

    BeamLab200
    BeamLab200/Beamlets
    BeamLab200/Beamlets/Beamlet2D
    BeamLab200/Beamlets/Beamlet3D
    BeamLab200/CurvPublish
    BeamLab200/Datasets
    BeamLab200/Documentation
    BeamLab200/MexSource
    BeamLab200/Papers
    BeamLab200/Papers/BL3d
    BeamLab200/Papers/BMIA
    BeamLab200/Papers/DCRT
    BeamLab200/Papers/DRT
    BeamLab200/Papers/FSS
    BeamLab200/Papers/RP
    BeamLab200/Ridgelets
    BeamLab200/SlantStack
    BeamLab200/Utilities
    BeamLab200/Workouts

  5. Edit the file BeamPath.m, put the lines
        if strcmp(Friend,'<YourMachineType>'),
            BEAMLABPATH = '<AbsolutePathNameforBeamLabMainDirectory>' ;
            PATHNAMESEPARATOR = '<YourMachine*sPathSeparator>';
        end

    in the appropriate place (this will be evident). Here the value of variable Friend has been defined by the Matlab command 
        computer;
     
    Also, BEAMPATH names the place where BeamLab will reside. For an individual user without root privileges, a good choice is
        ~<USERLOGIN>/matlab/BeamLab
    where <USERLOGIN> is the user's account name. For a system manager with root privileges, a good choice is    
        <MatlabToolBoxPath>/BeamLab                         
    where <MatlabToolBoxPath> is the name of the directory containing all the Matlab toolboxes.
  6. Copy all the BeamLab files from the place you put the original BeamLab archive (for example /tmp) to their final destination as named in the variable BEAMLABPATH, for example in your home directory 
        ~user/matlab/BeamLab
    .
  7. Launch Matlab.  In Matlab, set the current path to
        matlabroot/toolbox/BeamLab200
    Alternatively, copy the file BeamPath.m from
        <MatlabToolBoxPath>/BeamLab200
    to
        <MatlabToolBoxPath>/local
  8. Try running a script, such as 
        FSSDemo
    to see if it will run. If it does not, recheck all the above steps.

Note:

  1. If you want Matlab to automatically load BeamLab upon start-up, copy the file BeamPath.m from the BeamLab200 folder to the folder <MatlabToolBoxPath>/local. If you already have a startup.m file in the directory matlab/toolbox/local, add to it the line 
        BeamPath;
     otherwise, rename the file BeamPath.m as startup.m.
  2. Upon successful installation, remove the zip file to save space.

Accelerating BeamLab: MEX Files

Many of the basic routines in BeamLab can be accelerated by the use of Mex files. These are binaries of routines coded in C and run in some cases 10 times faster than their .m counterparts. They will be installed automatically by Matlab when you run Matlab if you have permissions to write the files in the correct places. Hence if you are system manager, you should run Matlab at least once after BeamLab has been installed in order to perform the installation procedure. To check if the process has worked, try the matlab command 
    which BestWedgeletPartition
You should get the response  
    <BEAMLABPATH>/MEXSource/BeamMEXSource/BestWedgeletPartition.mexlx 
or something similar. If you get instead an .m suffix rather than .mex

    <BEAMLABPATH>/MEXSource/BeamMEXSource/BestWedgeletPartition.m 
start troubleshooting.

If you cannot get the MEX files to install automatically, you can download mex files for certain platforms from us. These can be installed manually, copying them into the appropriate locations. For example, the file BestWedgeletPartition.mexsg64 needs to be copied to the same directory of the file BestWedgeletPartition.m
In general, each .mex file needs to be in the directory of its homologous .m file.

If you are unable to get the .mex files to work at all, don't worry -- BeamLab will still work, but more slowly.


Trouble-Shooting UNIX Installation

Compare the output of 
    ls -r BeamLab 
with 
    Documentation/WLFiles 
to see if you have all the files. Compare the output of the Matlab command 
    path 
with the list above to see if you have all the directories in your path.


Success

When you have a successful installation, you should see something like the following when you invoke Matlab:

Welcome to BeamLab v 200

Setting Global Variables:
global MATLABVERSION = 6
global BEAMLABVERSION = 200
global BEAMLABPATH = C:/MATLABR12/toolbox/BeamLab200/
global PATHNAMESEPARATOR = "/"
global PREFERIMAGEGRAPHICS = 1

BeamLab 200 Setup Complete

Currently available browsers for figures from the following papers:
BMIABrowser - old demo for paper "Beamlets and Multiscale Image Analysis."
BMIADemo - new demo for paper "Beamlets and Multiscale Image Analysis"
BL3DDemo - demo for paper "3D Beamlets"
DCRTDemo - demo for paper "Digital Curvelet Transform"
DRTDemo - demo for paper "Digital Ridgelet Transform"
FSSDemo - demo for paper "Fast Slant Stack"
RPDemo - demo for "Ridgelet Packets"

Currently available workouts:
BeamletsDecoratedPartitionDemo - workout for "Beamlets"
guiparFSSFig1 to guiparFSSFig4 - workouts for "Fast Slant Stack"
BestPartitionDemo - workout for paper "Ridgelet Packets"

For more information, please visit: 
http://www-stat.stanford.edu/~beamlab

Please ignore the following message if WaveLab has been installed.

There are BeamLab functions which call WaveLab functions.
We recommend that the users download WaveLab from the website
http://www-stat.stanford.edu/~wavelab
and install the package in the directory
C:/MATLABR12/toolbox   
 

 


BeamLab

Modified: September 14, 2002