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