Class: OpenCV::Cv::Ml::KNearest

Inherits:
Object
  • Object
show all
Extended by:
FFI::DataConverter
Defined in:
lib/ropencv/ropencv_types.rb

Constants collapse

BRUTE_FORCE = 
1
KDTREE = 
2

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create ⇒ Cv::Ptr::Cv_Ml_KNearest

Note:

wrapper for static method const cv::Ptrcv::ml::KNearest cv::ml::KNearest::create()

Returns:



48114
48115
48116
 
# File 'lib/ropencv/ropencv_types.rb', line 48114

def self.create()
    Rbind::cv_ml_k_nearest_create()
end

.load(filepath) ⇒ Cv::Ptr::Cv_Ml_KNearest

Note:

wrapper for static method const cv::Ptrcv::ml::KNearest cv::ml::KNearest::load(const std::string filepath)

Parameters:

Returns:



48121
48122
48123
 
# File 'lib/ropencv/ropencv_types.rb', line 48121

def self.load(filepath)
    Rbind::cv_ml_k_nearest_load(filepath)
end

.new(*args) ⇒ Object

Raises:

  • (ArgumentError) 


47947
47948
47949
47950
47951
47952
47953
47954
 
# File 'lib/ropencv/ropencv_types.rb', line 47947

def self.new(*args)
    if args.first.is_a?(FFI::Pointer) || args.first.is_a?(KNearestStruct)
        raise ArgumentError, "too many arguments for creating #{self.name} from Pointer" unless args.size == 1
        return super(args.first)
    end

    raise ArgumentError, "no constructor for #{self}(#{args.inspect})"
end

.null ⇒ Object

returns a null pointer to the object



47943
47944
47945
 
# File 'lib/ropencv/ropencv_types.rb', line 47943

def self.null
    new(KNearestStruct.new)
end

Instance Method Details

#calc_error(data, test, resp) ⇒ Float Also known as: calcError

Note:

method wrapper for float cv::ml::KNearest::calcError(const cv::Ptrcv::ml::TrainData data, bool test, cv::Mat& resp)

Parameters:

Returns:

  • (Float) 


48219
48220
48221
48222
 
# File 'lib/ropencv/ropencv_types.rb', line 48219

def calc_error(data, test, resp)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_calc_error( self, data, test, resp)
end

#cast_to_algorithm(parse_ownership) ⇒ Cv::Algorithm Also known as: castToAlgorithm

Note:

method wrapper for cv::Algorithm* cv::ml::KNearest::castToAlgorithm(bool parse_ownership)

Parameters:

  • parse_ownership (Bool)

Returns:



48238
48239
48240
48241
48242
48243
48244
48245
48246
 
# File 'lib/ropencv/ropencv_types.rb', line 48238

