View Source Evision.ML.RTrees (Evision v0.1.11)
Link to this section Summary
Types
Type that represents an Evision.ML.RTrees
struct.
Functions
Computes error on the training or test dataset
Computes error on the training or test dataset
Clears the algorithm state
Return
- retval:
Evision.ML.RTrees
Creates the empty model. Use StatModel::train to train the model, StatModel::train to create and train the model, Algorithm::load to load the pre-trained model.
Return
- retval:
bool
Python prototype (for reference):
Return
- retval:
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.
Return
- retval:
double
Returns the OOB error value, computed at the training stage when calcOOBError is set to true. If this flag was set to false, 0 is returned. The OOB error is also scaled by sample weighting.
Returns the number of variables in training samples
Return
- retval:
Evision.Mat
Returns the variable importance array. The method returns the variable importance vector, computed at the training stage when CalculateVarImportance is set to true. If this flag was set to false, the empty matrix is returned.
Positional Arguments
samples:
Evision.Mat
.
Positional Arguments
samples:
Evision.Mat
.
Returns true if the model is classifier
Returns true if the model is trained
Loads and creates a serialized RTree from a file
Loads and creates a serialized RTree from a file
Predicts response(s) for the provided sample(s)
Predicts response(s) for the provided sample(s)
Reads algorithm parameters from a file storage
Positional Arguments
- filename:
String
Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).
Trains the statistical model
Trains the statistical model
Trains the statistical model
simplified API for language bindings
simplified API for language bindings
Link to this section Types
@type t() :: %Evision.ML.RTrees{ref: reference()}
Type that represents an Evision.ML.RTrees
struct.
ref.
reference()
The underlying erlang resource variable.
Link to this section Functions
@spec calcError(t(), Evision.ML.TrainData.t(), boolean()) :: {number(), Evision.Mat.t()} | {:error, String.t()}
Computes error on the training or test dataset
Positional Arguments
data:
Evision.ML.TrainData
.the training data
test:
bool
.if true, the error is computed over the test subset of the data, otherwise it's computed over the training subset of the data. Please note that if you loaded a completely different dataset to evaluate already trained classifier, you will probably want not to set the test subset at all with TrainData::setTrainTestSplitRatio and specify test=false, so that the error is computed for the whole new set. Yes, this sounds a bit confusing.
Return
retval:
float
resp:
Evision.Mat
.the optional output responses.
The method uses StatModel::predict to compute the error. For regression models the error is computed as RMS, for classifiers - as a percent of missclassified samples (0%-100%).
Python prototype (for reference):
calcError(data, test[, resp]) -> retval, resp
@spec calcError( t(), Evision.ML.TrainData.t(), boolean(), [{atom(), term()}, ...] | nil ) :: {number(), Evision.Mat.t()} | {:error, String.t()}
Computes error on the training or test dataset
Positional Arguments
data:
Evision.ML.TrainData
.the training data
test:
bool
.if true, the error is computed over the test subset of the data, otherwise it's computed over the training subset of the data. Please note that if you loaded a completely different dataset to evaluate already trained classifier, you will probably want not to set the test subset at all with TrainData::setTrainTestSplitRatio and specify test=false, so that the error is computed for the whole new set. Yes, this sounds a bit confusing.
Return
retval:
float
resp:
Evision.Mat
.the optional output responses.
The method uses StatModel::predict to compute the error. For regression models the error is computed as RMS, for classifiers - as a percent of missclassified samples (0%-100%).
Python prototype (for reference):
calcError(data, test[, resp]) -> retval, resp
Clears the algorithm state
Python prototype (for reference):
clear() -> None
Return
- retval:
Evision.ML.RTrees
Creates the empty model. Use StatModel::train to train the model, StatModel::train to create and train the model, Algorithm::load to load the pre-trained model.
Python prototype (for reference):
create() -> retval
Return
- retval:
bool
Python prototype (for reference):
empty() -> retval
Return
- retval:
int
@see setActiveVarCount/2
Python prototype (for reference):
getActiveVarCount() -> retval
Return
- retval:
bool
@see setCalculateVarImportance/2
Python prototype (for reference):
getCalculateVarImportance() -> retval
Return
- retval:
int
@see setCVFolds/2
Python prototype (for reference):
getCVFolds() -> retval
Return
- retval:
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.
Python prototype (for reference):
getDefaultName() -> retval
Return
- retval:
int
@see setMaxCategories/2
Python prototype (for reference):
getMaxCategories() -> retval
Return
- retval:
int
@see setMaxDepth/2
Python prototype (for reference):
getMaxDepth() -> retval
Return
- retval:
int
@see setMinSampleCount/2
Python prototype (for reference):
getMinSampleCount() -> retval
Return
- retval:
double
Returns the OOB error value, computed at the training stage when calcOOBError is set to true. If this flag was set to false, 0 is returned. The OOB error is also scaled by sample weighting.
Python prototype (for reference):
getOOBError() -> retval
@spec getPriors(t()) :: Evision.Mat.t() | {:error, String.t()}
Return
- retval:
cv::Mat
@see setPriors/2
Python prototype (for reference):
getPriors() -> retval
Return
- retval:
float
Python prototype (for reference):
getRegressionAccuracy() -> retval
Return
- retval:
TermCriteria
@see setTermCriteria/2
Python prototype (for reference):
getTermCriteria() -> retval
Return
- retval:
bool
Python prototype (for reference):
getTruncatePrunedTree() -> retval
Return
- retval:
bool
@see setUse1SERule/2
Python prototype (for reference):
getUse1SERule() -> retval
Return
- retval:
bool
@see setUseSurrogates/2
Python prototype (for reference):
getUseSurrogates() -> retval
Returns the number of variables in training samples
Return
- retval:
int
Python prototype (for reference):
getVarCount() -> retval
@spec getVarImportance(t()) :: Evision.Mat.t() | {:error, String.t()}
Return
- retval:
Evision.Mat
Returns the variable importance array. The method returns the variable importance vector, computed at the training stage when CalculateVarImportance is set to true. If this flag was set to false, the empty matrix is returned.
Python prototype (for reference):
getVarImportance() -> retval
@spec getVotes(t(), Evision.Mat.maybe_mat_in(), integer()) :: Evision.Mat.t() | {:error, String.t()}
Positional Arguments
samples:
Evision.Mat
.Array containing the samples for which votes will be calculated.
flags:
int
.Flags for defining the type of RTrees.
Return
results:
Evision.Mat
.Array where the result of the calculation will be written.
Returns the result of each individual tree in the forest. In case the model is a regression problem, the method will return each of the trees' results for each of the sample cases. If the model is a classifier, it will return a Mat with samples + 1 rows, where the first row gives the class number and the following rows return the votes each class had for each sample.
Python prototype (for reference):
getVotes(samples, flags[, results]) -> results
@spec getVotes( t(), Evision.Mat.maybe_mat_in(), integer(), [{atom(), term()}, ...] | nil ) :: Evision.Mat.t() | {:error, String.t()}
Positional Arguments
samples:
Evision.Mat
.Array containing the samples for which votes will be calculated.
flags:
int
.Flags for defining the type of RTrees.
Return
results:
Evision.Mat
.Array where the result of the calculation will be written.
Returns the result of each individual tree in the forest. In case the model is a regression problem, the method will return each of the trees' results for each of the sample cases. If the model is a classifier, it will return a Mat with samples + 1 rows, where the first row gives the class number and the following rows return the votes each class had for each sample.
Python prototype (for reference):
getVotes(samples, flags[, results]) -> results
Returns true if the model is classifier
Return
- retval:
bool
Python prototype (for reference):
isClassifier() -> retval
Returns true if the model is trained
Return
- retval:
bool
Python prototype (for reference):
isTrained() -> retval
Loads and creates a serialized RTree from a file
Positional Arguments
filepath:
String
.path to serialized RTree
Keyword Arguments
nodeName:
String
.name of node containing the classifier
Return
- retval:
Evision.ML.RTrees
Use RTree::save to serialize and store an RTree to disk. Load the RTree from this file again, by calling this function with the path to the file. Optionally specify the node for the file containing the classifier
Python prototype (for reference):
load(filepath[, nodeName]) -> retval
Loads and creates a serialized RTree from a file
Positional Arguments
filepath:
String
.path to serialized RTree
Keyword Arguments
nodeName:
String
.name of node containing the classifier
Return
- retval:
Evision.ML.RTrees
Use RTree::save to serialize and store an RTree to disk. Load the RTree from this file again, by calling this function with the path to the file. Optionally specify the node for the file containing the classifier
Python prototype (for reference):
load(filepath[, nodeName]) -> retval
@spec predict(t(), Evision.Mat.maybe_mat_in()) :: {number(), Evision.Mat.t()} | {:error, String.t()}
Predicts response(s) for the provided sample(s)
Positional Arguments
samples:
Evision.Mat
.The input samples, floating-point matrix
Keyword Arguments
flags:
int
.The optional flags, model-dependent. See cv::ml::StatModel::Flags.
Return
retval:
float
results:
Evision.Mat
.The optional output matrix of results.
Python prototype (for reference):
predict(samples[, results[, flags]]) -> retval, results
@spec predict(t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil) :: {number(), Evision.Mat.t()} | {:error, String.t()}
Predicts response(s) for the provided sample(s)
Positional Arguments
samples:
Evision.Mat
.The input samples, floating-point matrix
Keyword Arguments
flags:
int
.The optional flags, model-dependent. See cv::ml::StatModel::Flags.
Return
retval:
float
results:
Evision.Mat
.The optional output matrix of results.
Python prototype (for reference):
predict(samples[, results[, flags]]) -> retval, results
@spec read(t(), Evision.FileNode.t()) :: :ok | {:error, String.t()}
Reads algorithm parameters from a file storage
Positional Arguments
- fn_:
Evision.FileNode
Python prototype (for reference):
read(fn_) -> None
Positional Arguments
- filename:
String
Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).
Python prototype (for reference):
save(filename) -> None
Positional Arguments
- val:
int
@see getActiveVarCount/1
Python prototype (for reference):
setActiveVarCount(val) -> None
Positional Arguments
- val:
bool
@see getCalculateVarImportance/1
Python prototype (for reference):
setCalculateVarImportance(val) -> None
Positional Arguments
- val:
int
@see getCVFolds/1
Python prototype (for reference):
setCVFolds(val) -> None
Positional Arguments
- val:
int
@see getMaxCategories/1
Python prototype (for reference):
setMaxCategories(val) -> None
Positional Arguments
- val:
int
@see getMaxDepth/1
Python prototype (for reference):
setMaxDepth(val) -> None
Positional Arguments
- val:
int
@see getMinSampleCount/1
Python prototype (for reference):
setMinSampleCount(val) -> None
@spec setPriors(t(), Evision.Mat.maybe_mat_in()) :: :ok | {:error, String.t()}
Positional Arguments
- val:
Evision.Mat
@see getPriors/1
Python prototype (for reference):
setPriors(val) -> None
Positional Arguments
- val:
float
Python prototype (for reference):
setRegressionAccuracy(val) -> None
Positional Arguments
- val:
TermCriteria
@see getTermCriteria/1
Python prototype (for reference):
setTermCriteria(val) -> None
Positional Arguments
- val:
bool
Python prototype (for reference):
setTruncatePrunedTree(val) -> None
Positional Arguments
- val:
bool
@see getUse1SERule/1
Python prototype (for reference):
setUse1SERule(val) -> None
Positional Arguments
- val:
bool
@see getUseSurrogates/1
Python prototype (for reference):
setUseSurrogates(val) -> None
@spec train(t(), Evision.ML.TrainData.t()) :: boolean() | {:error, String.t()}
Trains the statistical model
Positional Arguments
trainData:
Evision.ML.TrainData
.training data that can be loaded from file using TrainData::loadFromCSV or created with TrainData::create.
Keyword Arguments
flags:
int
.optional flags, depending on the model. Some of the models can be updated with the new training samples, not completely overwritten (such as NormalBayesClassifier or ANN_MLP).
Return
- retval:
bool
Python prototype (for reference):
train(trainData[, flags]) -> retval
@spec train(t(), Evision.ML.TrainData.t(), [{atom(), term()}, ...] | nil) :: boolean() | {:error, String.t()}
Trains the statistical model
Positional Arguments
trainData:
Evision.ML.TrainData
.training data that can be loaded from file using TrainData::loadFromCSV or created with TrainData::create.
Keyword Arguments
flags:
int
.optional flags, depending on the model. Some of the models can be updated with the new training samples, not completely overwritten (such as NormalBayesClassifier or ANN_MLP).
Return
- retval:
bool
Python prototype (for reference):
train(trainData[, flags]) -> retval
@spec train(t(), Evision.Mat.maybe_mat_in(), integer(), Evision.Mat.maybe_mat_in()) :: boolean() | {:error, String.t()}
Trains the statistical model
Positional Arguments
samples:
Evision.Mat
.training samples
layout:
int
.See ml::SampleTypes.
responses:
Evision.Mat
.vector of responses associated with the training samples.
Return
- retval:
bool
Python prototype (for reference):
train(samples, layout, responses) -> retval
@spec write(t(), Evision.FileStorage.t()) :: :ok | {:error, String.t()}
simplified API for language bindings
Positional Arguments
Keyword Arguments
- name:
String
.
Has overloading in C++
Python prototype (for reference):
write(fs[, name]) -> None
@spec write(t(), Evision.FileStorage.t(), [{atom(), term()}, ...] | nil) :: :ok | {:error, String.t()}
simplified API for language bindings
Positional Arguments
Keyword Arguments
- name:
String
.
Has overloading in C++
Python prototype (for reference):
write(fs[, name]) -> None