Type Definition opencv::types::PtrOfBoost

pub type PtrOfBoost = Ptr<dyn Boost>;

Implementations

impl PtrOfBoost

pub fn as_raw_PtrOfBoost(&self) -> *const c_void

pub fn as_raw_mut_PtrOfBoost(&mut self) -> *mut c_void

Trait Implementations

impl AlgorithmTrait for PtrOfBoost

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

fn clear(&mut self) -> Result<()>

Clears the algorithm state

fn read(&mut self, fn_: &FileNode) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for PtrOfBoost

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut FileStorage) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

simplified API for language bindings Stores algorithm parameters in a file storage

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

impl Boost for PtrOfBoost

fn as_raw_mut_Boost(&mut self) -> *mut c_void

fn set_boost_type(&mut self, val: i32) -> Result<()>

Type of the boosting algorithm. See Boost::Types. Default value is Boost::REAL.

fn set_weak_count(&mut self, val: i32) -> Result<()>

The number of weak classifiers. Default value is 100.

fn set_weight_trim_rate(&mut self, val: f64) -> Result<()>

A threshold between 0 and 1 used to save computational time. Samples with summary weight

inline formula

do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality. Default value is 0.95.

impl BoostConst for PtrOfBoost

fn as_raw_Boost(&self) -> *const c_void

fn get_boost_type(&self) -> Result<i32>

Type of the boosting algorithm. See Boost::Types. Default value is Boost::REAL.

fn get_weak_count(&self) -> Result<i32>

The number of weak classifiers. Default value is 100.

fn get_weight_trim_rate(&self) -> Result<f64>

A threshold between 0 and 1 used to save computational time. Samples with summary weight

inline formula

do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality. Default value is 0.95.

impl DTrees for PtrOfBoost

fn as_raw_mut_DTrees(&mut self) -> *mut c_void

fn set_max_categories(&mut self, val: i32) -> Result<()>

Cluster possible values of a categorical variable into K<=maxCategories clusters to find a suboptimal split. If a discrete variable, on which the training procedure tries to make a split, takes more than maxCategories values, the precise best subset estimation may take a very long time because the algorithm is exponential. Instead, many decision trees engines (including our implementation) try to find sub-optimal split in this case by clustering all the samples into maxCategories clusters that is some categories are merged together. The clustering is applied only in n > 2-class classification problems for categorical variables with N > max_categories possible values. In case of regression and 2-class classification the optimal split can be found efficiently without employing clustering, thus the parameter is not used in these cases. Default value is 10.

fn set_max_depth(&mut self, val: i32) -> Result<()>

The maximum possible depth of the tree. That is the training algorithms attempts to split a node while its depth is less than maxDepth. The root node has zero depth. The actual depth may be smaller if the other termination criteria are met (see the outline of the training procedure @ref ml_intro_trees “here”), and/or if the tree is pruned. Default value is INT_MAX.

fn set_min_sample_count(&mut self, val: i32) -> Result<()>

If the number of samples in a node is less than this parameter then the node will not be split.

fn set_cv_folds(&mut self, val: i32) -> Result<()>

If CVFolds > 1 then algorithms prunes the built decision tree using K-fold cross-validation procedure where K is equal to CVFolds. Default value is 10.

fn set_use_surrogates(&mut self, val: bool) -> Result<()>

If true then surrogate splits will be built. These splits allow to work with missing data and compute variable importance correctly. Default value is false.

fn set_use1_se_rule(&mut self, val: bool) -> Result<()>

If true then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate. Default value is true.

fn set_truncate_pruned_tree(&mut self, val: bool) -> Result<()>

If true then pruned branches are physically removed from the tree. Otherwise they are retained and it is possible to get results from the original unpruned (or pruned less aggressively) tree. Default value is true.

fn set_regression_accuracy(&mut self, val: f32) -> Result<()>

Termination criteria for regression trees. If all absolute differences between an estimated value in a node and values of train samples in this node are less than this parameter then the node will not be split further. Default value is 0.01f

