1
0
mirror of https://github.com/opencv/opencv.git synced 2026-07-30 07:43:03 +04:00

the first round of cleaning up the RST docs

This commit is contained in:
Vadim Pisarevsky
2011-02-28 21:26:43 +00:00
parent eb8c0b8b4b
commit 4bb893aa9f
48 changed files with 1664 additions and 1649 deletions
+7 -7
View File
@@ -83,7 +83,7 @@ training examples are recomputed at each training iteration. Examples deleted at
CvBoostParams
-------------
.. ctype:: CvBoostParams
.. c:type:: CvBoostParams
Boosting training parameters. ::
@@ -109,7 +109,7 @@ The structure is derived from
CvBoostTree
-----------
.. ctype:: CvBoostTree
.. c:type:: CvBoostTree
Weak tree classifier. ::
@@ -148,7 +148,7 @@ Note, that in the case of LogitBoost and Gentle AdaBoost each weak predictor is
CvBoost
-------
.. ctype:: CvBoost
.. c:type:: CvBoost
Boosted tree classifier. ::
@@ -212,7 +212,7 @@ Boosted tree classifier. ::
CvBoost::train
--------------
.. cfunction:: bool CvBoost::train( const CvMat* _train_data, int _tflag, const CvMat* _responses, const CvMat* _var_idx=0, const CvMat* _sample_idx=0, const CvMat* _var_type=0, const CvMat* _missing_mask=0, CvBoostParams params=CvBoostParams(), bool update=false )
.. c:function:: bool CvBoost::train( const CvMat* _train_data, int _tflag, const CvMat* _responses, const CvMat* _var_idx=0, const CvMat* _sample_idx=0, const CvMat* _var_type=0, const CvMat* _missing_mask=0, CvBoostParams params=CvBoostParams(), bool update=false )
Trains a boosted tree classifier.
@@ -224,7 +224,7 @@ The train method follows the common template; the last parameter ``update`` spec
CvBoost::predict
----------------
.. cfunction:: float CvBoost::predict( const CvMat* sample, const CvMat* missing=0, CvMat* weak_responses=0, CvSlice slice=CV_WHOLE_SEQ, bool raw_mode=false ) const
.. c:function:: float CvBoost::predict( const CvMat* sample, const CvMat* missing=0, CvMat* weak_responses=0, CvSlice slice=CV_WHOLE_SEQ, bool raw_mode=false ) const
Predicts a response for the input sample.
@@ -236,7 +236,7 @@ The method ``CvBoost::predict`` runs the sample through the trees in the ensembl
CvBoost::prune
--------------
.. cfunction:: void CvBoost::prune( CvSlice slice )
.. c:function:: void CvBoost::prune( CvSlice slice )
Removes the specified weak classifiers.
@@ -248,7 +248,7 @@ The method removes the specified weak classifiers from the sequence. Note that t
CvBoost::get_weak_predictors
----------------------------
.. cfunction:: CvSeq* CvBoost::get_weak_predictors()
.. c:function:: CvSeq* CvBoost::get_weak_predictors()
Returns the sequence of weak tree classifiers.
+8 -8
View File
@@ -68,7 +68,7 @@ Importance of each variable is computed over all the splits on this variable in
CvDTreeSplit
------------
.. ctype:: CvDTreeSplit
.. c:type:: CvDTreeSplit
Decision tree node split. ::
@@ -97,7 +97,7 @@ Decision tree node split. ::
CvDTreeNode
-----------
.. ctype:: CvDTreeNode
.. c:type:: CvDTreeNode
Decision tree node. ::
@@ -127,7 +127,7 @@ Other numerous fields of ``CvDTreeNode`` are used internally at the training sta
CvDTreeParams
-------------
.. ctype:: CvDTreeParams
.. c:type:: CvDTreeParams
Decision tree training parameters. ::
@@ -164,7 +164,7 @@ The structure contains all the decision tree training parameters. There is a def
CvDTreeTrainData
----------------
.. ctype:: CvDTreeTrainData
.. c:type:: CvDTreeTrainData
Decision tree training data and shared data for tree ensembles. ::
@@ -289,7 +289,7 @@ There are 2 ways of using this structure. In simple cases (e.g. a standalone tre
CvDTree
-------
.. ctype:: CvDTree
.. c:type:: CvDTree
Decision tree. ::
@@ -376,9 +376,9 @@ Decision tree. ::
CvDTree::train
--------------
.. cfunction:: bool CvDTree::train( const CvMat* _train_data, int _tflag, const CvMat* _responses, const CvMat* _var_idx=0, const CvMat* _sample_idx=0, const CvMat* _var_type=0, const CvMat* _missing_mask=0, CvDTreeParams params=CvDTreeParams() )
.. c:function:: bool CvDTree::train( const CvMat* _train_data, int _tflag, const CvMat* _responses, const CvMat* _var_idx=0, const CvMat* _sample_idx=0, const CvMat* _var_type=0, const CvMat* _missing_mask=0, CvDTreeParams params=CvDTreeParams() )
.. cfunction:: bool CvDTree::train( CvDTreeTrainData* _train_data, const CvMat* _subsample_idx )
.. c:function:: bool CvDTree::train( CvDTreeTrainData* _train_data, const CvMat* _subsample_idx )
Trains a decision tree.
@@ -396,7 +396,7 @@ The second method ``train`` is mostly used for building tree ensembles. It takes
CvDTree::predict
----------------
.. cfunction:: CvDTreeNode* CvDTree::predict( const CvMat* _sample, const CvMat* _missing_data_mask=0, bool raw_mode=false ) const
.. c:function:: CvDTreeNode* CvDTree::predict( const CvMat* _sample, const CvMat* _missing_data_mask=0, bool raw_mode=false ) const
Returns the leaf node of the decision tree corresponding to the input vector.
+3 -3
View File
@@ -88,7 +88,7 @@ already a good enough approximation).
CvEMParams
----------
.. ctype:: CvEMParams
.. c:type:: CvEMParams
Parameters of the EM algorithm. ::
@@ -134,7 +134,7 @@ The structure has 2 constructors, the default one represents a rough rule-of-thu
CvEM
----
.. ctype:: CvEM
.. c:type:: CvEM
EM model. ::
@@ -194,7 +194,7 @@ EM model. ::
CvEM::train
-----------
.. cfunction:: void CvEM::train( const CvMat* samples, const CvMat* sample_idx=0, CvEMParams params=CvEMParams(), CvMat* labels=0 )
.. c:function:: void CvEM::train( const CvMat* samples, const CvMat* sample_idx=0, CvEMParams params=CvEMParams(), CvMat* labels=0 )
Estimates the Gaussian mixture parameters from the sample set.
+3 -3
View File
@@ -13,7 +13,7 @@ The algorithm caches all of the training samples, and predicts the response for
CvKNearest
----------
.. ctype:: CvKNearest
.. c:type:: CvKNearest
K Nearest Neighbors model. ::
@@ -51,7 +51,7 @@ K Nearest Neighbors model. ::
CvKNearest::train
-----------------
.. cfunction:: bool CvKNearest::train( const CvMat* _train_data, const CvMat* _responses, const CvMat* _sample_idx=0, bool is_regression=false, int _max_k=32, bool _update_base=false )
.. c:function:: bool CvKNearest::train( const CvMat* _train_data, const CvMat* _responses, const CvMat* _sample_idx=0, bool is_regression=false, int _max_k=32, bool _update_base=false )
Trains the model.
@@ -68,7 +68,7 @@ The parameter ``_update_base`` specifies whether the model is trained from scrat
CvKNearest::find_nearest
------------------------
.. cfunction:: float CvKNearest::find_nearest( const CvMat* _samples, int k, CvMat* results=0, const float** neighbors=0, CvMat* neighbor_responses=0, CvMat* dist=0 ) const
.. c:function:: float CvKNearest::find_nearest( const CvMat* _samples, int k, CvMat* results=0, const float** neighbors=0, CvMat* neighbor_responses=0, CvMat* dist=0 ) const
Finds the neighbors for the input vectors.
+1 -1
View File
@@ -16,6 +16,6 @@ Most of the classification and regression algorithms are implemented as C++ clas
decision_trees
boosting
random_trees
expectation-maximization
expectation_maximization
neural_networks
+6 -4
View File
@@ -98,7 +98,7 @@ References:
CvANN_MLP_TrainParams
---------------------
.. ctype:: CvANN_MLP_TrainParams
.. c:type:: CvANN_MLP_TrainParams
Parameters of the MLP training algorithm. ::
@@ -120,6 +120,7 @@ Parameters of the MLP training algorithm. ::
// rprop parameters
double rp_dw0, rp_dw_plus, rp_dw_minus, rp_dw_min, rp_dw_max;
};
..
The structure has default constructor that initializes parameters for ``RPROP`` algorithm. There is also more advanced constructor to customize the parameters and/or choose backpropagation algorithm. Finally, the individual parameters can be adjusted after the structure is created.
@@ -130,7 +131,7 @@ The structure has default constructor that initializes parameters for ``RPROP``
CvANN_MLP
---------
.. ctype:: CvANN_MLP
.. c:type:: CvANN_MLP
MLP model. ::
@@ -210,6 +211,7 @@ MLP model. ::
CvANN_MLP_TrainParams params;
CvRNG rng;
};
..
Unlike many other models in ML that are constructed and trained at once, in the MLP model these steps are separated. First, a network with the specified topology is created using the non-default constructor or the method ``create`` . All the weights are set to zeros. Then the network is trained using the set of input and output vectors. The training procedure can be repeated more than once, i.e. the weights can be adjusted based on the new training data.
@@ -220,7 +222,7 @@ Unlike many other models in ML that are constructed and trained at once, in the
CvANN_MLP::create
-----------------
.. cfunction:: void CvANN_MLP::create( const CvMat* _layer_sizes, int _activ_func=SIGMOID_SYM, double _f_param1=0, double _f_param2=0 )
.. c:function:: void CvANN_MLP::create( const CvMat* _layer_sizes, int _activ_func=SIGMOID_SYM, double _f_param1=0, double _f_param2=0 )
Constructs the MLP with the specified topology
@@ -238,7 +240,7 @@ The method creates a MLP network with the specified topology and assigns the sam
CvANN_MLP::train
----------------
.. cfunction:: int CvANN_MLP::train( const CvMat* _inputs, const CvMat* _outputs, const CvMat* _sample_weights, const CvMat* _sample_idx=0, CvANN_MLP_TrainParams _params = CvANN_MLP_TrainParams(), int flags=0 )
.. c:function:: int CvANN_MLP::train( const CvMat* _inputs, const CvMat* _outputs, const CvMat* _sample_weights, const CvMat* _sample_idx=0, CvANN_MLP_TrainParams _params = CvANN_MLP_TrainParams(), int flags=0 )
Trains/updates MLP.
+3 -3
View File
@@ -13,7 +13,7 @@ This is a simple classification model assuming that feature vectors from each cl
CvNormalBayesClassifier
-----------------------
.. ctype:: CvNormalBayesClassifier
.. c:type:: CvNormalBayesClassifier
Bayes classifier for normally distributed data. ::
@@ -48,7 +48,7 @@ Bayes classifier for normally distributed data. ::
CvNormalBayesClassifier::train
------------------------------
.. cfunction:: bool CvNormalBayesClassifier::train( const CvMat* _train_data, const CvMat* _responses, const CvMat* _var_idx =0, const CvMat* _sample_idx=0, bool update=false )
.. c:function:: bool CvNormalBayesClassifier::train( const CvMat* _train_data, const CvMat* _responses, const CvMat* _var_idx =0, const CvMat* _sample_idx=0, bool update=false )
Trains the model.
@@ -62,7 +62,7 @@ In addition, there is an ``update`` flag that identifies whether the model shoul
CvNormalBayesClassifier::predict
--------------------------------
.. cfunction:: float CvNormalBayesClassifier::predict( const CvMat* samples, CvMat* results=0 ) const
.. c:function:: float CvNormalBayesClassifier::predict( const CvMat* samples, CvMat* results=0 ) const
Predicts the response for sample(s)
+6 -6
View File
@@ -53,7 +53,7 @@ In random trees there is no need for any accuracy estimation procedures, such as
CvRTParams
----------
.. ctype:: CvRTParams
.. c:type:: CvRTParams
Training Parameters of Random Trees. ::
@@ -86,7 +86,7 @@ The set of training parameters for the forest is the superset of the training pa
CvRTrees
--------
.. ctype:: CvRTrees
.. c:type:: CvRTrees
Random Trees. ::
@@ -136,7 +136,7 @@ Random Trees. ::
CvRTrees::train
---------------
.. cfunction:: bool CvRTrees::train( const CvMat* train_data, int tflag, const CvMat* responses, const CvMat* comp_idx=0, const CvMat* sample_idx=0, const CvMat* var_type=0, const CvMat* missing_mask=0, CvRTParams params=CvRTParams() )
.. c:function:: bool CvRTrees::train( const CvMat* train_data, int tflag, const CvMat* responses, const CvMat* comp_idx=0, const CvMat* sample_idx=0, const CvMat* var_type=0, const CvMat* missing_mask=0, CvRTParams params=CvRTParams() )
Trains the Random Trees model.
@@ -149,7 +149,7 @@ The method ``CvRTrees::train`` is very similar to the first form of ``CvDTree::t
CvRTrees::predict
-----------------
.. cfunction:: double CvRTrees::predict( const CvMat* sample, const CvMat* missing=0 ) const
.. c:function:: double CvRTrees::predict( const CvMat* sample, const CvMat* missing=0 ) const
Predicts the output for the input sample.
@@ -161,7 +161,7 @@ The input parameters of the prediction method are the same as in ``CvDTree::pred
CvRTrees::get_var_importance
----------------------------
.. cfunction:: const CvMat* CvRTrees::get_var_importance() const
.. c:function:: const CvMat* CvRTrees::get_var_importance() const
Retrieves the variable importance array.
@@ -173,7 +173,7 @@ The method returns the variable importance vector, computed at the training stag
CvRTrees::get_proximity
-----------------------
.. cfunction:: float CvRTrees::get_proximity( const CvMat* sample_1, const CvMat* sample_2 ) const
.. c:function:: float CvRTrees::get_proximity( const CvMat* sample_1, const CvMat* sample_2 ) const
Retrieves the proximity measure between two training samples.
+11 -11
View File
@@ -9,7 +9,7 @@ Statistical Models
CvStatModel
-----------
.. ctype:: CvStatModel
.. c:type:: CvStatModel
Base class for the statistical models in ML. ::
@@ -48,7 +48,7 @@ In this declaration some methods are commented off. Actually, these are methods
CvStatModel::CvStatModel
------------------------
.. cfunction:: CvStatModel::CvStatModel()
.. c:function:: CvStatModel::CvStatModel()
Default constructor.
@@ -60,7 +60,7 @@ Each statistical model class in ML has a default constructor without parameters.
CvStatModel::CvStatModel(...)
-----------------------------
.. cfunction:: CvStatModel::CvStatModel( const CvMat* train_data ... )
.. c:function:: CvStatModel::CvStatModel( const CvMat* train_data ... )
Training constructor.
@@ -72,7 +72,7 @@ Most ML classes provide single-step construct and train constructors. This const
CvStatModel::~CvStatModel
-------------------------
.. cfunction:: CvStatModel::~CvStatModel()
.. c:function:: CvStatModel::~CvStatModel()
Virtual destructor.
@@ -95,7 +95,7 @@ Normally, the destructor of each derived class does nothing, but in this instanc
CvStatModel::clear
------------------
.. cfunction:: void CvStatModel::clear()
.. c:function:: void CvStatModel::clear()
Deallocates memory and resets the model state.
@@ -107,7 +107,7 @@ The method ``clear`` does the same job as the destructor; it deallocates all the
CvStatModel::save
-----------------
.. cfunction:: void CvStatModel::save( const char* filename, const char* name=0 )
.. c:function:: void CvStatModel::save( const char* filename, const char* name=0 )
Saves the model to a file.
@@ -119,7 +119,7 @@ The method ``save`` stores the complete model state to the specified XML or YAML
CvStatModel::load
-----------------
.. cfunction:: void CvStatModel::load( const char* filename, const char* name=0 )
.. c:function:: void CvStatModel::load( const char* filename, const char* name=0 )
Loads the model from a file.
@@ -135,7 +135,7 @@ cross{cvLoad}, here the model type must be known, because an empty model must be
CvStatModel::write
------------------
.. cfunction:: void CvStatModel::write( CvFileStorage* storage, const char* name )
.. c:function:: void CvStatModel::write( CvFileStorage* storage, const char* name )
Writes the model to file storage.
@@ -147,7 +147,7 @@ The method ``write`` stores the complete model state to the file storage with th
CvStatModel::read
-----------------
.. cfunction:: void CvStatMode::read( CvFileStorage* storage, CvFileNode* node )
.. c:function:: void CvStatMode::read( CvFileStorage* storage, CvFileNode* node )
Reads the model from file storage.
@@ -162,7 +162,7 @@ The previous model state is cleared by ``clear()`` .
CvStatModel::train
------------------
.. cfunction:: bool CvStatMode::train( const CvMat* train_data, [int tflag,] ..., const CvMat* responses, ..., [const CvMat* var_idx,] ..., [const CvMat* sample_idx,] ... [const CvMat* var_type,] ..., [const CvMat* missing_mask,] <misc_training_alg_params> ... )
.. c:function:: bool CvStatMode::train( const CvMat* train_data, [int tflag,] ..., const CvMat* responses, ..., [const CvMat* var_idx,] ..., [const CvMat* sample_idx,] ... [const CvMat* var_type,] ..., [const CvMat* missing_mask,] <misc_training_alg_params> ... )
Trains the model.
@@ -194,7 +194,7 @@ Usually, the previous model state is cleared by ``clear()`` before running the t
CvStatModel::predict
--------------------
.. cfunction:: float CvStatMode::predict( const CvMat* sample[, <prediction_params>] ) const
.. c:function:: float CvStatMode::predict( const CvMat* sample[, <prediction_params>] ) const
Predicts the response for the sample.
+8 -8
View File
@@ -27,7 +27,7 @@ There are a lot of good references on SVM. Here are only a few ones to start wit
CvSVM
-----
.. ctype:: CvSVM
.. c:type:: CvSVM
Support Vector Machines. ::
@@ -90,7 +90,7 @@ Support Vector Machines. ::
CvSVMParams
-----------
.. ctype:: CvSVMParams
.. c:type:: CvSVMParams
SVM training parameters. ::
@@ -125,7 +125,7 @@ The structure must be initialized and passed to the training method of
CvSVM::train
------------
.. cfunction:: bool CvSVM::train( const CvMat* _train_data, const CvMat* _responses, const CvMat* _var_idx=0, const CvMat* _sample_idx=0, CvSVMParams _params=CvSVMParams() )
.. c:function:: bool CvSVM::train( const CvMat* _train_data, const CvMat* _responses, const CvMat* _var_idx=0, const CvMat* _sample_idx=0, CvSVMParams _params=CvSVMParams() )
Trains SVM.
@@ -140,7 +140,7 @@ All the other parameters are gathered in
CvSVM::train_auto
-----------------
.. cfunction:: train_auto( const CvMat* _train_data, const CvMat* _responses, const CvMat* _var_idx, const CvMat* _sample_idx, CvSVMParams params, int k_fold = 10, CvParamGrid C_grid = get_default_grid(CvSVM::C), CvParamGrid gamma_grid = get_default_grid(CvSVM::GAMMA), CvParamGrid p_grid = get_default_grid(CvSVM::P), CvParamGrid nu_grid = get_default_grid(CvSVM::NU), CvParamGrid coef_grid = get_default_grid(CvSVM::COEF), CvParamGrid degree_grid = get_default_grid(CvSVM::DEGREE) )
.. c:function:: train_auto( const CvMat* _train_data, const CvMat* _responses, const CvMat* _var_idx, const CvMat* _sample_idx, CvSVMParams params, int k_fold = 10, CvParamGrid C_grid = get_default_grid(CvSVM::C), CvParamGrid gamma_grid = get_default_grid(CvSVM::GAMMA), CvParamGrid p_grid = get_default_grid(CvSVM::P), CvParamGrid nu_grid = get_default_grid(CvSVM::NU), CvParamGrid coef_grid = get_default_grid(CvSVM::COEF), CvParamGrid degree_grid = get_default_grid(CvSVM::DEGREE) )
Trains SVM with optimal parameters.
@@ -182,7 +182,7 @@ as well as for the regression
CvSVM::get_default_grid
-----------------------
.. cfunction:: CvParamGrid CvSVM::get_default_grid( int param_id )
.. c:function:: CvParamGrid CvSVM::get_default_grid( int param_id )
Generates a grid for the SVM parameters.
@@ -211,7 +211,7 @@ The function generates a grid for the specified parameter of the SVM algorithm.
CvSVM::get_params
-----------------
.. cfunction:: CvSVMParams CvSVM::get_params() const
.. c:function:: CvSVMParams CvSVM::get_params() const
Returns the current SVM parameters.
@@ -223,9 +223,9 @@ This function may be used to get the optimal parameters that were obtained while
CvSVM::get_support_vector*
--------------------------
.. cfunction:: int CvSVM::get_support_vector_count() const
.. c:function:: int CvSVM::get_support_vector_count() const
.. cfunction:: const float* CvSVM::get_support_vector(int i) const
.. c:function:: const float* CvSVM::get_support_vector(int i) const
Retrieves the number of support vectors and the particular vector.