Class: OpenCV::Cv::KAZE

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

Constants collapse

DIFF_PM_G1 =
0
DIFF_PM_G2 =
1
DIFF_WEICKERT =
2
DIFF_CHARBONNIER =
3

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create(extended = false, upright = false, threshold = 0.001, n_octaves = 4, n_octave_layers = 4, diffusivity = :DIFF_PM_G2) ⇒ Cv::Ptr::Cv_KAZE

Note:

wrapper for static method const cv::Ptrcv::KAZE cv::KAZE::create(bool extended = false, bool upright = false, float threshold = 0.001f, int nOctaves = 4, int nOctaveLayers = 4, cv::KAZE::DiffusivityType diffusivity = KAZE::DIFF_PM_G2)

methods

Parameters:

  • extended (Bool) (defaults to: false)
  • upright (Bool) (defaults to: false)
  • 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:



63278
63279
63280
# File 'lib/ropencv/ropencv_types.rb', line 63278

def self.create(extended = false, upright = false, threshold = 0.001, n_octaves = 4, n_octave_layers = 4, diffusivity = :DIFF_PM_G2)
    Rbind::cv_kaze_create(extended, upright, threshold, n_octaves, n_octave_layers, diffusivity)
end

.new(*args) ⇒ Object

Raises:

  • (ArgumentError)


63184
63185
63186
63187
63188
63189
63190
63191
# File 'lib/ropencv/ropencv_types.rb', line 63184

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

.nullObject

returns a null pointer to the object



63180
63181
63182
# File 'lib/ropencv/ropencv_types.rb', line 63180

def self.null
    new(KAZEStruct.new)
end

Instance Method Details

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

Note:

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

Parameters:

  • parse_ownership (Bool)

Returns:



63631
63632
63633
63634
63635
63636
63637
63638
63639
# File 'lib/ropencv/ropencv_types.rb', line 63631

def cast_to_algorithm(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_kaze_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::KAZE::castToFeature2D(bool parse_ownership)

Parameters:

  • parse_ownership (Bool)

Returns:



63400
63401
63402
63403
63404
63405
63406
63407
63408
# File 'lib/ropencv/ropencv_types.rb', line 63400

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

#clearVoid

Note:

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

Returns:

  • (Void)


63644
63645
63646
63647
# File 'lib/ropencv/ropencv_types.rb', line 63644

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

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

Note:

wrapper for overloaded method compute

Overloads:

Raises:

  • (ArgumentError)


63468
63469
63470
63471
63472
63473
63474
63475
63476
63477
63478
63479
63480
63481
63482
63483
63484
63485
63486
63487
63488
63489
63490
63491
63492
63493
63494
63495
63496
63497
63498
63499
# File 'lib/ropencv/ropencv_types.rb', line 63468

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

    # overloaded method wrapper for void cv::KAZE::compute(const std::vector<cv::Mat> images, std::vector<std::vector<cv::KeyPoint> >& keypoints, std::vector<cv::Mat>& descriptors)
    @@cv_kaze_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_kaze_compute__2_defaults1[i]
        end
        begin
                return Rbind::cv_kaze_compute__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#default_normFixnum Also known as: defaultNorm

Note:

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

Returns:

  • (Fixnum)


63532
63533
63534
63535
# File 'lib/ropencv/ropencv_types.rb', line 63532

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

#descriptor_sizeFixnum Also known as: descriptorSize

Note:

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

Returns:

  • (Fixnum)


63516
63517
63518
63519
# File 'lib/ropencv/ropencv_types.rb', line 63516

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

#descriptor_typeFixnum Also known as: descriptorType

Note:

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

Returns:

  • (Fixnum)


63524
63525
63526
63527
# File 'lib/ropencv/ropencv_types.rb', line 63524

def descriptor_type()
    __validate_pointer__
    Rbind::cv_kaze_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)


63423
63424
63425
63426
63427
63428
63429
63430
63431
63432
63433
63434
63435
63436
63437
63438
63439
63440
63441
63442
63443
63444
63445
63446
63447
63448
63449
63450
63451
63452
63453
63454
# File 'lib/ropencv/ropencv_types.rb', line 63423

