Class: OpenCV::Cv::SIFT

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(nfeatures = 0, n_octave_layers = 3, contrast_threshold = 0.04, edge_threshold = 10, sigma = 1.6) ⇒ Cv::Ptr::Cv_SIFT .create(nfeatures, n_octave_layers, contrast_threshold, edge_threshold, sigma, descriptor_type) ⇒ Cv::Ptr::Cv_SIFT

Note:

wrapper for overloaded static method create

methods

Overloads:

  • .create(nfeatures = 0, n_octave_layers = 3, contrast_threshold = 0.04, edge_threshold = 10, sigma = 1.6) ⇒ Cv::Ptr::Cv_SIFT

    Parameters:

    • nfeatures (Fixnum) (defaults to: 0)
    • n_octave_layers (Fixnum) (defaults to: 3)
    • contrast_threshold (Double) (defaults to: 0.04)
    • edge_threshold (Double) (defaults to: 10)
    • sigma (Double) (defaults to: 1.6)

    Returns:

  • .create(nfeatures, n_octave_layers, contrast_threshold, edge_threshold, sigma, descriptor_type) ⇒ Cv::Ptr::Cv_SIFT

    Parameters:

    • nfeatures (Fixnum)
    • n_octave_layers (Fixnum)
    • contrast_threshold (Double)
    • edge_threshold (Double)
    • sigma (Double)
    • descriptor_type (Fixnum)

    Returns:

Raises:

  • (ArgumentError) 


56820
56821
56822
56823
56824
56825
56826
56827
56828
56829
56830
56831
56832
56833
56834
56835
56836
56837
56838
56839
56840
56841
56842
56843
56844
56845
56846
56847
56848
56849
56850
56851
56852
56853
56854
56855
56856
 
# File 'lib/ropencv/ropencv_types.rb', line 56820

def self.create(*args)
    # overloaded method wrapper for const cv::Ptr<cv::SIFT> cv::SIFT::create(int nfeatures = 0, int nOctaveLayers = 3, double contrastThreshold = 0.04, double edgeThreshold = 10, double sigma = 1.6)
    @@cv_sift_create_defaults0 ||= [0, 3, 0.04, 10, 1.6]
    if(args.size >= 0 && args.size <= 5)
        targs = args.clone
        targs.size.upto(4) do |i|
            targs[i] = @@cv_sift_create_defaults0[i]
        end
        begin
                result = Rbind::cv_sift_create(*targs)
            # store owner insight the pointer to not get garbage collected
            result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) if !result.__owner__?
            return result
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for const cv::Ptr<cv::SIFT> cv::SIFT::create(int nfeatures, int nOctaveLayers, double contrastThreshold, double edgeThreshold, double sigma, int descriptorType)
    @@cv_sift_create__2_defaults1 ||= [nil, nil, nil, nil, nil, nil]
    if(args.size >= 6 && args.size <= 6)
        targs = args.clone
        targs.size.upto(5) do |i|
            targs[i] = @@cv_sift_create__2_defaults1[i]
        end
        begin
                result = Rbind::cv_sift_create__2(*targs)
            # store owner insight the pointer to not get garbage collected
            result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) if !result.__owner__?
            return result
        rescue TypeError => e
            @error = e
        end
    end

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

.new(*args) ⇒ Object

Raises:

  • (ArgumentError) 


56721
56722
56723
56724
56725
56726
56727
56728
 
# File 'lib/ropencv/ropencv_types.rb', line 56721

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



56717
56718
56719
 
# File 'lib/ropencv/ropencv_types.rb', line 56717

def self.null
    new(SIFTStruct.new)
end

Instance Method Details

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

Note:

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

Parameters:

  • parse_ownership (Bool)

Returns:



57104
57105
57106
57107
57108
57109
57110
57111
57112
 
# File 'lib/ropencv/ropencv_types.rb', line 57104

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

Parameters:

  • parse_ownership (Bool)

Returns:



56873
56874
56875
56876
56877
56878
56879
56880
56881
 
# File 'lib/ropencv/ropencv_types.rb', line 56873

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

Returns:

  • (Void) 


57117
57118
57119
57120
 
# File 'lib/ropencv/ropencv_types.rb', line 57117

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

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

Note:

wrapper for overloaded method compute

Overloads:

Raises:

  • (ArgumentError) 


56941
56942
56943
56944
56945
56946
56947
56948
56949
56950
56951
56952
56953
56954
56955
56956
56957
56958
56959
56960
56961
56962
56963
56964
56965
56966
56967
56968
56969
56970
56971
56972
 
# File 'lib/ropencv/ropencv_types.rb', line 56941

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

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

Returns:

  • (Fixnum) 


57005
57006
57007
57008
 
# File 'lib/ropencv/ropencv_types.rb', line 57005

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

#descriptor_size ⇒ Fixnum Also known as: descriptorSize

Note:

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

Returns:

  • (Fixnum) 


56989
56990
56991
56992
 
# File 'lib/ropencv/ropencv_types.rb', line 56989

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

#descriptor_type ⇒ Fixnum Also known as: descriptorType

Note:

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

Returns:

  • (Fixnum) 


56997
56998
56999
57000
 
# File 'lib/ropencv/ropencv_types.rb', line 56997

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


56896
56897
56898
56899
56900
56901
56902
56903
56904
56905
56906
56907
56908
56909
56910
56911
56912
56913
56914
56915
56916
56917
56918
56919
56920
56921
56922
56923
56924
56925
56926
56927
 
# File 'lib/ropencv/ropencv_types.rb', line 56896

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

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

Parameters:

Returns:

  • (Void) 


56981
56982
56983
56984
 
# File 'lib/ropencv/ropencv_types.rb', line 56981

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

#empty ⇒ Bool

Note:

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

Returns:

  • (Bool) 


57096
57097
57098
57099
 
# File 'lib/ropencv/ropencv_types.rb', line 57096

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

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

Note:

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

Returns:



56859
56860
56861
56862
56863
56864
56865
56866
56867
 
# File 'lib/ropencv/ropencv_types.rb', line 56859

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

#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) 


57061
57062
57063
57064
57065
57066
57067
57068
57069
57070
57071
57072
57073
57074
57075
57076
57077
57078
57079
57080
57081
57082
57083
57084
57085
57086
57087
57088
57089
57090
57091
57092
 
# File 'lib/ropencv/ropencv_types.rb', line 57061

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

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

Parameters:

Returns:

  • (Void) 


57125
57126
57127
57128
 
# File 'lib/ropencv/ropencv_types.rb', line 57125

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

#to_s ⇒ Object

converts SIFT into a string by crawling through all its attributes



56794
56795
56796
 
# File 'lib/ropencv/ropencv_types.rb', line 56794

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


57020
57021
57022
57023
57024
57025
57026
57027
57028
57029
57030
57031
57032
57033
57034
57035
57036
57037
57038
57039
57040
57041
57042
57043
57044
57045
57046
57047
57048
57049
57050
57051
 
# File 'lib/ropencv/ropencv_types.rb', line 57020

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

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

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