\( \newcommand{\E}{\mathrm{E}} \) \( \newcommand{\A}{\mathrm{A}} \) \( \newcommand{\R}{\mathrm{R}} \) \( \newcommand{\N}{\mathrm{N}} \) \( \newcommand{\Q}{\mathrm{Q}} \) \( \newcommand{\Z}{\mathrm{Z}} \) \( \def\ccSum #1#2#3{ \sum_{#1}^{#2}{#3} } \def\ccProd #1#2#3{ \sum_{#1}^{#2}{#3} }\)
CGAL 4.12.1 - Classification
CGAL::Classification::ETHZ_random_forest_classifier Class Reference

#include <CGAL/Classification/ETHZ_random_forest_classifier.h>


Classifier based on the ETH Zurich version of random forest algorithm [2].

This classifier is distributed under the MIT license.
Is Model Of:


 ETHZ_random_forest_classifier (const Label_set &labels, const Feature_set &features)
 Instantiate the classifier using the sets of labels and features.


template<typename LabelIndexRange >
void train (const LabelIndexRange &ground_truth, bool reset_trees=true, std::size_t num_trees=25, std::size_t max_depth=20)
 Runs the training algorithm. More...


void save_configuration (std::ostream &output)
 Saves the current configuration in the stream output. More...
void load_configuration (std::istream &input)
 Loads a configuration from the stream input. More...

Member Function Documentation

◆ load_configuration()

void CGAL::Classification::ETHZ_random_forest_classifier::load_configuration ( std::istream &  input)

Loads a configuration from the stream input.

The input file should be a GZIP container written by the save_configuration() method. The feature set of the classifier should contain the exact same features in the exact same order as the ones present when the file was generated using save_configuration().

◆ save_configuration()

void CGAL::Classification::ETHZ_random_forest_classifier::save_configuration ( std::ostream &  output)

Saves the current configuration in the stream output.

This allows to easily save and recover a specific classification configuration.

The output file is written in an GZIP container that is readable by the load_configuration() method.

◆ train()

template<typename LabelIndexRange >
void CGAL::Classification::ETHZ_random_forest_classifier::train ( const LabelIndexRange &  ground_truth,
bool  reset_trees = true,
std::size_t  num_trees = 25,
std::size_t  max_depth = 20 

Runs the training algorithm.

From the set of provided ground truth, this algorithm estimates sets up the random trees that produce the most accurate result with respect to this ground truth.

At least one ground truth item should be assigned to each label.
ground_truthvector of label indices. It should contain for each input item, in the same order as the input set, the index of the corresponding label in the Label_set provided in the constructor. Input items that do not have a ground truth information should be given the value -1.
reset_treesshould be set to false if the users wants to add new trees to the existing forest, and kept to true if the training should be recomputing from scratch (discarding the current forest).
num_treesnumber of trees generated by the training algorithm. Higher values may improve result at the cost of higher computation times (in general, using a few dozens of trees is enough).
max_depthmaximum depth of the trees. Higher values will improve how the forest fits the training set. A overly low value will underfit the test data and conversely an overly high value will likely overfit.