automatic commit

[folded-ctf.git] / labelled_image_pool.h

diff --git a/labelled_image_pool.h b/labelled_image_pool.h
index 3186dc7..ca3e013 100644 (file)
--- a/labelled_image_pool.h
+++ b/labelled_image_pool.h
@@ -12,10 +12,20 @@
 // 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                                //
+// Written by Francois Fleuret                                           //
+// (C) Idiap Research Institute                                          //
+//                                                                       //
 // 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 +36,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;
 };