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 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   This class is almost purely virtual. It represents a classifier that
  29   can be trained from a SampleSet and able to provide a scalar
  30   response on any test sample. Additional methods are required for
  31   persistence and select the possibly very few used features.
  32
  33 */
  34
  35 #ifndef CLASSIFIER_H
  36 #define CLASSIFIER_H
  37
  38 #include "storable.h"
  39 #include "pi_feature_family.h"
  40 #include "sample_set.h"
  41 #include "pose_cell_hierarchy.h"
  42 #include "labelled_image_pool.h"
  43 #include "loss_machine.h"
  44
  45 class Classifier : public Storable {
  46 public:
  47   virtual ~Classifier();
  48
  49   // Evaluate on a sample
  50   virtual scalar_t response(SampleSet *sample_set, int n_sample) = 0;
  51
  52   // Train the classifier
  53   virtual void train(LossMachine *loss_machine, SampleSet *train, scalar_t *response) = 0;
  54
  55   // Tag in the boolean array which features are actually used
  56   virtual void tag_used_features(bool *used) = 0;
  57   // Change the indexes of the used features
  58   virtual void re_index_features(int *new_indexes) = 0;
  59
  60   // Storage
  61   virtual void read(istream *is) = 0;
  62   virtual void write(ostream *os) = 0;
  63
  64   void extract_pi_feature_family(PiFeatureFamily *full_pi_feature_family,
  65                                  PiFeatureFamily *extracted_pi_feature_family);
  66 };
  67
  68 #endif