GUIOpts.C

Go to the documentation of this file.
00001 /*!@file GUI/GUIOpts.C */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file:
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/GUI/GUIOpts.C $
00035 // $Id: GUIOpts.C 13123 2010-04-01 22:25:09Z dberg $
00036 //
00037 
00038 #ifndef GUI_GUIOPTS_C_DEFINED
00039 #define GUI_GUIOPTS_C_DEFINED
00040 
00041 #include "GUI/GUIOpts.H"
00042 
00043 #include "Component/ModelOptionDef.H"
00044 #include "Image/Dims.H"
00045 #include "Image/Rectangle.H"
00046 
00047 const ModelOptionCateg MOC_SDLDISP = {
00048   MOC_SORTPRI_2, "SDLdisplay-Related Options" };
00049 
00050 // Format here is:
00051 //
00052 // { MODOPT_TYPE, "name", &MOC_CATEG, OPTEXP_CORE,
00053 //   "description of what option does",
00054 //   "long option name", 'short option name', "valid values", "default value" }
00055 //
00056 
00057 // alternatively, for MODOPT_ALIAS option types, format is:
00058 //
00059 // { MODOPT_ALIAS, "", &MOC_ALIAS, OPTEXP_CORE,
00060 //   "description of what alias does",
00061 //   "long option name", 'short option name', "", "list of options" }
00062 //
00063 
00064 // NOTE: do not change the default value of any existing option unless
00065 // you really know what you are doing!  Many components will determine
00066 // their default behavior from that default value, so you may break
00067 // lots of executables if you change it.
00068 
00069 
00070 // #################### SDLdisplay options:
00071 // Used by: SDLdisplay
00072 const ModelOptionDef OPT_SDLdisplayDims =
00073   { MODOPT_ARG(Dims), "SDLdisplayDims", &MOC_SDLDISP, OPTEXP_CORE,
00074     "SDL display screen dimensions",
00075     "sdl-dims", '\0', "<width>x<height>", "640x480" };
00076 
00077 // Used by: SDLdisplay
00078 const ModelOptionDef OPT_SDLdisplayPriority =
00079   { MODOPT_ARG(int), "SDLdisplayPriority", &MOC_SDLDISP, OPTEXP_CORE,
00080     "Priority to run at in SCHED_FIFO mode (need to run as root), or 0 for "
00081     "normal process scheduling and normal priority. Note that in priority 0 "
00082     "display timing is in no way guaranteed, and timestamps for display "
00083     "events are unreliable by up to +/- 50ms.",
00084     "sdl-priority", '\0', "<int>", "80" };
00085 
00086 // Used by: SDLdisplay
00087 const ModelOptionDef OPT_SDLdisplayRefreshUsec =
00088   { MODOPT_ARG(float), "SDLdisplayRefreshUsec", &MOC_SDLDISP, OPTEXP_CORE,
00089     "Desired refresh delay in microseconds. All screen refresh operations "
00090     "will enforce that at least 90% of this delay has occurred, but it "
00091     "could be more depending on the refresh rate of the video mode used.",
00092     "sdl-refresh", '\0', "<float>", "33333.3333" };
00093 
00094 // Used by: SDLdisplay
00095 const ModelOptionDef OPT_SDLdisplayFullscreen =
00096   { MODOPT_FLAG, "SDLdisplayFullscreen", &MOC_SDLDISP, OPTEXP_CORE,
00097     "Whether to run the SDLdisplay in a fullscreen window.",
00098     "fs", '\0', "<bool>", "true" };
00099 
00100 // Used by: SDLdisplay
00101 const ModelOptionDef OPT_SDLdisplayVBlankKludge =
00102   { MODOPT_ARG(uint), "SDLdisplayVBlankKludge", &MOC_SDLDISP, OPTEXP_CORE,
00103     "On some hardware, waiting for the vertical retrace by polling the "
00104     "VGA registers just does not work (especially in dual-screen setups). "
00105     "If non-zero, this parameter will enable a workaround, whereby we just "
00106     "hard-wait for the exact desired framerate, and just send images "
00107     "asynchronously to the display at that rate. On nVidia boards this "
00108     "yields good results where movies play at the exact desired framerate "
00109     "with no tearing, just we are not guaranteed that each frame will be "
00110     "exactly synchronized to the vertical refresh. The non-zero value is the "
00111     "number of microseconds that our busy-waiting code takes to run on your "
00112     "machine, and has to be adjusted on a case-by-case basis until you obtain "
00113     "your exact desired framerate. For example, on a 2.26GHz Macbook a "
00114     "value of 37 yields a solid 30.000 frames/s in the psycho-movie "
00115     "application displaying 1280x1024 movies. "
00116     "Larger values will decrease your framerate and vice-versa.",
00117     "sdl-vblank-kludge", '\0', "<uint>", "0" };
00118 
00119 
00120 // Used by: SDLdisplay
00121 const ModelOptionDef OPT_SDLdisplaySyncRect  =
00122   { MODOPT_ARG(Rectangle), "SDLdisplaySyncRect", &MOC_SDLDISP, OPTEXP_CORE,
00123     "Place a small patch of alternating black and white pixels over the "
00124     "video frame. This used for syncing with an external system using a "
00125     "photodiode. Rectangle coordinates define the pixel positions for left, "
00126     "top, right and bottom corners.", "sdl-sync-rect", '\0', "<Rectangle>", 
00127     "0,0,0,0"};
00128 
00129 // ######################################################################
00130 /* So things look consistent in everyone's emacs... */
00131 /* Local Variables: */
00132 /* indent-tabs-mode: nil */
00133 /* End: */
00134 
00135 #endif // GUI_GUIOPTS_C_DEFINED
Generated on Sun May 8 08:40:40 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3