Class: OpenCV::Cv::ORB

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

Constants collapse

HARRIS_SCORE = 
0
FAST_SCORE = 
1

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create(nfeatures = 500, scale_factor = 1.2, nlevels = 8, edge_threshold = 31, first_level = 0, w_t_a__k = 2, score_type = :HARRIS_SCORE, patch_size = 31, fast_threshold = 20) ⇒ Cv::Ptr::Cv_ORB

Note:

wrapper for static method const cv::Ptrcv::ORB cv::ORB::create(int nfeatures = 500, float scaleFactor = 1.2f, int nlevels = 8, int edgeThreshold = 31, int firstLevel = 0, int WTA_K = 2, cv::ORB::ScoreType scoreType = ORB::HARRIS_SCORE, int patchSize = 31, int fastThreshold = 20)

methods

Parameters:

  • nfeatures (Fixnum) (defaults to: 500)
  • scale_factor (Float) (defaults to: 1.2)
  • nlevels (Fixnum) (defaults to: 8)
  • edge_threshold (Fixnum) (defaults to: 31)
  • first_level (Fixnum) (defaults to: 0)
  • w_t_a__k (Fixnum) (defaults to: 2)
  • score_type (Cv::ORB::ScoreType) (defaults to: :HARRIS_SCORE)
  • patch_size (Fixnum) (defaults to: 31)
  • fast_threshold (Fixnum) (defaults to: 20)

Returns:



58300
58301
58302
 
# File 'lib/ropencv/ropencv_types.rb', line 58300

def self.create(nfeatures = 500, scale_factor = 1.2, nlevels = 8, edge_threshold = 31, first_level = 0, w_t_a__k = 2, score_type = :HARRIS_SCORE, patch_size = 31, fast_threshold = 20)
    Rbind::cv_orb_create(nfeatures, scale_factor, nlevels, edge_threshold, first_level, w_t_a__k, score_type, patch_size, fast_threshold)
end

.new(*args) ⇒ Object

Raises:

  • (ArgumentError) 


58205
58206
58207
58208
58209
58210
58211
58212
 
# File 'lib/ropencv/ropencv_types.rb', line 58205

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



58201
58202
58203
 
# File 'lib/ropencv/ropencv_types.rb', line 58201

def self.null
    new(ORBStruct.new)
end

Instance Method Details

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

Note:

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

Parameters:

  • parse_ownership (Bool)

Returns:



58704
58705
58706
58707
58708
58709
58710
58711
58712
 
# File 'lib/ropencv/ropencv_types.rb', line 58704

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

Parameters:

  • parse_ownership (Bool)

Returns:



58473
58474
58475
58476
58477
58478
58479
58480
58481
 
# File 'lib/ropencv/ropencv_types.rb', line 58473

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

Returns:

  • (Void) 


58717
58718
58719
58720
 
# File 'lib/ropencv/ropencv_types.rb', line 58717

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

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

Note:

wrapper for overloaded method compute

Overloads:

Raises:

  • (ArgumentError) 


58541
58542
58543
58544
58545
58546
58547
58548
58549
58550
58551
58552
58553
58554
58555
58556
58557
58558
58559
58560
58561
58562
58563
58564
58565
58566
58567
58568
58569
58570
58571
58572
 
# File 'lib/ropencv/ropencv_types.rb', line 58541

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

    # overloaded method wrapper for void cv::ORB::compute(const std::vector<cv::Mat> images, std::vector<std::vector<cv::KeyPoint> >& keypoints, std::vector<cv::Mat>& descriptors)
    @@cv_orb_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_orb_compute__2_defaults1[i]
        end
        begin
                return Rbind::cv_orb_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::ORB::defaultNorm()

Returns:

  • (Fixnum) 


58605
58606
58607
58608
 
# File 'lib/ropencv/ropencv_types.rb', line 58605

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

#descriptor_size ⇒ Fixnum Also known as: descriptorSize

Note:

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

Returns:

  • (Fixnum) 


58589
58590
58591
58592
 
# File 'lib/ropencv/ropencv_types.rb', line 58589

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

#descriptor_type ⇒ Fixnum Also known as: descriptorType

Note:

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

Returns:

  • (Fixnum) 


58597
58598
58599
58600
 
# File 'lib/ropencv/ropencv_types.rb', line 58597

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


58496
58497
58498
58499
58500
58501
58502
58503
58504
58505
58506
58507
58508
58509
58510
58511
58512
58513
58514
58515
58516
58517
58518
58519
58520
58521
58522
58523
58524
58525
58526
58527
 
# File 'lib/ropencv/ropencv_types.rb', line 58496

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

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

Parameters:

Returns:

  • (Void) 


58581
58582
58583
58584
 
# File 'lib/ropencv/ropencv_types.rb', line 58581

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

