X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=folded-ctf.git;a=blobdiff_plain;f=labelled_image_pool.h;h=23dbbde832f3454ca1577de77cde4a4bb46abb65;hp=3186dc76675e34746dbd29a2d8b425b200a87dad;hb=HEAD;hpb=d922ad61d35e9a6996730bec24b16f8bf7bc426c

diff --git a/labelled_image_pool.h b/labelled_image_pool.h
index 3186dc7..23dbbde 100644
--- a/labelled_image_pool.h
+++ b/labelled_image_pool.h
@@ -1,20 +1,34 @@
+/*
+ *  folded-ctf is an implementation of the folded hierarchy of
+ *  classifiers for object detection, developed by Francois Fleuret
+ *  and Donald Geman.
+ *
+ *  Copyright (c) 2008 Idiap Research Institute, http://www.idiap.ch/
+ *  Written by Francois Fleuret <francois.fleuret@idiap.ch>
+ *
+ *  This file is part of folded-ctf.
+ *
+ *  folded-ctf is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 3 as
+ *  published by the Free Software Foundation.
+ *
+ *  folded-ctf is distributed in the hope that it will be useful, but
+ *  WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with folded-ctf.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
 
-///////////////////////////////////////////////////////////////////////////
-// This program is free software: you can redistribute it and/or modify  //
-// it under the terms of the version 3 of the GNU General Public License //
-// as published by the Free Software Foundation.                         //
-//                                                                       //
-// This program is distributed in the hope that it will be useful, but   //
-// WITHOUT ANY WARRANTY; without even the implied warranty of            //
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      //
-// General Public License for more details.                              //
-//                                                                       //
-// You should have received a copy of the GNU General Public License     //
-// along with this program. If not, see <http://www.gnu.org/licenses/>.  //
-//                                                                       //
-// Written by Francois Fleuret, (C) IDIAP                                //
-// Contact <francois.fleuret@idiap.ch> for comments & bug reports        //
-///////////////////////////////////////////////////////////////////////////
+/*
+
+  A pool of images is used to avoid having too many images in memory
+  at the same time. It can be either a file, or a subset of another
+  pool of images (see the subclasses).
+
+ */
 
 #ifndef LABELLED_IMAGE_POOL_H
 #define LABELLED_IMAGE_POOL_H
@@ -26,6 +40,9 @@ class LabelledImagePool {
 public:
   virtual ~LabelledImagePool();
   virtual int nb_images() = 0;
+  // grab_image _DOES NOT_ build the rich structure of the grabbed
+  // image. One has to call compute_rich_structure() explicitely for
+  // that!
   virtual LabelledImage *grab_image(int n_image) = 0;
   virtual void release_image(int n_image) = 0;
 };