%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
PHOTO POPUP README for WINDOWS
Derek Hoiem (dhoiem@cs.cmu.edu)
10/08/05
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


The photoPopup application was compiled from matlab code using mcc. 
There are separate compilations for Windows (v7.04) and Linux (v7.3). This
README is for the Windows version.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

LICENSE:

Copyright (C) 2005 Derek Hoiem, Carnegie Mellon University

This software is available for non-commercial use only.  Contact 
Rob Conway(rconway@andrew.cmu.edu), the Tech Transfer manager,  
with questions regarding commercial licensing.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

How to RUN:

photoPopup [fnData] [fnImage] [extSuperpixelImage] [outdir]
fnData: filename for .mat file containing classifier data
fnImage: filename for original RGB image
extSuperpixelImage: filename extension for superpixel image
outdir: directory to output results
 
Examples of usage:
photoPopup ./classifiers_08_22_2005 ../images/103_0354.jpg pnm ../results 

Type photoPopup (no args) to get a message similar to this.  See notes below
on how to get superpixel image.  See Install instructions below for how to
set environment variables.  photoPopup must be run from the same directory, 
or environment variables must be set to allow it to find the .ctf file.  If the image is in the current directory, it must be preceded by "./".  

Here are the steps that must be performed to run an image:
1) Obtain the image in .ppm format
2) Run the F&H superpixel program: ./segment <imname>.ppm 0.8 100 100


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

How to INSTALL (Windows Only):


Step 1: Copy photoPopup and photoPopup.ctf to the directory from which you 
        will run photoPopup.

Step 2:

  CASE I: YOU HAVE MATLAB 7.04
    
	You should be able to run from the command prompt.
  
  CASE II: YOU DO NOT HAVE MATLAB 7.04

    Copy MCRInstaller.exe (~100MB!!) as well and install.

    You should now be able to run from the command prompt.  
    If not, ensure that the following has been added to your path:
	<mcr_root>\<ver>\runtime\win32 


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

NOTES:  

  Superpixels:
  I use the segmentation code provided by Felzenszwalb and Huttenlocher
  at people.cs.uchicago.edu/~pff/segment/ to create the superpixels in my
  experiments.  The first three arguments (sigma, k, min) that I use are 
  0.8 100 100.  You can also use a different program to create the superpixel
  image.  That image should have a different RGB color for each segment
  without drawn boundaries between segments.  

  Linux:
  A separate executable and separate instructions are available for Linux.

  Comments, Bugs:
  If you have any comments or suggestions please e-mail them to 
  dhoiem@cs.cmu.edu.  If you re-write any of the code in C and MEX it
  or make the algorithm faster in another way, I would appreciate if you
  send the revised code to me so that I can make it publicly available
  (with acknowledgement of the revision author).  


(C) Derek Hoiem, Carnegie Mellon University, 2005