def cast_to_algorithm(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_ml_k_nearest_cast_to_algorithm( self, parse_ownership)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#cast_to_stat_model(parse_ownership) ⇒ Cv::Ml::StatModel Also known as: castToStatModel

Note:

method wrapper for cv::ml::StatModel* cv::ml::KNearest::castToStatModel(bool parse_ownership)

Parameters:

  • parse_ownership (Bool)

Returns:



48128
48129
48130
48131
48132
48133
48134
48135
48136
 
# File 'lib/ropencv/ropencv_types.rb', line 48128

def cast_to_stat_model(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_ml_k_nearest_cast_to_stat_model( self, parse_ownership)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#clear ⇒ Void

Note:

method wrapper for void cv::ml::KNearest::clear()

Returns:

  • (Void) 


48251
48252
48253
48254
 
# File 'lib/ropencv/ropencv_types.rb', line 48251

def clear()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_clear( self)
end

#empty ⇒ Bool

Note:

method wrapper for bool cv::ml::KNearest::empty()

Returns:

  • (Bool) 


48149
48150
48151
48152
 
# File 'lib/ropencv/ropencv_types.rb', line 48149

def empty()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_empty( self)
end

#find_nearest(samples, k, results, neighbor_responses = Cv::Mat.new(), dist = Cv::Mat.new()) ⇒ Float Also known as: findNearest

Note:

method wrapper for float cv::ml::KNearest::findNearest(const cv::Mat samples, int k, cv::Mat& results, const cv::Mat neighborResponses = Mat()/O, const cv::Mat dist = Mat()/O)

Parameters:

  • samples (Cv::Mat)
  • k (Fixnum)
  • results (Cv::Mat)
  • neighbor_responses (Cv::Mat) (defaults to: Cv::Mat.new())
  • dist (Cv::Mat) (defaults to: Cv::Mat.new())

Returns:

  • (Float) 


48106
48107
48108
48109
 
# File 'lib/ropencv/ropencv_types.rb', line 48106

def find_nearest(samples, k, results, neighbor_responses = Cv::Mat.new(), dist = Cv::Mat.new())
    __validate_pointer__
    Rbind::cv_ml_k_nearest_find_nearest( self, samples, k, results, neighbor_responses, dist)
end

#get_algorithm_type ⇒ Fixnum Also known as: getAlgorithmType

Note:

method wrapper for int cv::ml::KNearest::getAlgorithmType()

Returns:

  • (Fixnum) 


48084
48085
48086
48087
 
# File 'lib/ropencv/ropencv_types.rb', line 48084

def get_algorithm_type()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_get_algorithm_type( self)
end

#get_default_name ⇒ Std::String Also known as: getDefaultName

Note:

method wrapper for const std::string cv::ml::KNearest::getDefaultName()

Returns:



48283
48284
48285
48286
48287
48288
48289
48290
48291
 
# File 'lib/ropencv/ropencv_types.rb', line 48283

def get_default_name()
    __validate_pointer__
    result = Rbind::cv_ml_k_nearest_get_default_name( self)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#get_defaultk ⇒ Fixnum Also known as: getDefaultK

Note:

method wrapper for int cv::ml::KNearest::getDefaultK()

methods

Returns:

  • (Fixnum) 


48033
48034
48035
48036
 
# File 'lib/ropencv/ropencv_types.rb', line 48033

def get_defaultk()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_get_defaultk( self)
end

#get_emax ⇒ Fixnum Also known as: getEmax

Note:

method wrapper for int cv::ml::KNearest::getEmax()

Returns:

  • (Fixnum) 


48067
48068
48069
48070
 
# File 'lib/ropencv/ropencv_types.rb', line 48067

def get_emax()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_get_emax( self)
end

#get_is_classifier ⇒ Bool Also known as: getIsClassifier

Note:

method wrapper for bool cv::ml::KNearest::getIsClassifier()

Returns:

  • (Bool) 


48050
48051
48052
48053
 
# File 'lib/ropencv/ropencv_types.rb', line 48050

def get_is_classifier()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_get_is_classifier( self)
end

#get_var_count ⇒ Fixnum Also known as: getVarCount

Note:

method wrapper for int cv::ml::KNearest::getVarCount()

Returns:

  • (Fixnum) 


48141
48142
48143
48144
 
# File 'lib/ropencv/ropencv_types.rb', line 48141

def get_var_count()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_get_var_count( self)
end

#is_classifier ⇒ Bool Also known as: isClassifier

Note:

method wrapper for bool cv::ml::KNearest::isClassifier()

Returns:

  • (Bool) 


48164
48165
48166
48167
 
# File 'lib/ropencv/ropencv_types.rb', line 48164

def is_classifier()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_is_classifier( self)
end

#is_trained ⇒ Bool Also known as: isTrained

Note:

method wrapper for bool cv::ml::KNearest::isTrained()

Returns:

  • (Bool) 


48156
48157
48158
48159
 
# File 'lib/ropencv/ropencv_types.rb', line 48156

def is_trained()
    __validate_pointer__
    Rbind::cv_ml_k_nearest_is_trained( self)
end

#predict(samples, results = Cv::Mat.new(), flags = 0) ⇒ Float

Note:

method wrapper for float cv::ml::KNearest::predict(const cv::Mat samples, const cv::Mat results = Mat()/O, int flags = 0)

Parameters:

  • samples (Cv::Mat)
  • results (Cv::Mat) (defaults to: Cv::Mat.new())
  • flags (Fixnum) (defaults to: 0)

Returns:

  • (Float) 


48230
48231
48232
48233
 
# File 'lib/ropencv/ropencv_types.rb', line 48230

def predict(samples, results = Cv::Mat.new(), flags = 0)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_predict( self, samples, results, flags)
end

#read(fn) ⇒ Void

Note:

method wrapper for void cv::ml::KNearest::read(const cv::FileNode fn)

Parameters:

Returns:

  • (Void) 


48268
48269
48270
48271
 
# File 'lib/ropencv/ropencv_types.rb', line 48268

def read(fn)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_read( self, fn)
end

#save(filename) ⇒ Void

Note:

method wrapper for void cv::ml::KNearest::save(const std::string filename)

Parameters:

Returns:

  • (Void) 


48276
48277
48278
48279
 
# File 'lib/ropencv/ropencv_types.rb', line 48276

def save(filename)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_save( self, filename)
end

#set_algorithm_type(val) ⇒ Void Also known as: setAlgorithmType

Note:

method wrapper for void cv::ml::KNearest::setAlgorithmType(int val)

Parameters:

  • val (Fixnum)

Returns:

  • (Void) 


48093
48094
48095
48096
 
# File 'lib/ropencv/ropencv_types.rb', line 48093

def set_algorithm_type(val)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_set_algorithm_type( self, val)
end

#set_defaultk(val) ⇒ Void Also known as: setDefaultK

Note:

method wrapper for void cv::ml::KNearest::setDefaultK(int val)

Parameters:

  • val (Fixnum)

Returns:

  • (Void) 


48042
48043
48044
48045
 
# File 'lib/ropencv/ropencv_types.rb', line 48042

def set_defaultk(val)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_set_defaultk( self, val)
end

#set_emax(val) ⇒ Void Also known as: setEmax

Note:

method wrapper for void cv::ml::KNearest::setEmax(int val)

Parameters:

  • val (Fixnum)

Returns:

  • (Void) 


48076
48077
48078
48079
 
# File 'lib/ropencv/ropencv_types.rb', line 48076

def set_emax(val)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_set_emax( self, val)
end

#set_is_classifier(val) ⇒ Void Also known as: setIsClassifier

Note:

method wrapper for void cv::ml::KNearest::setIsClassifier(bool val)

Parameters:

  • val (Bool)

Returns:

  • (Void) 


48059
48060
48061
48062
 
# File 'lib/ropencv/ropencv_types.rb', line 48059

def set_is_classifier(val)
    __validate_pointer__
    Rbind::cv_ml_k_nearest_set_is_classifier( self, val)
end

#to_s ⇒ Object

converts KNearest into a string by crawling through all its attributes



48020
48021
48022
 
# File 'lib/ropencv/ropencv_types.rb', line 48020

def to_s
    "#<cv::ml::KNearest >"
end

#train(train_data, flags = 0) ⇒ Bool #train(samples, layout, responses) ⇒ Bool

Note:

wrapper for overloaded method train

Overloads:

  • #train(train_data, flags = 0) ⇒ Bool

    Parameters:

    Returns:

    • (Bool)
  • #train(samples, layout, responses) ⇒ Bool

    Parameters:

    Returns:

    • (Bool)

Raises:

  • (ArgumentError) 


48181
48182
48183
48184
48185
48186
48187
48188
48189
48190
48191
48192
48193
48194
48195
48196
48197
48198
48199
48200
48201
48202
48203
48204
48205
48206
48207
48208
48209
48210
48211
48212
 
# File 'lib/ropencv/ropencv_types.rb', line 48181

def train(*args)
    __validate_pointer__
    # overloaded method wrapper for bool cv::ml::KNearest::train(const cv::Ptr<cv::ml::TrainData> trainData, int flags = 0)
    @@cv_ml_k_nearest_train_defaults0 ||= [nil, 0]
    if(args.size >= 1 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_ml_k_nearest_train_defaults0[i]
        end
        begin
                return Rbind::cv_ml_k_nearest_train(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::ml::KNearest::train(const cv::Mat samples, int layout, const cv::Mat responses)
    @@cv_ml_k_nearest_train__2_defaults1 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_ml_k_nearest_train__2_defaults1[i]
        end
        begin
                return Rbind::cv_ml_k_nearest_train__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    raise ArgumentError, "No overloaded signature fits to: #{args.map(&:class)}"
end

#write(fs, name = Std::String.new()) ⇒ Void

Note:

method wrapper for void cv::ml::KNearest::write(const cv::Ptrcv::FileStorage fs, const std::string name = String())

Parameters:

Returns:

  • (Void) 


48260
48261
48262
48263
 
# File 'lib/ropencv/ropencv_types.rb', line 48260

def write(fs, name = Std::String.new())
    __validate_pointer__
    Rbind::cv_ml_k_nearest_write( self, fs, name)
end