#empty ⇒ Bool

Note:

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

Returns:

  • (Bool) 


58696
58697
58698
58699
 
# File 'lib/ropencv/ropencv_types.rb', line 58696

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

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

Note:

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

Returns:



58459
58460
58461
58462
58463
58464
58465
58466
58467
 
# File 'lib/ropencv/ropencv_types.rb', line 58459

def get_default_name()
    __validate_pointer__
    result = Rbind::cv_orb_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_edge_threshold ⇒ Fixnum Also known as: getEdgeThreshold

Note:

method wrapper for int cv::ORB::getEdgeThreshold()

Returns:

  • (Fixnum) 


58366
58367
58368
58369
 
# File 'lib/ropencv/ropencv_types.rb', line 58366

def get_edge_threshold()
    __validate_pointer__
    Rbind::cv_orb_get_edge_threshold( self)
end

#get_fast_threshold ⇒ Fixnum Also known as: getFastThreshold

Note:

method wrapper for int cv::ORB::getFastThreshold()

Returns:

  • (Fixnum) 


58451
58452
58453
58454
 
# File 'lib/ropencv/ropencv_types.rb', line 58451

def get_fast_threshold()
    __validate_pointer__
    Rbind::cv_orb_get_fast_threshold( self)
end

#get_first_level ⇒ Fixnum Also known as: getFirstLevel

Note:

method wrapper for int cv::ORB::getFirstLevel()

Returns:

  • (Fixnum) 


58383
58384
58385
58386
 
# File 'lib/ropencv/ropencv_types.rb', line 58383

def get_first_level()
    __validate_pointer__
    Rbind::cv_orb_get_first_level( self)
end

#get_max_features ⇒ Fixnum Also known as: getMaxFeatures

Note:

method wrapper for int cv::ORB::getMaxFeatures()

Returns:

  • (Fixnum) 


58315
58316
58317
58318
 
# File 'lib/ropencv/ropencv_types.rb', line 58315

def get_max_features()
    __validate_pointer__
    Rbind::cv_orb_get_max_features( self)
end

#get_patch_size ⇒ Fixnum Also known as: getPatchSize

Note:

method wrapper for int cv::ORB::getPatchSize()

Returns:

  • (Fixnum) 


58434
58435
58436
58437
 
# File 'lib/ropencv/ropencv_types.rb', line 58434

def get_patch_size()
    __validate_pointer__
    Rbind::cv_orb_get_patch_size( self)
end

#get_scale_factor ⇒ Double Also known as: getScaleFactor

Note:

method wrapper for double cv::ORB::getScaleFactor()

Returns:

  • (Double) 


58332
58333
58334
58335
 
# File 'lib/ropencv/ropencv_types.rb', line 58332

def get_scale_factor()
    __validate_pointer__
    Rbind::cv_orb_get_scale_factor( self)
end

#get_score_type ⇒ Cv::ORB::ScoreType Also known as: getScoreType

Note:

method wrapper for cv::ORB::ScoreType cv::ORB::getScoreType()

Returns:

  • (Cv::ORB::ScoreType) 


58417
58418
58419
58420
 
# File 'lib/ropencv/ropencv_types.rb', line 58417

def get_score_type()
    __validate_pointer__
    Rbind::cv_orb_get_score_type( self)
end

#getn_levels ⇒ Fixnum Also known as: getNLevels

Note:

method wrapper for int cv::ORB::getNLevels()

Returns:

  • (Fixnum) 


58349
58350
58351
58352
 
# File 'lib/ropencv/ropencv_types.rb', line 58349

def getn_levels()
    __validate_pointer__
    Rbind::cv_orb_getn_levels( self)
end

#getwta_k ⇒ Fixnum Also known as: getWTA_K

Note:

method wrapper for int cv::ORB::getWTA_K()

Returns:

  • (Fixnum) 


58400
58401
58402
58403
 
# File 'lib/ropencv/ropencv_types.rb', line 58400

def getwta_k()
    __validate_pointer__
    Rbind::cv_orb_getwta_k( 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) 


58661
58662
58663
58664
58665
58666
58667
58668
58669
58670
58671
58672
58673
58674
58675
58676
58677
58678
58679
58680
58681
58682
58683
58684
58685
58686
58687
58688
58689
58690
58691
58692
 
# File 'lib/ropencv/ropencv_types.rb', line 58661

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

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

Parameters:

Returns:

  • (Void) 


58725
58726
58727
58728
 
# File 'lib/ropencv/ropencv_types.rb', line 58725

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

#set_edge_threshold(edge_threshold) ⇒ Void Also known as: setEdgeThreshold

Note:

method wrapper for void cv::ORB::setEdgeThreshold(int edgeThreshold)

