Class: OpenCV::Cv::BFMatcher

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

._create(name) ⇒ Cv::Ptr::Cv_Algorithm

Note:

wrapper for static method cv::Ptrcv::Algorithm cv::BFMatcher::_create(const cv::String name)

Parameters:

Returns:



26324
26325
26326
 
# File 'lib/ropencv/ropencv_types.rb', line 26324

def self._create(name)
    Rbind::cv_bf_matcher__create(name)
end

.cast_from_algorithm(ptr) ⇒ Cv::DescriptorMatcher Also known as: castFromAlgorithm

Note:

wrapper for static method cv::DescriptorMatcher* cv::BFMatcher::castFromAlgorithm(cv::Algorithm* ptr)

Parameters:

Returns:



26123
26124
26125
 
# File 'lib/ropencv/ropencv_types.rb', line 26123

def self.cast_from_algorithm(ptr)
    Rbind::cv_bf_matcher_cast_from_algorithm(ptr)
end

.cast_from_descriptor_matcher(ptr) ⇒ Cv::BFMatcher Also known as: castFromDescriptorMatcher

Note:

wrapper for static method cv::BFMatcher* cv::BFMatcher::castFromDescriptorMatcher(cv::DescriptorMatcher* ptr)

Parameters:

Returns:



25943
25944
25945
 
# File 'lib/ropencv/ropencv_types.rb', line 25943

def self.cast_from_descriptor_matcher(ptr)
    Rbind::cv_bf_matcher_cast_from_descriptor_matcher(ptr)
end

.create(descriptor_matcher_type) ⇒ Cv::Ptr::Cv_DescriptorMatcher

Note:

wrapper for static method cv::Ptrcv::DescriptorMatcher cv::BFMatcher::create(const cv::String descriptorMatcherType)

Parameters:

Returns:



26089
26090
26091
 
# File 'lib/ropencv/ropencv_types.rb', line 26089

def self.create(descriptor_matcher_type)
    Rbind::cv_bf_matcher_create(descriptor_matcher_type)
end

.get_list(algorithms) ⇒ Void Also known as: getList

Note:

wrapper for static method void cv::BFMatcher::getList(std::vectorcv::String& algorithms)

Parameters:

Returns:

  • (Void) 


26316
26317
26318
 
# File 'lib/ropencv/ropencv_types.rb', line 26316

def self.get_list(algorithms)
    Rbind::cv_bf_matcher_get_list(algorithms)
end

.new(*args) ⇒ Object

Parameters:

  • norm_type (Fixnum)
  • cross_check (Bool)

Raises:

  • (ArgumentError) 


25832
25833
25834
25835
25836
25837
25838
25839
25840
25841
25842
25843
25844
25845
25846
25847
25848
25849
25850
25851
25852
 
# File 'lib/ropencv/ropencv_types.rb', line 25832

