Class: OpenCV::Cv::AKAZE

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

Constants collapse

DESCRIPTOR_KAZE_UPRIGHT = 
2
DESCRIPTOR_KAZE = 
3
DESCRIPTOR_MLDB_UPRIGHT = 
4
DESCRIPTOR_MLDB = 
5

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create(descriptor_type = :DESCRIPTOR_MLDB, descriptor_size = 0, descriptor_channels = 3, threshold = 0.001, n_octaves = 4, n_octave_layers = 4, diffusivity = :DIFF_PM_G2) ⇒ Cv::Ptr::Cv_AKAZE

Note:

wrapper for static method const cv::Ptrcv::AKAZE cv::AKAZE::create(cv::AKAZE::DescriptorType descriptor_type = AKAZE::DESCRIPTOR_MLDB, int descriptor_size = 0, int descriptor_channels = 3, float threshold = 0.001f, int nOctaves = 4, int nOctaveLayers = 4, cv::KAZE::DiffusivityType diffusivity = KAZE::DIFF_PM_G2)

methods

Parameters:

  • descriptor_type (Cv::AKAZE::DescriptorType) (defaults to: :DESCRIPTOR_MLDB)
  • descriptor_size (Fixnum) (defaults to: 0)
  • descriptor_channels (Fixnum) (defaults to: 3)
  • threshold (Float) (defaults to: 0.001)
  • n_octaves (Fixnum) (defaults to: 4)
  • n_octave_layers (Fixnum) (defaults to: 4)
  • diffusivity (Cv::KAZE::DiffusivityType) (defaults to: :DIFF_PM_G2)

Returns:



64056
64057
64058
 
# File 'lib/ropencv/ropencv_types.rb', line 64056

def self.create(descriptor_type = :DESCRIPTOR_MLDB, descriptor_size = 0, descriptor_channels = 3, threshold = 0.001, n_octaves = 4, n_octave_layers = 4, diffusivity = :DIFF_PM_G2)
    Rbind::cv_akaze_create(descriptor_type, descriptor_size, descriptor_channels, threshold, n_octaves, n_octave_layers, diffusivity)
end

.new(*args) ⇒ Object

Raises:

  • (ArgumentError) 


63961
63962
63963
63964
63965
63966
63967
63968
 
# File 'lib/ropencv/ropencv_types.rb', line 63961

def self.new(*args)
    if args.first.is_a?(FFI::Pointer) || args.first.is_a?(AKAZEStruct)
        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



63957
63958
63959
 
# File 'lib/ropencv/ropencv_types.rb', line 63957

def self.null
    new(AKAZEStruct.new)
end

Instance Method Details

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

Note:

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

Parameters:

  • parse_ownership (Bool)

Returns:



64426
64427
64428
64429
64430
64431
64432
64433
64434
 
# File 'lib/ropencv/ropencv_types.rb', line 64426