def detect(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::KAZE::detect(const cv::Mat image, std::vector<cv::KeyPoint>& keypoints, const cv::Mat mask = Mat())
    @@cv_kaze_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_kaze_detect_defaults0[i]
        end
        begin
                return Rbind::cv_kaze_detect(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::KAZE::detect(const std::vector<cv::Mat> images, std::vector<std::vector<cv::KeyPoint> >& keypoints, const std::vector<cv::Mat> masks = vector<Mat>())
    @@cv_kaze_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_kaze_detect__2_defaults1[i]
        end
        begin
                return Rbind::cv_kaze_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::KAZE::detectAndCompute(const cv::Mat image, const cv::Mat mask, std::vectorcv::KeyPoint& keypoints, cv::Mat& descriptors, bool useProvidedKeypoints = false)

Parameters:

Returns:

  • (Void)


63508
63509
63510
63511
# File 'lib/ropencv/ropencv_types.rb', line 63508

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

#emptyBool

Note:

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

Returns:

  • (Bool)


63623
63624
63625
63626
# File 'lib/ropencv/ropencv_types.rb', line 63623

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

#get_default_nameStd::String Also known as: getDefaultName

Note:

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

Returns:



63386
63387
63388
63389
63390
63391
63392
63393
63394
# File 'lib/ropencv/ropencv_types.rb', line 63386

def get_default_name()
    __validate_pointer__
    result = Rbind::cv_kaze_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_diffusivityCv::KAZE::DiffusivityType Also known as: getDiffusivity

Note:

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

Returns:

  • (Cv::KAZE::DiffusivityType)


63378
63379
63380
63381
# File 'lib/ropencv/ropencv_types.rb', line 63378

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

#get_extendedBool Also known as: getExtended

Note:

method wrapper for bool cv::KAZE::getExtended()

Returns:

  • (Bool)


63293
63294
63295
63296
# File 'lib/ropencv/ropencv_types.rb', line 63293

def get_extended()
    __validate_pointer__
    Rbind::cv_kaze_get_extended( self)
end

#get_thresholdDouble Also known as: getThreshold

Note:

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

Returns:

  • (Double)


63327
63328
63329
63330
# File 'lib/ropencv/ropencv_types.rb', line 63327

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

#get_uprightBool Also known as: getUpright

Note:

method wrapper for bool cv::KAZE::getUpright()

Returns:

  • (Bool)


63310
63311
63312
63313
# File 'lib/ropencv/ropencv_types.rb', line 63310

def get_upright()
    __validate_pointer__
    Rbind::cv_kaze_get_upright( self)
end

#getn_octave_layersFixnum Also known as: getNOctaveLayers

Note:

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

Returns:

  • (Fixnum)


63361
63362
63363
63364
# File 'lib/ropencv/ropencv_types.rb', line 63361

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

#getn_octavesFixnum Also known as: getNOctaves

Note:

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

Returns:

  • (Fixnum)


63344
63345
63346
63347
# File 'lib/ropencv/ropencv_types.rb', line 63344

def getn_octaves()
    __validate_pointer__
    Rbind::cv_kaze_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)


63588
63589
63590
63591
63592
63593
63594
63595
63596
63597
63598
63599
63600
63601
63602
63603
63604
63605
63606
63607
63608
63609
63610
63611
63612
63613
63614
63615
63616
63617
63618
63619
# File 'lib/ropencv/ropencv_types.rb', line 63588

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

    # overloaded method wrapper for void cv::KAZE::read(const cv::FileNode arg1)
    @@cv_kaze_read__2_defaults1 ||= [nil]
    if(args.size >= 1 && args.size <= 1)
        targs = args.clone
        targs.size.upto(0) do |i|
            targs[i] = @@cv_kaze_read__2_defaults1[i]
        end
        begin
                return Rbind::cv_kaze_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::KAZE::save(const std::string filename)

Parameters:

Returns:

  • (Void)


63652
63653
63654
63655
# File 'lib/ropencv/ropencv_types.rb', line 63652

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

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

Note:

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

Parameters:

  • diff (Cv::KAZE::DiffusivityType)

Returns:

  • (Void)


63370
63371
63372
63373
# File 'lib/ropencv/ropencv_types.rb', line 63370

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

#set_extended(extended) ⇒ Void Also known as: setExtended

Note:

method wrapper for void cv::KAZE::setExtended(bool extended)

Parameters:

  • extended (Bool)

Returns:

  • (Void)


63285
63286
63287
63288
# File 'lib/ropencv/ropencv_types.rb', line 63285

def set_extended(extended)
    __validate_pointer__
    Rbind::cv_kaze_set_extended( self, extended)
end

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

Note:

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

Parameters:

  • threshold (Double)

Returns:

  • (Void)


63319
63320
63321
63322
# File 'lib/ropencv/ropencv_types.rb', line 63319

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

#set_upright(upright) ⇒ Void Also known as: setUpright

Note:

method wrapper for void cv::KAZE::setUpright(bool upright)

Parameters:

  • upright (Bool)

Returns:

  • (Void)


63302
63303
63304
63305
# File 'lib/ropencv/ropencv_types.rb', line 63302

def set_upright(upright)
    __validate_pointer__
    Rbind::cv_kaze_set_upright( self, upright)
end

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

Note:

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

Parameters:

  • octave_layers (Fixnum)

Returns:

  • (Void)


63353
63354
63355
63356
# File 'lib/ropencv/ropencv_types.rb', line 63353

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

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

Note:

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

Parameters:

  • octaves (Fixnum)

Returns:

  • (Void)


63336
63337
63338
63339
# File 'lib/ropencv/ropencv_types.rb', line 63336

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

#to_sObject

converts KAZE into a string by crawling through all its attributes



63257
63258
63259
# File 'lib/ropencv/ropencv_types.rb', line 63257

def to_s
    "#<cv::KAZE >"
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)


63547
63548
63549
63550
63551
63552
63553
63554
63555
63556
63557
63558
63559
63560
63561
63562
63563
63564
63565
63566
63567
63568
63569
63570
63571
63572
63573
63574
63575
63576
63577
63578
# File 'lib/ropencv/ropencv_types.rb', line 63547

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

    # overloaded method wrapper for void cv::KAZE::write(const cv::Ptr<cv::FileStorage> fs, const std::string name = String())
    @@cv_kaze_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_kaze_write__2_defaults1[i]
        end
        begin
                return Rbind::cv_kaze_write__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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