Class: OpenCV::Cv::BackgroundSubtractorKNN

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

.new(*args) ⇒ Object

Raises:

  • (ArgumentError)


39746
39747
39748
39749
39750
39751
39752
39753
# File 'lib/ropencv/ropencv_types.rb', line 39746

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



39742
39743
39744
# File 'lib/ropencv/ropencv_types.rb', line 39742

def self.null
    new(BackgroundSubtractorKNNStruct.new)
end

Instance Method Details

#apply(image, fgmask, learning_rate = -1)) ⇒ Void

Note:

method wrapper for void cv::BackgroundSubtractorKNN::apply(const cv::Mat image, cv::Mat& fgmask, double learningRate = -1)

Parameters:

  • image (Cv::Mat)
  • fgmask (Cv::Mat)
  • learning_rate (Double) (defaults to: -1))

Returns:

  • (Void)


39966
39967
39968
39969
# File 'lib/ropencv/ropencv_types.rb', line 39966

def apply(image, fgmask, learning_rate = -1)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_apply( self, image, fgmask, learning_rate)
end

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

Note:

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

Parameters:

  • parse_ownership (Bool)

Returns:



39983
39984
39985
39986
39987
39988
39989
39990
39991
# File 'lib/ropencv/ropencv_types.rb', line 39983