def cast_to_algorithm(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_akaze_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_feature2d(parse_ownership) ⇒ Cv::Feature2D Also known as: castToFeature2D

Note:

method wrapper for cv::Feature2D* cv::AKAZE::castToFeature2D(bool parse_ownership)

Parameters:

  • parse_ownership (Bool)

Returns:



64195
64196
64197
64198
64199
64200
64201
64202
64203
 
# File 'lib/ropencv/ropencv_types.rb', line 64195

def cast_to_feature2d(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_akaze_cast_to_feature2d( 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::AKAZE::clear()

Returns:

  • (Void) 


64439
64440
64441
64442
 
# File 'lib/ropencv/ropencv_types.rb', line 64439

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

#compute(image, keypoints, descriptors) ⇒ Void #compute(images, keypoints, descriptors) ⇒ Void

Note:

wrapper for overloaded method compute

Overloads:

Raises:

  • (ArgumentError) 


64263
64264
64265
64266
64267
64268
64269
64270
64271
64272
64273
64274
64275
64276
64277
64278
64279
64280
64281
64282
64283
64284
64285
64286
64287
64288
64289
64290
64291
64292
64293
64294
 
# File 'lib/ropencv/ropencv_types.rb', line 64263

def compute(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::AKAZE::compute(const cv::Mat image, std::vector<cv::KeyPoint>& keypoints, cv::Mat& descriptors)
    @@cv_akaze_compute_defaults0 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_akaze_compute_defaults0[i]
        end
        begin
                return Rbind::cv_akaze_compute(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::AKAZE::compute(const std::vector<cv::Mat> images, std::vector<std::vector<cv::KeyPoint> >& keypoints, std::vector<cv::Mat>& descriptors)
    @@cv_akaze_compute__2_defaults1 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_akaze_compute__2_defaults1[i]
        end
        begin
                return Rbind::cv_akaze_compute__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#default_norm ⇒ Fixnum Also known as: defaultNorm

Note:

method wrapper for int cv::AKAZE::defaultNorm()

Returns:

  • (Fixnum) 


64327
64328
64329
64330
 
# File 'lib/ropencv/ropencv_types.rb', line 64327

def default_norm()
    __validate_pointer__
    Rbind::cv_akaze_default_norm( self)
end

#descriptor_size ⇒ Fixnum Also known as: descriptorSize

Note:

method wrapper for int cv::AKAZE::descriptorSize()

Returns:

  • (Fixnum) 


64311
64312
64313
64314
 
# File 'lib/ropencv/ropencv_types.rb', line 64311

def descriptor_size()
    __validate_pointer__
    Rbind::cv_akaze_descriptor_size( self)
end

#descriptor_type ⇒ Fixnum Also known as: descriptorType

Note:

method wrapper for int cv::AKAZE::descriptorType()

Returns:

  • (Fixnum) 


64319
64320
64321
64322
 
# File 'lib/ropencv/ropencv_types.rb', line 64319

def descriptor_type()
    __validate_pointer__
    Rbind::cv_akaze_descriptor_type( self)
end

#detect(image, keypoints, mask = Cv::Mat.new()) ⇒ Void #detect(images, keypoints, masks = Std::Vector::Cv_Mat.new()) ⇒ Void

Note:

wrapper for overloaded method detect

Overloads:

Raises:

  • (ArgumentError) 


64218
64219
64220
64221
64222
64223
64224
64225
64226
64227
64228
64229
64230
64231
64232
64233
64234
64235
64236
64237
64238
64239
64240
64241
64242
64243
64244
64245
64246
64247
64248
64249
 
# File 'lib/ropencv/ropencv_types.rb', line 64218

def detect(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::AKAZE::detect(const cv::Mat image, std::vector<cv::KeyPoint>& keypoints, const cv::Mat mask = Mat())
    @@cv_akaze_detect_defaults0 ||= [nil, nil, Cv::Mat.new()]
    if(args.size >= 2 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_akaze_detect_defaults0[i]
        end
        begin
                return Rbind::cv_akaze_detect(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::AKAZE::detect(const std::vector<cv::Mat> images, std::vector<std::vector<cv::KeyPoint> >& keypoints, const std::vector<cv::Mat> masks = vector<Mat>())
    @@cv_akaze_detect__2_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_akaze_detect__2_defaults1[i]
        end
        begin
                return Rbind::cv_akaze_detect__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#detect_and_compute(image, mask, keypoints, descriptors, use_provided_keypoints = false) ⇒ Void Also known as: detectAndCompute

Note:

method wrapper for void cv::AKAZE::detectAndCompute(const cv::Mat image, const cv::Mat mask, std::vectorcv::KeyPoint& keypoints, cv::Mat& descriptors, bool useProvidedKeypoints = false)

Parameters:

Returns:

  • (Void) 


64303
64304
64305
64306
 
# File 'lib/ropencv/ropencv_types.rb', line 64303

def detect_and_compute(image, mask, keypoints, descriptors, use_provided_keypoints = false)
    __validate_pointer__
    Rbind::cv_akaze_detect_and_compute( self, image, mask, keypoints, descriptors, use_provided_keypoints)
end

#empty ⇒ Bool

Note:

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

Returns:

  • (Bool) 


64418
64419
64420
64421
 
# File 'lib/ropencv/ropencv_types.rb', line 64418

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

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

Note:

method wrapper for const std::string cv::AKAZE::getDefaultName()

Returns:



64181
64182
64183
64184
64185
64186
64187
64188
64189
 
# File 'lib/ropencv/ropencv_types.rb', line 64181

def get_default_name()
    __validate_pointer__
    result = Rbind::cv_akaze_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_descriptor_channels ⇒ Fixnum Also known as: getDescriptorChannels

Note:

method wrapper for int cv::AKAZE::getDescriptorChannels()

Returns:

  • (Fixnum) 


64105
64106
64107
64108
 
# File 'lib/ropencv/ropencv_types.rb', line 64105

def get_descriptor_channels()
    __validate_pointer__
    Rbind::cv_akaze_get_descriptor_channels( self)
end

#get_descriptor_size ⇒ Fixnum Also known as: getDescriptorSize

Note:

method wrapper for int cv::AKAZE::getDescriptorSize()

Returns:

  • (Fixnum) 


64088
64089
64090
64091
 
# File 'lib/ropencv/ropencv_types.rb', line 64088

def get_descriptor_size()
    __validate_pointer__
    Rbind::cv_akaze_get_descriptor_size( self)
end

#get_descriptor_type ⇒ Cv::AKAZE::DescriptorType Also known as: getDescriptorType

Note:

method wrapper for cv::AKAZE::DescriptorType cv::AKAZE::getDescriptorType()

Returns:

  • (Cv::AKAZE::DescriptorType) 


64071
64072
64073
64074
 
# File 'lib/ropencv/ropencv_types.rb', line 64071

def get_descriptor_type()
    __validate_pointer__
    Rbind::cv_akaze_get_descriptor_type( self)
end

#get_diffusivity ⇒ Cv::KAZE::DiffusivityType Also known as: getDiffusivity

Note:

method wrapper for cv::KAZE::DiffusivityType cv::AKAZE::getDiffusivity()

Returns:

  • (Cv::KAZE::DiffusivityType) 


64173
64174
64175
64176
 
# File 'lib/ropencv/ropencv_types.rb', line 64173

def get_diffusivity()
    __validate_pointer__
    Rbind::cv_akaze_get_diffusivity( self)
end

#get_threshold ⇒ Double Also known as: getThreshold

Note:

method wrapper for double cv::AKAZE::getThreshold()

Returns:

  • (Double) 


64122
64123
64124
64125
 
# File 'lib/ropencv/ropencv_types.rb', line 64122

def get_threshold()
    __validate_pointer__
    Rbind::cv_akaze_get_threshold( self)
end

#getn_octave_layers ⇒ Fixnum Also known as: getNOctaveLayers

Note:

method wrapper for int cv::AKAZE::getNOctaveLayers()

Returns:

  • (Fixnum) 


64156
64157
64158
64159
 
# File 'lib/ropencv/ropencv_types.rb', line 64156

def getn_octave_layers()
    __validate_pointer__
    Rbind::cv_akaze_getn_octave_layers( self)
end

#getn_octaves ⇒ Fixnum Also known as: getNOctaves

Note:

method wrapper for int cv::AKAZE::getNOctaves()

Returns:

  • (Fixnum) 


64139
64140
64141
64142
 
# File 'lib/ropencv/ropencv_types.rb', line 64139

def getn_octaves()
    __validate_pointer__
    Rbind::cv_akaze_getn_octaves( self)
end

#read(file_name) ⇒ Void #read(_arg1) ⇒ Void

Note:

wrapper for overloaded method read

Overloads:

  • #read(file_name) ⇒ Void

    Parameters:

    Returns:

    • (Void)
  • #read(_arg1) ⇒ Void

    Parameters:

    Returns:

    • (Void)

Raises:

  • (ArgumentError) 


64383
64384
64385
64386
64387
64388
64389
64390
64391
64392
64393
64394
64395
64396
64397
64398
64399
64400
64401
64402
64403
64404
64405
64406
64407
64408
64409
64410
64411
64412
64413
64414
 
# File 'lib/ropencv/ropencv_types.rb', line 64383

def read(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::AKAZE::read(const std::string fileName)
    @@cv_akaze_read_defaults0 ||= [nil]
    if(args.size >= 1 && args.size <= 1)
        targs = args.clone
        targs.size.upto(0) do |i|
            targs[i] = @@cv_akaze_read_defaults0[i]
        end
        begin
                return Rbind::cv_akaze_read(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::AKAZE::read(const cv::FileNode arg1)
    @@cv_akaze_read__2_defaults1 ||= [nil]
    if(args.size >= 1 && args.size <= 1)
        targs = args.clone
        targs.size.upto(0) do |i|
            targs[i] = @@cv_akaze_read__2_defaults1[i]
        end
        begin
                return Rbind::cv_akaze_read__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#save(filename) ⇒ Void

Note:

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

Parameters:

Returns:

  • (Void) 


64447
64448
64449
64450
 
# File 'lib/ropencv/ropencv_types.rb', line 64447

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

#set_descriptor_channels(dch) ⇒ Void Also known as: setDescriptorChannels

Note:

method wrapper for void cv::AKAZE::setDescriptorChannels(int dch)

Parameters:

  • dch (Fixnum)

Returns:

  • (Void) 


64097
64098
64099
64100
 
# File 'lib/ropencv/ropencv_types.rb', line 64097

def set_descriptor_channels(dch)
    __validate_pointer__
    Rbind::cv_akaze_set_descriptor_channels( self, dch)
end

#set_descriptor_size(dsize) ⇒ Void Also known as: setDescriptorSize

Note:

method wrapper for void cv::AKAZE::setDescriptorSize(int dsize)

Parameters:

  • dsize (Fixnum)

Returns:

  • (Void) 


64080
64081
64082
64083
 
# File 'lib/ropencv/ropencv_types.rb', line 64080

def set_descriptor_size(dsize)
    __validate_pointer__
    Rbind::cv_akaze_set_descriptor_size( self, dsize)
end

#set_descriptor_type(dtype) ⇒ Void Also known as: setDescriptorType

Note:

method wrapper for void cv::AKAZE::setDescriptorType(cv::AKAZE::DescriptorType dtype)

Parameters:

  • dtype (Cv::AKAZE::DescriptorType)

Returns:

  • (Void) 


64063
64064
64065
64066
 
# File 'lib/ropencv/ropencv_types.rb', line 64063

def set_descriptor_type(dtype)
    __validate_pointer__
    Rbind::cv_akaze_set_descriptor_type( self, dtype)
end

#set_diffusivity(diff) ⇒ Void Also known as: setDiffusivity

Note:

method wrapper for void cv::AKAZE::setDiffusivity(cv::KAZE::DiffusivityType diff)

Parameters:

  • diff (Cv::KAZE::DiffusivityType)

Returns:

  • (Void) 


64165
64166
64167
64168
 
# File 'lib/ropencv/ropencv_types.rb', line 64165

def set_diffusivity(diff)
    __validate_pointer__
    Rbind::cv_akaze_set_diffusivity( self, diff)
end

#set_threshold(threshold) ⇒ Void Also known as: setThreshold

Note:

method wrapper for void cv::AKAZE::setThreshold(double threshold)

Parameters:

  • threshold (Double)

Returns:

  • (Void) 


64114
64115
64116
64117
 
# File 'lib/ropencv/ropencv_types.rb', line 64114

def set_threshold(threshold)
    __validate_pointer__
    Rbind::cv_akaze_set_threshold( self, threshold)
end

#setn_octave_layers(octave_layers) ⇒ Void Also known as: setNOctaveLayers

Note:

method wrapper for void cv::AKAZE::setNOctaveLayers(int octaveLayers)

Parameters:

  • octave_layers (Fixnum)

Returns:

  • (Void) 


64148
64149
64150
64151
 
# File 'lib/ropencv/ropencv_types.rb', line 64148

def setn_octave_layers(octave_layers)
    __validate_pointer__
    Rbind::cv_akaze_setn_octave_layers( self, octave_layers)
end

#setn_octaves(octaves) ⇒ Void Also known as: setNOctaves

Note:

method wrapper for void cv::AKAZE::setNOctaves(int octaves)

Parameters:

  • octaves (Fixnum)

Returns:

  • (Void) 


64131
64132
64133
64134
 
# File 'lib/ropencv/ropencv_types.rb', line 64131

def setn_octaves(octaves)
    __validate_pointer__
    Rbind::cv_akaze_setn_octaves( self, octaves)
end

#to_s ⇒ Object

converts AKAZE into a string by crawling through all its attributes



64034
64035
64036
 
# File 'lib/ropencv/ropencv_types.rb', line 64034

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

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

Note:

wrapper for overloaded method write

Overloads:

  • #write(file_name) ⇒ Void

    Parameters:

    Returns:

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

    Parameters:

    Returns:

    • (Void)

Raises:

  • (ArgumentError) 


64342
64343
64344
64345
64346
64347
64348
64349
64350
64351
64352
64353
64354
64355
64356
64357
64358
64359
64360
64361
64362
64363
64364
64365
64366
64367
64368
64369
64370
64371
64372
64373
 
# File 'lib/ropencv/ropencv_types.rb', line 64342

def write(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::AKAZE::write(const std::string fileName)
    @@cv_akaze_write_defaults0 ||= [nil]
    if(args.size >= 1 && args.size <= 1)
        targs = args.clone
        targs.size.upto(0) do |i|
            targs[i] = @@cv_akaze_write_defaults0[i]
        end
        begin
                return Rbind::cv_akaze_write(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::AKAZE::write(const cv::Ptr<cv::FileStorage> fs, const std::string name = String())
    @@cv_akaze_write__2_defaults1 ||= [nil, Std::String.new()]
    if(args.size >= 1 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_akaze_write__2_defaults1[i]
        end
        begin
                return Rbind::cv_akaze_write__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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