automatic commit
[folded-ctf.git] / labelled_image_pool.h
1
2 ///////////////////////////////////////////////////////////////////////////
3 // This program is free software: you can redistribute it and/or modify  //
4 // it under the terms of the version 3 of the GNU General Public License //
5 // as published by the Free Software Foundation.                         //
6 //                                                                       //
7 // This program is distributed in the hope that it will be useful, but   //
8 // WITHOUT ANY WARRANTY; without even the implied warranty of            //
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      //
10 // General Public License for more details.                              //
11 //                                                                       //
12 // You should have received a copy of the GNU General Public License     //
13 // along with this program. If not, see <http://www.gnu.org/licenses/>.  //
14 //                                                                       //
15 // Written by Francois Fleuret, (C) IDIAP                                //
16 // Contact <francois.fleuret@idiap.ch> for comments & bug reports        //
17 ///////////////////////////////////////////////////////////////////////////
18
19 /*
20
21   A pool of images is used to avoid having too many images in memory
22   at the same time. It can be either a file, or a subset of another
23   pool of images (see the subclasses).
24
25  */
26
27 #ifndef LABELLED_IMAGE_POOL_H
28 #define LABELLED_IMAGE_POOL_H
29
30 #include "shared.h"
31 #include "labelled_image.h"
32
33 class LabelledImagePool {
34 public:
35   virtual ~LabelledImagePool();
36   virtual int nb_images() = 0;
37   // grab_image _DOES NOT_ build the rich structure of the grabbed
38   // image. One has to call compute_rich_structure() explicitely for
39   // that!
40   virtual LabelledImage *grab_image(int n_image) = 0;
41   virtual void release_image(int n_image) = 0;
42 };
43
44 #endif