Parameters:

  • edge_threshold (Fixnum)

Returns:

  • (Void) 


58358
58359
58360
58361
 
# File 'lib/ropencv/ropencv_types.rb', line 58358

def set_edge_threshold(edge_threshold)
    __validate_pointer__
    Rbind::cv_orb_set_edge_threshold( self, edge_threshold)
end

#set_fast_threshold(fast_threshold) ⇒ Void Also known as: setFastThreshold

Note:

method wrapper for void cv::ORB::setFastThreshold(int fastThreshold)

Parameters:

  • fast_threshold (Fixnum)

Returns:

  • (Void) 


58443
58444
58445
58446
 
# File 'lib/ropencv/ropencv_types.rb', line 58443

def set_fast_threshold(fast_threshold)
    __validate_pointer__
    Rbind::cv_orb_set_fast_threshold( self, fast_threshold)
end

#set_first_level(first_level) ⇒ Void Also known as: setFirstLevel

Note:

method wrapper for void cv::ORB::setFirstLevel(int firstLevel)

Parameters:

  • first_level (Fixnum)

Returns:

  • (Void) 


58375
58376
58377
58378
 
# File 'lib/ropencv/ropencv_types.rb', line 58375

def set_first_level(first_level)
    __validate_pointer__
    Rbind::cv_orb_set_first_level( self, first_level)
end

#set_max_features(max_features) ⇒ Void Also known as: setMaxFeatures

Note:

method wrapper for void cv::ORB::setMaxFeatures(int maxFeatures)

Parameters:

  • max_features (Fixnum)

Returns:

  • (Void) 


58307
58308
58309
58310
 
# File 'lib/ropencv/ropencv_types.rb', line 58307

def set_max_features(max_features)
    __validate_pointer__
    Rbind::cv_orb_set_max_features( self, max_features)
end

#set_patch_size(patch_size) ⇒ Void Also known as: setPatchSize

Note:

method wrapper for void cv::ORB::setPatchSize(int patchSize)

Parameters:

  • patch_size (Fixnum)

Returns:

  • (Void) 


58426
58427
58428
58429
 
# File 'lib/ropencv/ropencv_types.rb', line 58426

def set_patch_size(patch_size)
    __validate_pointer__
    Rbind::cv_orb_set_patch_size( self, patch_size)
end

#set_scale_factor(scale_factor) ⇒ Void Also known as: setScaleFactor

Note:

method wrapper for void cv::ORB::setScaleFactor(double scaleFactor)

Parameters:

  • scale_factor (Double)

Returns:

  • (Void) 


58324
58325
58326
58327
 
# File 'lib/ropencv/ropencv_types.rb', line 58324

def set_scale_factor(scale_factor)
    __validate_pointer__
    Rbind::cv_orb_set_scale_factor( self, scale_factor)
end

#set_score_type(score_type) ⇒ Void Also known as: setScoreType

Note:

method wrapper for void cv::ORB::setScoreType(cv::ORB::ScoreType scoreType)

Parameters:

  • score_type (Cv::ORB::ScoreType)

Returns:

  • (Void) 


58409
58410
58411
58412
 
# File 'lib/ropencv/ropencv_types.rb', line 58409

def set_score_type(score_type)
    __validate_pointer__
    Rbind::cv_orb_set_score_type( self, score_type)
end

#setn_levels(nlevels) ⇒ Void Also known as: setNLevels

Note:

method wrapper for void cv::ORB::setNLevels(int nlevels)

Parameters:

  • nlevels (Fixnum)

Returns:

  • (Void) 


58341
58342
58343
58344
 
# File 'lib/ropencv/ropencv_types.rb', line 58341

def setn_levels(nlevels)
    __validate_pointer__
    Rbind::cv_orb_setn_levels( self, nlevels)
end

#setwta_k(wta_k) ⇒ Void Also known as: setWTA_K

Note:

method wrapper for void cv::ORB::setWTA_K(int wta_k)

Parameters:

  • wta_k (Fixnum)

Returns:

  • (Void) 


58392
58393
58394
58395
 
# File 'lib/ropencv/ropencv_types.rb', line 58392

def setwta_k(wta_k)
    __validate_pointer__
    Rbind::cv_orb_setwta_k( self, wta_k)
end

#to_s ⇒ Object

converts ORB into a string by crawling through all its attributes



58278
58279
58280
 
# File 'lib/ropencv/ropencv_types.rb', line 58278

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


58620
58621
58622
58623
58624
58625
58626
58627
58628
58629
58630
58631
58632
58633
58634
58635
58636
58637
58638
58639
58640
58641
58642
58643
58644
58645
58646
58647
58648
58649
58650
58651
 
# File 'lib/ropencv/ropencv_types.rb', line 58620

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

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

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