00001 /*!@file Media/FrameRange.H A range of frames at a given inter-frame delay */ 00002 00003 // //////////////////////////////////////////////////////////////////// // 00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2003 // 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: Laurent Itti <itti@usc.edu> 00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Media/FrameRange.H $ 00035 // $Id: FrameRange.H 13273 2010-04-21 22:08:00Z rand $ 00036 // 00037 00038 #ifndef FRAMERANGE_H_DEFINED 00039 #define FRAMERANGE_H_DEFINED 00040 00041 #include "Util/Assert.H" 00042 #include "Util/SimTime.H" 00043 #include <string> 00044 #include <vector> 00045 00046 //! Specification of a range of frames with given inter-frame delay 00047 class FrameRange 00048 { 00049 public: 00050 //! Default-construct as "0-1-0@0" 00051 FrameRange(); 00052 00053 //! Constructor 00054 FrameRange(int first, int step, int last, 00055 std::vector<SimTime> delays=std::vector<SimTime>(), 00056 bool eventTriggered=false); 00057 00058 //! Convert to string 00059 std::string toString() const; 00060 00061 //! Pseudo-constructor; convert from string 00062 static FrameRange fromString(const std::string& s); 00063 00064 //! Equality operator 00065 bool operator==(const FrameRange& that) const; 00066 00067 //! Inequality operator 00068 bool operator!=(const FrameRange& that) const 00069 { return !(*this == that); } 00070 00071 int getFirst() const { return itsFirst; } 00072 00073 int getStep() const { return itsStep; } 00074 00075 int getLast() const { return itsLast; } 00076 00077 size_t numDelayTimes() const { return itsDelayTimes.size(); } 00078 00079 SimTime getDelayTime(size_t idx) const 00080 { 00081 ASSERT(idx < itsDelayTimes.size()); 00082 return itsDelayTimes[idx]; 00083 } 00084 00085 bool isEventTriggered() const { return itsEventTriggered; } 00086 00087 private: 00088 int itsFirst; //!< number of first frame 00089 int itsStep; //!< number of frames to step with each update (default=1) 00090 int itsLast; //!< number of last frame 00091 std::vector<SimTime> itsDelayTimes; //!< inter-frame delay (single element) or elapsed time from clip onset (multiple elements) 00092 bool itsEventTriggered; //!< trigger on events rather than on a clock? 00093 }; 00094 00095 //! FrameRange overload: format is "first-step-last@delay" 00096 inline std::string convertToString(const FrameRange& val) 00097 { return val.toString(); } 00098 00099 //! FrameRange overload: format is "[[first[-step]]-[last]]@delay" 00100 /*! If the entire "first-step-list" range is missing, then we assume 00101 0-INT_MAX. If just "last" is missing (i.e., we got "first-"), then 00102 we assume last=INT_MAX. If just "first" is missing, then we assume 00103 first=0. If "step" is missing, we assume step=1. */ 00104 inline void convertFromString(const std::string& str, FrameRange& val) 00105 { val = FrameRange::fromString(str); } 00106 00107 #endif 00108 00109 // ###################################################################### 00110 /* So things look consistent in everyone's emacs... */ 00111 /* Local Variables: */ 00112 /* indent-tabs-mode: nil */ 00113 /* End: */
1.6.3