automatic commit
[folded-ctf.git] / classifier.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 version 3 as
13  *  published by the Free Software Foundation.
14  *
15  *  folded-ctf is distributed in the hope that it will be useful, but
16  *  WITHOUT ANY WARRANTY; without even the implied warranty of
17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  *  General Public License for more details.
19  *
20  *  You should have received a copy of the GNU General Public License
21  *  along with folded-ctf.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24
25 /*
26
27   This class is almost purely virtual. It represents a classifier that
28   can be trained from a SampleSet and able to provide a scalar
29   response on any test sample. Additional methods are required for
30   persistence and select the possibly very few used features.
31
32 */
33
34 #ifndef CLASSIFIER_H
35 #define CLASSIFIER_H
36
37 #include "storable.h"
38 #include "pi_feature_family.h"
39 #include "sample_set.h"
40 #include "pose_cell_hierarchy.h"
41 #include "labelled_image_pool.h"
42 #include "loss_machine.h"
43
44 class Classifier : public Storable {
45 public:
46   virtual ~Classifier();
47
48   // Evaluate on a sample
49   virtual scalar_t response(SampleSet *sample_set, int n_sample) = 0;
50
51   // Train the classifier
52   virtual void train(LossMachine *loss_machine, SampleSet *train, scalar_t *response) = 0;
53
54   // Tag in the boolean array which features are actually used
55   virtual void tag_used_features(bool *used) = 0;
56   // Change the indexes of the used features
57   virtual void re_index_features(int *new_indexes) = 0;
58
59   // Storage
60   virtual void read(istream *is) = 0;
61   virtual void write(ostream *os) = 0;
62
63   void extract_pi_feature_family(PiFeatureFamily *full_pi_feature_family,
64                                  PiFeatureFamily *extracted_pi_feature_family);
65 };
66
67 #endif