View Source Evision.BgSegm.BackgroundSubtractorGMG (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an BgSegm.BackgroundSubtractorGMG struct.

Functions

Returns the prior probability that each individual pixel is a background pixel.

Returns the value of decision threshold.

Returns the learning rate of the algorithm.

Returns total number of distinct colors to maintain in histogram.

Returns the maximum value taken on by pixels in image sequence. e.g. 1.0 or 255.

Returns the minimum value taken on by pixels in image sequence. Usually 0.

Returns the number of frames used to initialize background model.

Returns the parameter used for quantization of color-space.

Returns the kernel radius used for morphological operations

Returns the status of background model update

Sets the prior probability that each individual pixel is a background pixel.

Sets the value of decision threshold.

Sets the learning rate of the algorithm.

Sets total number of distinct colors to maintain in histogram.

Sets the maximum value taken on by pixels in image sequence.

Sets the minimum value taken on by pixels in image sequence.

Sets the number of frames used to initialize background model.

Sets the parameter used for quantization of color-space

Sets the kernel radius used for morphological operations

Sets the status of background model update

Link to this section Types

@type t() :: %Evision.BgSegm.BackgroundSubtractorGMG{ref: reference()}

Type that represents an BgSegm.BackgroundSubtractorGMG struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

Link to this function

getBackgroundPrior(self)

View Source
@spec getBackgroundPrior(t()) :: number() | {:error, String.t()}

Returns the prior probability that each individual pixel is a background pixel.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: double

Python prototype (for reference only):

getBackgroundPrior() -> retval
Link to this function

getDecisionThreshold(self)

View Source
@spec getDecisionThreshold(t()) :: number() | {:error, String.t()}

Returns the value of decision threshold.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: double

Decision value is the value above which pixel is determined to be FG.

Python prototype (for reference only):

getDecisionThreshold() -> retval
Link to this function

getDefaultLearningRate(self)

View Source
@spec getDefaultLearningRate(t()) :: number() | {:error, String.t()}

Returns the learning rate of the algorithm.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: double

It lies between 0.0 and 1.0. It determines how quickly features are "forgotten" from histograms.

Python prototype (for reference only):

getDefaultLearningRate() -> retval
@spec getMaxFeatures(t()) :: integer() | {:error, String.t()}

Returns total number of distinct colors to maintain in histogram.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: int

Python prototype (for reference only):

getMaxFeatures() -> retval
@spec getMaxVal(t()) :: number() | {:error, String.t()}

Returns the maximum value taken on by pixels in image sequence. e.g. 1.0 or 255.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxVal() -> retval
@spec getMinVal(t()) :: number() | {:error, String.t()}

Returns the minimum value taken on by pixels in image sequence. Usually 0.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: double

Python prototype (for reference only):

getMinVal() -> retval
@spec getNumFrames(t()) :: integer() | {:error, String.t()}

Returns the number of frames used to initialize background model.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: int

Python prototype (for reference only):

getNumFrames() -> retval
Link to this function

getQuantizationLevels(self)

View Source
@spec getQuantizationLevels(t()) :: integer() | {:error, String.t()}

Returns the parameter used for quantization of color-space.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: int

It is the number of discrete levels in each channel to be used in histograms.

Python prototype (for reference only):

getQuantizationLevels() -> retval
Link to this function

getSmoothingRadius(self)

View Source
@spec getSmoothingRadius(t()) :: integer() | {:error, String.t()}

Returns the kernel radius used for morphological operations

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: int

Python prototype (for reference only):

getSmoothingRadius() -> retval
Link to this function

getUpdateBackgroundModel(self)

View Source
@spec getUpdateBackgroundModel(t()) :: boolean() | {:error, String.t()}

Returns the status of background model update

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
Return
  • retval: bool

Python prototype (for reference only):

getUpdateBackgroundModel() -> retval
Link to this function

setBackgroundPrior(self, bgprior)

View Source
@spec setBackgroundPrior(t(), number()) :: t() | {:error, String.t()}

Sets the prior probability that each individual pixel is a background pixel.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • bgprior: double

Python prototype (for reference only):

setBackgroundPrior(bgprior) -> None
Link to this function

setDecisionThreshold(self, thresh)

View Source
@spec setDecisionThreshold(t(), number()) :: t() | {:error, String.t()}

Sets the value of decision threshold.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • thresh: double

Python prototype (for reference only):

setDecisionThreshold(thresh) -> None
Link to this function

setDefaultLearningRate(self, lr)

View Source
@spec setDefaultLearningRate(t(), number()) :: t() | {:error, String.t()}

Sets the learning rate of the algorithm.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • lr: double

Python prototype (for reference only):

setDefaultLearningRate(lr) -> None
Link to this function

setMaxFeatures(self, maxFeatures)

View Source
@spec setMaxFeatures(t(), integer()) :: t() | {:error, String.t()}

Sets total number of distinct colors to maintain in histogram.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • maxFeatures: int

Python prototype (for reference only):

setMaxFeatures(maxFeatures) -> None
@spec setMaxVal(t(), number()) :: t() | {:error, String.t()}

Sets the maximum value taken on by pixels in image sequence.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • val: double

Python prototype (for reference only):

setMaxVal(val) -> None
@spec setMinVal(t(), number()) :: t() | {:error, String.t()}

Sets the minimum value taken on by pixels in image sequence.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • val: double

Python prototype (for reference only):

setMinVal(val) -> None
Link to this function

setNumFrames(self, nframes)

View Source
@spec setNumFrames(t(), integer()) :: t() | {:error, String.t()}

Sets the number of frames used to initialize background model.

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • nframes: int

Python prototype (for reference only):

setNumFrames(nframes) -> None
Link to this function

setQuantizationLevels(self, nlevels)

View Source
@spec setQuantizationLevels(t(), integer()) :: t() | {:error, String.t()}

Sets the parameter used for quantization of color-space

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • nlevels: int

Python prototype (for reference only):

setQuantizationLevels(nlevels) -> None
Link to this function

setSmoothingRadius(self, radius)

View Source
@spec setSmoothingRadius(t(), integer()) :: t() | {:error, String.t()}

Sets the kernel radius used for morphological operations

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • radius: int

Python prototype (for reference only):

setSmoothingRadius(radius) -> None
Link to this function

setUpdateBackgroundModel(self, update)

View Source
@spec setUpdateBackgroundModel(t(), boolean()) :: t() | {:error, String.t()}

Sets the status of background model update

Positional Arguments
  • self: Evision.BgSegm.BackgroundSubtractorGMG.t()
  • update: bool

Python prototype (for reference only):

setUpdateBackgroundModel(update) -> None