fn set_priors(&mut self, val: &Mat) -> Result<()>

The array of a priori class probabilities, sorted by the class label value.

impl DTreesConst for PtrOfBoost

fn as_raw_DTrees(&self) -> *const c_void

fn get_max_categories(&self) -> Result<i32>

Cluster possible values of a categorical variable into K<=maxCategories clusters to find a suboptimal split. If a discrete variable, on which the training procedure tries to make a split, takes more than maxCategories values, the precise best subset estimation may take a very long time because the algorithm is exponential. Instead, many decision trees engines (including our implementation) try to find sub-optimal split in this case by clustering all the samples into maxCategories clusters that is some categories are merged together. The clustering is applied only in n > 2-class classification problems for categorical variables with N > max_categories possible values. In case of regression and 2-class classification the optimal split can be found efficiently without employing clustering, thus the parameter is not used in these cases. Default value is 10.

fn get_max_depth(&self) -> Result<i32>

The maximum possible depth of the tree. That is the training algorithms attempts to split a node while its depth is less than maxDepth. The root node has zero depth. The actual depth may be smaller if the other termination criteria are met (see the outline of the training procedure @ref ml_intro_trees “here”), and/or if the tree is pruned. Default value is INT_MAX.

fn get_min_sample_count(&self) -> Result<i32>

If the number of samples in a node is less than this parameter then the node will not be split.

fn get_cv_folds(&self) -> Result<i32>

If CVFolds > 1 then algorithms prunes the built decision tree using K-fold cross-validation procedure where K is equal to CVFolds. Default value is 10.

fn get_use_surrogates(&self) -> Result<bool>

If true then surrogate splits will be built. These splits allow to work with missing data and compute variable importance correctly. Default value is false.

fn get_use1_se_rule(&self) -> Result<bool>

If true then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate. Default value is true.

fn get_truncate_pruned_tree(&self) -> Result<bool>

If true then pruned branches are physically removed from the tree. Otherwise they are retained and it is possible to get results from the original unpruned (or pruned less aggressively) tree. Default value is true.

fn get_regression_accuracy(&self) -> Result<f32>

Termination criteria for regression trees. If all absolute differences between an estimated value in a node and values of train samples in this node are less than this parameter then the node will not be split further. Default value is 0.01f

fn get_priors(&self) -> Result<Mat>

The array of a priori class probabilities, sorted by the class label value.

fn get_roots(&self) -> Result<Vector<i32>>

Returns indices of root nodes

fn get_nodes(&self) -> Result<Vector<DTrees_Node>>

Returns all the nodes

fn get_splits(&self) -> Result<Vector<DTrees_Split>>

Returns all the splits

fn get_subsets(&self) -> Result<Vector<i32>>

Returns all the bitsets for categorical splits

impl StatModel for PtrOfBoost

fn as_raw_mut_StatModel(&mut self) -> *mut c_void

fn train_with_data(
    &mut self,
    train_data: &Ptr<dyn TrainData>,
    flags: i32
) -> Result<bool>

Trains the statistical model

fn train(
    &mut self,
    samples: &dyn ToInputArray,
    layout: i32,
    responses: &dyn ToInputArray
) -> Result<bool>

Trains the statistical model

impl StatModelConst for PtrOfBoost

fn as_raw_StatModel(&self) -> *const c_void

fn get_var_count(&self) -> Result<i32>

Returns the number of variables in training samples

fn empty(&self) -> Result<bool>

fn is_trained(&self) -> Result<bool>

Returns true if the model is trained

fn is_classifier(&self) -> Result<bool>

Returns true if the model is classifier

fn calc_error(
    &self,
    data: &Ptr<dyn TrainData>,
    test: bool,
    resp: &mut dyn ToOutputArray
) -> Result<f32>

Computes error on the training or test dataset

fn predict(
    &self,
    samples: &dyn ToInputArray,
    results: &mut dyn ToOutputArray,
    flags: i32
) -> Result<f32>

Predicts response(s) for the provided sample(s)