X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=labelled_image_pool.h;h=ca3e0134f21bc02414bb31afca7f8ad5af4b8336;hb=aed34255065b18c445d096f51bd2091833810a81;hp=3186dc76675e34746dbd29a2d8b425b200a87dad;hpb=d922ad61d35e9a6996730bec24b16f8bf7bc426c;p=folded-ctf.git
diff --git a/labelled_image_pool.h b/labelled_image_pool.h
index 3186dc7..ca3e013 100644
--- 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 . //
// //
-// Written by Francois Fleuret, (C) IDIAP //
+// Written by Francois Fleuret //
+// (C) Idiap Research Institute //
+// //
// Contact 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;
};