org.bytedeco.opencv.opencv_ml

Class StatModel

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_ml.AbstractStatModel

org.bytedeco.opencv.opencv_ml.StatModel

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ANN_MLP, DTrees, EM, KNearest, LogisticRegression, NormalBayesClassifier, SVM, SVMSGD

@Namespace(value="cv::ml")
 @Properties(inherit=opencv_ml.class)
public class StatModel
extends AbstractStatModel

\brief Base class for statistical models in OpenCV ML.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPRESSED_INPUT enum cv::ml::StatModel::Flags
static int	PREPROCESSED_INPUT enum cv::ml::StatModel::Flags
static int	RAW_OUTPUT enum cv::ml::StatModel::Flags
static int	UPDATE_MODEL enum cv::ml::StatModel::Flags

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
StatModel(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
float	calcError(TrainData data, boolean test, GpuMat resp)
float	calcError(TrainData data, boolean test, Mat resp) \brief Computes error on the training or test dataset
float	calcError(TrainData data, boolean test, UMat resp)
boolean	empty() \brief Returns true if the Algorithm is empty (e.g.
int	getVarCount() \brief Returns the number of variables in training samples
boolean	isClassifier() \brief Returns true if the model is classifier
boolean	isTrained() \brief Returns true if the model is trained
float	predict(GpuMat samples)
float	predict(GpuMat samples, GpuMat results, int flags)
float	predict(Mat samples)
float	predict(Mat samples, Mat results, int flags) \brief Predicts response(s) for the provided sample(s)
float	predict(UMat samples)
float	predict(UMat samples, UMat results, int flags)
boolean	train(GpuMat samples, int layout, GpuMat responses)
boolean	train(Mat samples, int layout, Mat responses) \brief Trains the statistical model
boolean	train(TrainData trainData)
boolean	train(TrainData trainData, int flags) \brief Trains the statistical model
boolean	train(UMat samples, int layout, UMat responses)

Methods inherited from class org.bytedeco.opencv.opencv_ml.AbstractStatModel

loadANN_MLP, loadANN_MLP, loadBoost, loadBoost, loadDTrees, loadDTrees, loadEM, loadEM, loadKNearest, loadKNearest, loadLogisticRegression, loadLogisticRegression, loadNormalBayesClassifier, loadNormalBayesClassifier, loadRTrees, loadRTrees, loadSVM, loadSVM

Methods inherited from class org.bytedeco.opencv.opencv_core.Algorithm

clear, getDefaultName, position, read, save, save, write, write, write

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UPDATE_MODEL

public static final int UPDATE_MODEL

enum cv::ml::StatModel::Flags

See Also:

Constant Field Values

RAW_OUTPUT

public static final int RAW_OUTPUT

enum cv::ml::StatModel::Flags

See Also:

Constant Field Values

COMPRESSED_INPUT

public static final int COMPRESSED_INPUT

enum cv::ml::StatModel::Flags

See Also:

Constant Field Values

PREPROCESSED_INPUT

public static final int PREPROCESSED_INPUT

enum cv::ml::StatModel::Flags

See Also:

Constant Field Values

Constructor Detail

StatModel

public StatModel(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

getVarCount

public int getVarCount()

\brief Returns the number of variables in training samples

empty

@Cast(value="bool")
public boolean empty()

Description copied from class: Algorithm

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

Overrides:

empty in class Algorithm

isTrained

@Cast(value="bool")
public boolean isTrained()

\brief Returns true if the model is trained

isClassifier

@Cast(value="bool")
public boolean isClassifier()

\brief Returns true if the model is classifier

train

@Cast(value="bool")
public boolean train(@opencv_core.Ptr
                                         TrainData trainData,
                                         int flags)

\brief Trains the statistical model

Parameters:

trainData - training data that can be loaded from file using TrainData::loadFromCSV or created with TrainData::create.

flags - 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).

train

@Cast(value="bool")
public boolean train(@opencv_core.Ptr
                                         TrainData trainData)

train

@Cast(value="bool")
public boolean train(@ByVal
                                         Mat samples,
                                         int layout,
                                         @ByVal
                                         Mat responses)

\brief Trains the statistical model

Parameters:

samples - training samples

layout - See ml::SampleTypes.

responses - vector of responses associated with the training samples.

train

@Cast(value="bool")
public boolean train(@ByVal
                                         UMat samples,
                                         int layout,
                                         @ByVal
                                         UMat responses)

train

@Cast(value="bool")
public boolean train(@ByVal
                                         GpuMat samples,
                                         int layout,
                                         @ByVal
                                         GpuMat responses)

calcError

public float calcError(@opencv_core.Ptr
                       TrainData data,
                       @Cast(value="bool")
                       boolean test,
                       @ByVal
                       Mat resp)

\brief Computes error on the training or test dataset

Parameters:

data - the training data

test - 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.

resp - 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%).

calcError

public float calcError(@opencv_core.Ptr
                       TrainData data,
                       @Cast(value="bool")
                       boolean test,
                       @ByVal
                       UMat resp)

calcError

public float calcError(@opencv_core.Ptr
                       TrainData data,
                       @Cast(value="bool")
                       boolean test,
                       @ByVal
                       GpuMat resp)

predict

public float predict(@ByVal
                     Mat samples,
                     @ByVal(nullValue="cv::OutputArray(cv::noArray())")
                     Mat results,
                     int flags)

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

Parameters:

samples - The input samples, floating-point matrix

results - The optional output matrix of results.

flags - The optional flags, model-dependent. See cv::ml::StatModel::Flags.

predict

public float predict(@ByVal
                     Mat samples)

predict

public float predict(@ByVal
                     UMat samples,
                     @ByVal(nullValue="cv::OutputArray(cv::noArray())")
                     UMat results,
                     int flags)

predict

public float predict(@ByVal
                     UMat samples)

predict

public float predict(@ByVal
                     GpuMat samples,
                     @ByVal(nullValue="cv::OutputArray(cv::noArray())")
                     GpuMat results,
                     int flags)

predict

public float predict(@ByVal
                     GpuMat samples)