def self.new(*args)
    if args.first.is_a?(FFI::Pointer) || args.first.is_a?(BFMatcherStruct)
        raise ArgumentError, "too many arguments for creating #{self.name} from Pointer" unless args.size == 1
        return super(args.first)
    end
    # overloaded method wrapper for cv::BFMatcher::BFMatcher(int normType = NORM_L2, bool crossCheck = false)
    @@cv_bf_matcher_bf_matcher_defaults0 ||= [NORM_L2, false]
    if(args.size >= 0 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_bf_matcher_bf_matcher_defaults0[i]
        end
        begin
                return Rbind::cv_bf_matcher_bf_matcher(*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

.null ⇒ Object

returns a null pointer to the object



25826
25827
25828
 
# File 'lib/ropencv/ropencv_types.rb', line 25826

def self.null
    new(BFMatcherStruct.new)
end

Instance Method Details

#add(descriptors) ⇒ Void

Note:

method wrapper for void cv::BFMatcher::add(const std::vectorcv::Mat descriptors)

Parameters:

Returns:

  • (Void) 


25951
25952
25953
25954
 
# File 'lib/ropencv/ropencv_types.rb', line 25951

def add(descriptors)
    __validate_pointer__
    Rbind::cv_bf_matcher_add( self, descriptors)
end

#cast_to_algorithm ⇒ Cv::Algorithm Also known as: castToAlgorithm

Note:

method wrapper for cv::Algorithm* cv::BFMatcher::castToAlgorithm()

Returns:



26109
26110
26111
26112
26113
26114
26115
26116
26117
 
# File 'lib/ropencv/ropencv_types.rb', line 26109

def cast_to_algorithm()
    __validate_pointer__
    result = Rbind::cv_bf_matcher_cast_to_algorithm( 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

#cast_to_descriptor_matcher ⇒ Cv::DescriptorMatcher Also known as: castToDescriptorMatcher

Note:

method wrapper for cv::DescriptorMatcher* cv::BFMatcher::castToDescriptorMatcher()

methods

Returns:



25929
25930
25931
25932
25933
25934
25935
25936
25937
 
# File 'lib/ropencv/ropencv_types.rb', line 25929

def cast_to_descriptor_matcher()
    __validate_pointer__
    result = Rbind::cv_bf_matcher_cast_to_descriptor_matcher( 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

#clear ⇒ Void

Note:

method wrapper for void cv::BFMatcher::clear()

Returns:

  • (Void) 


25971
25972
25973
25974
 
# File 'lib/ropencv/ropencv_types.rb', line 25971

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

#empty ⇒ Bool

Note:

method wrapper for bool cv::BFMatcher::empty()

Returns:

  • (Bool) 


25978
25979
25980
25981
 
# File 'lib/ropencv/ropencv_types.rb', line 25978

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

#get_algorithm(name) ⇒ Cv::Ptr::Cv_Algorithm Also known as: getAlgorithm

Note:

method wrapper for cv::Ptrcv::Algorithm cv::BFMatcher::getAlgorithm(const cv::String name)

Parameters:

Returns:



26200
26201
26202
26203
26204
26205
26206
26207
26208
 
# File 'lib/ropencv/ropencv_types.rb', line 26200

def get_algorithm(name)
    __validate_pointer__
    result = Rbind::cv_bf_matcher_get_algorithm( self, name)
    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_bool(name) ⇒ Bool Also known as: getBool

Note:

method wrapper for bool cv::BFMatcher::getBool(const cv::String name)

Parameters:

Returns:

  • (Bool) 


26149
26150
26151
26152
 
# File 'lib/ropencv/ropencv_types.rb', line 26149

def get_bool(name)
    __validate_pointer__
    Rbind::cv_bf_matcher_get_bool( self, name)
end

#get_double(name) ⇒ Double Also known as: getDouble

Note:

method wrapper for double cv::BFMatcher::getDouble(const cv::String name)

Parameters:

Returns:

  • (Double) 


26140
26141
26142
26143
 
# File 'lib/ropencv/ropencv_types.rb', line 26140

def get_double(name)
    __validate_pointer__
    Rbind::cv_bf_matcher_get_double( self, name)
end

#get_int(name) ⇒ Fixnum Also known as: getInt

Note:

method wrapper for int cv::BFMatcher::getInt(const cv::String name)

Parameters:

Returns:

  • (Fixnum) 


26131
26132
26133
26134
 
# File 'lib/ropencv/ropencv_types.rb', line 26131

def get_int(name)
    __validate_pointer__
    Rbind::cv_bf_matcher_get_int( self, name)
end

#get_mat(name) ⇒ Cv::Mat Also known as: getMat

Note:

method wrapper for cv::Mat cv::BFMatcher::getMat(const cv::String name)

Parameters:

Returns:



26172
26173
26174
26175
26176
26177
26178
26179
26180
 
# File 'lib/ropencv/ropencv_types.rb', line 26172

def get_mat(name)
    __validate_pointer__
    result = Rbind::cv_bf_matcher_get_mat( self, name)
    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_mat_vector(name) ⇒ Std::Vector::Cv_Mat Also known as: getMatVector

Note:

method wrapper for std::vectorcv::Mat cv::BFMatcher::getMatVector(const cv::String name)

Parameters:

Returns:



26186
26187
26188
26189
26190
26191
26192
26193
26194
 
# File 'lib/ropencv/ropencv_types.rb', line 26186

def get_mat_vector(name)
    __validate_pointer__
    result = Rbind::cv_bf_matcher_get_mat_vector( self, name)
    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_params(names) ⇒ Void Also known as: getParams

Note:

method wrapper for void cv::BFMatcher::getParams(std::vectorcv::String& names)

Parameters:

Returns:

  • (Void) 


26307
26308
26309
26310
 
# File 'lib/ropencv/ropencv_types.rb', line 26307

def get_params(names)
    __validate_pointer__
    Rbind::cv_bf_matcher_get_params( self, names)
end

#get_string(name) ⇒ Cv::String Also known as: getString

Note:

method wrapper for cv::String cv::BFMatcher::getString(const cv::String name)

Parameters:

Returns:



26158
26159
26160
26161
26162
26163
26164
26165
26166
 
# File 'lib/ropencv/ropencv_types.rb', line 26158

def get_string(name)
    __validate_pointer__
    result = Rbind::cv_bf_matcher_get_string( self, name)
    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_train_descriptors ⇒ Std::Vector::Cv_Mat Also known as: getTrainDescriptors

Note:

method wrapper for std::vectorcv::Mat cv::BFMatcher::getTrainDescriptors()

Returns:



25958
25959
25960
25961
25962
25963
25964
25965
25966
 
# File 'lib/ropencv/ropencv_types.rb', line 25958

def get_train_descriptors()
    __validate_pointer__
    result = Rbind::cv_bf_matcher_get_train_descriptors( 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

#knn_match(query_descriptors, train_descriptors, matches, k, mask = Cv::Mat.new(), compact_result = false) ⇒ Void #knn_match(query_descriptors, matches, k, masks = Std::Vector::Cv_Mat.new(), compact_result = false) ⇒ Void

Note:

wrapper for overloaded method knn_match

Overloads:

  • #knn_match(query_descriptors, train_descriptors, matches, k, mask = Cv::Mat.new(), compact_result = false) ⇒ Void

    Parameters:

    Returns:

    • (Void)
  • #knn_match(query_descriptors, matches, k, masks = Std::Vector::Cv_Mat.new(), compact_result = false) ⇒ Void

    Parameters:

    Returns:

    • (Void)

Raises:

  • (ArgumentError) 


26053
26054
26055
26056
26057
26058
26059
26060
26061
26062
26063
26064
26065
26066
26067
26068
26069
26070
26071
26072
26073
26074
26075
26076
26077
26078
26079
26080
26081
26082
26083
26084
 
# File 'lib/ropencv/ropencv_types.rb', line 26053

def knn_match(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::BFMatcher::knnMatch(const cv::Mat queryDescriptors, const cv::Mat trainDescriptors, std::vector<std::vector<cv::DMatch> >& matches, int k, const cv::Mat mask = Mat(), bool compactResult = false)
    @@cv_bf_matcher_knn_match_defaults0 ||= [nil, nil, nil, nil, Cv::Mat.new(), false]
    if(args.size >= 4 && args.size <= 6)
        targs = args.clone
        targs.size.upto(5) do |i|
            targs[i] = @@cv_bf_matcher_knn_match_defaults0[i]
        end
        begin
                return Rbind::cv_bf_matcher_knn_match(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::BFMatcher::knnMatch(const cv::Mat queryDescriptors, std::vector<std::vector<cv::DMatch> >& matches, int k, const std::vector<cv::Mat> masks = vector<Mat>(), bool compactResult = false)
    @@cv_bf_matcher_knn_match2_defaults1 ||= [nil, nil, nil, Std::Vector::Cv_Mat.new(), false]
    if(args.size >= 3 && args.size <= 5)
        targs = args.clone
        targs.size.upto(4) do |i|
            targs[i] = @@cv_bf_matcher_knn_match2_defaults1[i]
        end
        begin
                return Rbind::cv_bf_matcher_knn_match2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#match(query_descriptors, train_descriptors, matches, mask = Cv::Mat.new()) ⇒ Void #match(query_descriptors, matches, masks = Std::Vector::Cv_Mat.new()) ⇒ Void

Note:

wrapper for overloaded method match

Overloads:

  • #match(query_descriptors, train_descriptors, matches, mask = Cv::Mat.new()) ⇒ Void

    Parameters:

    Returns:

    • (Void)
  • #match(query_descriptors, matches, masks = Std::Vector::Cv_Mat.new()) ⇒ Void

    Parameters:

    Returns:

    • (Void)

Raises:

  • (ArgumentError) 


26003
26004
26005
26006
26007
26008
26009
26010
26011
26012
26013
26014
26015
26016
26017
26018
26019
26020
26021
26022
26023
26024
26025
26026
26027
26028
26029
26030
26031
26032
26033
26034
 
# File 'lib/ropencv/ropencv_types.rb', line 26003

def match(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::BFMatcher::match(const cv::Mat queryDescriptors, const cv::Mat trainDescriptors, std::vector<cv::DMatch>& matches, const cv::Mat mask = Mat())
    @@cv_bf_matcher_match_defaults0 ||= [nil, nil, nil, Cv::Mat.new()]
    if(args.size >= 3 && args.size <= 4)
        targs = args.clone
        targs.size.upto(3) do |i|
            targs[i] = @@cv_bf_matcher_match_defaults0[i]
        end
        begin
                return Rbind::cv_bf_matcher_match(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::BFMatcher::match(const cv::Mat queryDescriptors, std::vector<cv::DMatch>& matches, const std::vector<cv::Mat> masks = vector<Mat>())
    @@cv_bf_matcher_match2_defaults1 ||= [nil, nil, Std::Vector::Cv_Mat.new()]
    if(args.size >= 2 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_bf_matcher_match2_defaults1[i]
        end
        begin
                return Rbind::cv_bf_matcher_match2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#param_help(name) ⇒ Cv::String Also known as: paramHelp

Note:

method wrapper for cv::String cv::BFMatcher::paramHelp(const cv::String name)

Parameters:

Returns:



26284
26285
26286
26287
26288
26289
26290
26291
26292
 
# File 'lib/ropencv/ropencv_types.rb', line 26284

def param_help(name)
    __validate_pointer__
    result = Rbind::cv_bf_matcher_param_help( self, name)
    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

#param_type(name) ⇒ Fixnum Also known as: paramType

Note:

method wrapper for int cv::BFMatcher::paramType(const cv::String name)

Parameters:

Returns:

  • (Fixnum) 


26298
26299
26300
26301
 
# File 'lib/ropencv/ropencv_types.rb', line 26298

def param_type(name)
    __validate_pointer__
    Rbind::cv_bf_matcher_param_type( self, name)
end

#radius_match(query_descriptors, train_descriptors, matches, max_distance, mask = Cv::Mat.new(), compact_result = false) ⇒ Void Also known as: radiusMatch

Note:

method wrapper for void cv::BFMatcher::radiusMatch(const cv::Mat queryDescriptors, const cv::Mat trainDescriptors, std::vectorstd::vector<cv::DMatch >& matches, float maxDistance, const cv::Mat mask = cv::Mat(), bool compactResult = false)

Parameters:

Returns:

  • (Void) 


26101
26102
26103
26104
 
# File 'lib/ropencv/ropencv_types.rb', line 26101

def radius_match(query_descriptors, train_descriptors, matches, max_distance, mask = Cv::Mat.new(), compact_result = false)
    __validate_pointer__
    Rbind::cv_bf_matcher_radius_match( self, query_descriptors, train_descriptors, matches, max_distance, mask, compact_result)
end

#set_algorithm(name, value) ⇒ Void Also known as: setAlgorithm

Note:

method wrapper for void cv::BFMatcher::setAlgorithm(const cv::String name, const cv::Ptrcv::Algorithm value)

Parameters:

Returns:

  • (Void) 


26275
26276
26277
26278
 
# File 'lib/ropencv/ropencv_types.rb', line 26275

def set_algorithm(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_algorithm( self, name, value)
end

#set_bool(name, value) ⇒ Void Also known as: setBool

Note:

method wrapper for void cv::BFMatcher::setBool(const cv::String name, bool value)

Parameters:

Returns:

  • (Void) 


26235
26236
26237
26238
 
# File 'lib/ropencv/ropencv_types.rb', line 26235

def set_bool(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_bool( self, name, value)
end

#set_double(name, value) ⇒ Void Also known as: setDouble

Note:

method wrapper for void cv::BFMatcher::setDouble(const cv::String name, double value)

Parameters:

Returns:

  • (Void) 


26225
26226
26227
26228
 
# File 'lib/ropencv/ropencv_types.rb', line 26225

def set_double(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_double( self, name, value)
end

#set_int(name, value) ⇒ Void Also known as: setInt

Note:

method wrapper for void cv::BFMatcher::setInt(const cv::String name, int value)

Parameters:

Returns:

  • (Void) 


26215
26216
26217
26218
 
# File 'lib/ropencv/ropencv_types.rb', line 26215

def set_int(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_int( self, name, value)
end

#set_mat(name, value) ⇒ Void Also known as: setMat

Note:

method wrapper for void cv::BFMatcher::setMat(const cv::String name, const cv::Mat value)

Parameters:

Returns:

  • (Void) 


26255
26256
26257
26258
 
# File 'lib/ropencv/ropencv_types.rb', line 26255

def set_mat(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_mat( self, name, value)
end

#set_mat_vector(name, value) ⇒ Void Also known as: setMatVector

Note:

method wrapper for void cv::BFMatcher::setMatVector(const cv::String name, const std::vectorcv::Mat value)

Parameters:

Returns:

  • (Void) 


26265
26266
26267
26268
 
# File 'lib/ropencv/ropencv_types.rb', line 26265

def set_mat_vector(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_mat_vector( self, name, value)
end

#set_string(name, value) ⇒ Void Also known as: setString

Note:

method wrapper for void cv::BFMatcher::setString(const cv::String name, const cv::String value)

Parameters:

Returns:

  • (Void) 


26245
26246
26247
26248
 
# File 'lib/ropencv/ropencv_types.rb', line 26245

def set_string(name, value)
    __validate_pointer__
    Rbind::cv_bf_matcher_set_string( self, name, value)
end

#to_s ⇒ Object

converts BFMatcher into a string by crawling through all its attributes



25918
25919
25920
 
# File 'lib/ropencv/ropencv_types.rb', line 25918

def to_s
    "#<cv::BFMatcher >"
end

#train ⇒ Void

Note:

method wrapper for void cv::BFMatcher::train()

Returns:

  • (Void) 


25985
25986
25987
25988
 
# File 'lib/ropencv/ropencv_types.rb', line 25985

def train()
    __validate_pointer__
    Rbind::cv_bf_matcher_train( self)
end