def cast_to_algorithm(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_background_subtractorknn_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_background_subtractor(parse_ownership) ⇒ Cv::BackgroundSubtractor Also known as: castToBackgroundSubtractor

Note:

method wrapper for cv::BackgroundSubtractor* cv::BackgroundSubtractorKNN::castToBackgroundSubtractor(bool parse_ownership)

Parameters:

  • parse_ownership (Bool)

Returns:



39950
39951
39952
39953
39954
39955
39956
39957
39958
# File 'lib/ropencv/ropencv_types.rb', line 39950

def cast_to_background_subtractor(parse_ownership)
    __validate_pointer__
    result = Rbind::cv_background_subtractorknn_cast_to_background_subtractor( 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::BackgroundSubtractorKNN::clear()

Returns:

  • (Void)


39996
39997
39998
39999
# File 'lib/ropencv/ropencv_types.rb', line 39996

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

#emptyBool

Note:

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

Returns:

  • (Bool)


40020
40021
40022
40023
# File 'lib/ropencv/ropencv_types.rb', line 40020

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

#get_background_image(background_image) ⇒ Void Also known as: getBackgroundImage

Note:

method wrapper for void cv::BackgroundSubtractorKNN::getBackgroundImage(cv::Mat& backgroundImage)

Parameters:

Returns:

  • (Void)


39974
39975
39976
39977
# File 'lib/ropencv/ropencv_types.rb', line 39974

def get_background_image(background_image)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_get_background_image( self, background_image)
end

#get_default_nameStd::String Also known as: getDefaultName

Note:

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

Returns:



40035
40036
40037
40038
40039
40040
40041
40042
40043
# File 'lib/ropencv/ropencv_types.rb', line 40035

def get_default_name()
    __validate_pointer__
    result = Rbind::cv_background_subtractorknn_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_detect_shadowsBool Also known as: getDetectShadows

Note:

method wrapper for bool cv::BackgroundSubtractorKNN::getDetectShadows()

Returns:

  • (Bool)


39898
39899
39900
39901
# File 'lib/ropencv/ropencv_types.rb', line 39898

def get_detect_shadows()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_get_detect_shadows( self)
end

#get_dist2_thresholdDouble Also known as: getDist2Threshold

Note:

method wrapper for double cv::BackgroundSubtractorKNN::getDist2Threshold()

Returns:

  • (Double)


39864
39865
39866
39867
# File 'lib/ropencv/ropencv_types.rb', line 39864

def get_dist2_threshold()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_get_dist2_threshold( self)
end

#get_historyFixnum Also known as: getHistory

Note:

method wrapper for int cv::BackgroundSubtractorKNN::getHistory()

methods

Returns:

  • (Fixnum)


39830
39831
39832
39833
# File 'lib/ropencv/ropencv_types.rb', line 39830

def get_history()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_get_history( self)
end

#get_shadow_thresholdDouble Also known as: getShadowThreshold

Note:

method wrapper for double cv::BackgroundSubtractorKNN::getShadowThreshold()

Returns:

  • (Double)


39932
39933
39934
39935
# File 'lib/ropencv/ropencv_types.rb', line 39932

def get_shadow_threshold()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_get_shadow_threshold( self)
end

#get_shadow_valueFixnum Also known as: getShadowValue

Note:

method wrapper for int cv::BackgroundSubtractorKNN::getShadowValue()

Returns:

  • (Fixnum)


39915
39916
39917
39918
# File 'lib/ropencv/ropencv_types.rb', line 39915

def get_shadow_value()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_get_shadow_value( self)
end

#getknn_samplesFixnum Also known as: getkNNSamples

Note:

method wrapper for int cv::BackgroundSubtractorKNN::getkNNSamples()

Returns:

  • (Fixnum)


39881
39882
39883
39884
# File 'lib/ropencv/ropencv_types.rb', line 39881

def getknn_samples()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_getknn_samples( self)
end

#getn_samplesFixnum Also known as: getNSamples

Note:

method wrapper for int cv::BackgroundSubtractorKNN::getNSamples()

Returns:

  • (Fixnum)


39847
39848
39849
39850
# File 'lib/ropencv/ropencv_types.rb', line 39847

def getn_samples()
    __validate_pointer__
    Rbind::cv_background_subtractorknn_getn_samples( self)
end

#read(fn) ⇒ Void

Note:

method wrapper for void cv::BackgroundSubtractorKNN::read(const cv::FileNode fn)

Parameters:

Returns:

  • (Void)


40013
40014
40015
40016
# File 'lib/ropencv/ropencv_types.rb', line 40013

def read(fn)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_read( self, fn)
end

#save(filename) ⇒ Void

Note:

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

Parameters:

Returns:

  • (Void)


40028
40029
40030
40031
# File 'lib/ropencv/ropencv_types.rb', line 40028

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

#set_detect_shadows(detect_shadows) ⇒ Void Also known as: setDetectShadows

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setDetectShadows(bool detectShadows)

Parameters:

  • detect_shadows (Bool)

Returns:

  • (Void)


39907
39908
39909
39910
# File 'lib/ropencv/ropencv_types.rb', line 39907

def set_detect_shadows(detect_shadows)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_set_detect_shadows( self, detect_shadows)
end

#set_dist2_threshold(__dist2_threshold) ⇒ Void Also known as: setDist2Threshold

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setDist2Threshold(double _dist2Threshold)

Parameters:

  • __dist2_threshold (Double)

Returns:

  • (Void)


39873
39874
39875
39876
# File 'lib/ropencv/ropencv_types.rb', line 39873

def set_dist2_threshold(__dist2_threshold)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_set_dist2_threshold( self, __dist2_threshold)
end

#set_history(history) ⇒ Void Also known as: setHistory

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setHistory(int history)

Parameters:

  • history (Fixnum)

Returns:

  • (Void)


39839
39840
39841
39842
# File 'lib/ropencv/ropencv_types.rb', line 39839

def set_history(history)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_set_history( self, history)
end

#set_shadow_threshold(threshold) ⇒ Void Also known as: setShadowThreshold

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setShadowThreshold(double threshold)

Parameters:

  • threshold (Double)

Returns:

  • (Void)


39941
39942
39943
39944
# File 'lib/ropencv/ropencv_types.rb', line 39941

def set_shadow_threshold(threshold)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_set_shadow_threshold( self, threshold)
end

#set_shadow_value(value) ⇒ Void Also known as: setShadowValue

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setShadowValue(int value)

Parameters:

  • value (Fixnum)

Returns:

  • (Void)


39924
39925
39926
39927
# File 'lib/ropencv/ropencv_types.rb', line 39924

def set_shadow_value(value)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_set_shadow_value( self, value)
end

#setknn_samples(_nk_n_n) ⇒ Void Also known as: setkNNSamples

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setkNNSamples(int _nkNN)

Parameters:

  • _nk_n_n (Fixnum)

Returns:

  • (Void)


39890
39891
39892
39893
# File 'lib/ropencv/ropencv_types.rb', line 39890

def setknn_samples(_nk_n_n)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_setknn_samples( self, _nk_n_n)
end

#setn_samples(_n_n) ⇒ Void Also known as: setNSamples

Note:

method wrapper for void cv::BackgroundSubtractorKNN::setNSamples(int _nN)

Parameters:

  • _n_n (Fixnum)

Returns:

  • (Void)


39856
39857
39858
39859
# File 'lib/ropencv/ropencv_types.rb', line 39856

def setn_samples(_n_n)
    __validate_pointer__
    Rbind::cv_background_subtractorknn_setn_samples( self, _n_n)
end

#to_sObject

converts BackgroundSubtractorKNN into a string by crawling through all its attributes



39819
39820
39821
# File 'lib/ropencv/ropencv_types.rb', line 39819

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

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

Note:

method wrapper for void cv::BackgroundSubtractorKNN::write(const cv::Ptrcv::FileStorage fs, const std::string name = String())

Parameters:

Returns:

  • (Void)


40005
40006
40007
40008
# File 'lib/ropencv/ropencv_types.rb', line 40005

def write(fs, name = Std::String.new())
    __validate_pointer__
    Rbind::cv_background_subtractorknn_write( self, fs, name)
end