env_pyr.h

Go to the documentation of this file.
00001 /*!@file Envision/env_pyr.h */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the //
00005 // 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: Rob Peters <rjpeters at usc dot edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Envision/env_pyr.h $
00035 // $Id: env_pyr.h 7628 2007-01-03 04:07:21Z rjpeters $
00036 //
00037 
00038 #ifndef ENVISION_ENV_PYR_H_DEFINED
00039 #define ENVISION_ENV_PYR_H_DEFINED
00040 
00041 #include "Envision/env_image.h"
00042 #include "Envision/env_log.h"
00043 
00044 // ######################################################################
00045 //! This class implements a set of images, often used as a dyadic pyramid.
00046 struct env_pyr
00047 {
00048         struct env_image* images;
00049         env_size_t depth;
00050 };
00051 
00052 #define env_pyr_initializer { 0, 0 }
00053 
00054 #ifdef __cplusplus
00055 extern "C"
00056 {
00057 #endif
00058 
00059         //! Construct an empty pyramid
00060         static inline void env_pyr_init_empty(struct env_pyr* pyr);
00061 
00062         //! Construct with a given number of empty images.
00063         void env_pyr_init(struct env_pyr* pyr, const env_size_t n);
00064 
00065         void env_pyr_make_empty(struct env_pyr* dst);
00066 
00067         void env_pyr_copy_src_dst(const struct env_pyr* src,
00068                                   struct env_pyr* dst);
00069 
00070         //! Swap contents with another env_pyr
00071         void env_pyr_swap(struct env_pyr* pyr1,
00072                           struct env_pyr* pyr2);
00073 
00074         //! Return number of images in image set.
00075         static inline env_size_t env_pyr_depth(const struct env_pyr* pyr);
00076 
00077         //! Get image from a given level.
00078         static inline const struct env_image* env_pyr_img(const struct env_pyr* pyr,
00079                                                           const env_size_t lev);
00080 
00081         //! Get mutable image from a given level.
00082         static inline struct env_image* env_pyr_imgw(struct env_pyr* pyr,
00083                                                      const env_size_t lev);
00084 
00085 #ifdef __cplusplus
00086 }
00087 #endif
00088 
00089 
00090 
00091 // ######################################################################
00092 static inline void env_pyr_init_empty(struct env_pyr* pyr)
00093 {
00094         pyr->images = 0;
00095         pyr->depth = 0;
00096 }
00097 
00098 // ######################################################################
00099 static inline env_size_t env_pyr_depth(const struct env_pyr* pyr)
00100 {
00101         return pyr->depth;
00102 }
00103 
00104 // ######################################################################
00105 static inline const struct env_image* env_pyr_img(const struct env_pyr* pyr,
00106                                                   const env_size_t lev)
00107 {
00108         return &pyr->images[lev];
00109 }
00110 
00111 // ######################################################################
00112 static inline struct env_image* env_pyr_imgw(struct env_pyr* pyr,
00113                                              const env_size_t lev)
00114 {
00115         return &pyr->images[lev];
00116 }
00117 
00118 // ######################################################################
00119 /* So things look consistent in everyone's emacs... */
00120 /* Local Variables: */
00121 /* indent-tabs-mode: nil */
00122 /* c-file-style: "linux" */
00123 /* End: */
00124 
00125 #endif // !ENVISION_ENV_PYR_H_DEFINED
Generated on Sun May 8 08:40:38 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3