@spec clear(Keyword.t()) :: any() | {:error, String.t()}

@spec clear(t()) :: t() | {:error, String.t()}

Clears the algorithm state

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()

Python prototype (for reference only):

clear() -> None

@spec empty(Keyword.t()) :: any() | {:error, String.t()}

@spec empty(t()) :: boolean() | {:error, String.t()}

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

@spec getDefaultName(Keyword.t()) :: any() | {:error, String.t()}

@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()

Return

• retval: String

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

Python prototype (for reference only):

getDefaultName() -> retval

@spec getNextFrame(Keyword.t()) :: any() | {:error, String.t()}

@spec getNextFrame(t()) :: {Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}

Obtain the next frame in the sequence.

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()

Return

• frame: Evision.Mat.t().

  Output frame.

• gtMask: Evision.Mat.t().

  Output ground-truth (reference) segmentation mask object/background.

Python prototype (for reference only):

getNextFrame([, frame[, gtMask]]) -> frame, gtMask

@spec getNextFrame(t(), [{atom(), term()}, ...] | nil) ::
  {Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}

Obtain the next frame in the sequence.

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()

Return

• frame: Evision.Mat.t().

  Output frame.

• gtMask: Evision.Mat.t().

  Output ground-truth (reference) segmentation mask object/background.

Python prototype (for reference only):

getNextFrame([, frame[, gtMask]]) -> frame, gtMask

@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()
• func: Evision.FileNode

Python prototype (for reference only):

read(fn) -> None

@spec save(t(), binary()) :: t() | {:error, String.t()}

save

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()
• filename: String

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

Python prototype (for reference only):

save(filename) -> None

@spec syntheticSequenceGenerator(
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  number(),
  number(),
  number(),
  number()
) :: t() | {:error, String.t()}

Creates an instance of SyntheticSequenceGenerator.

Positional Arguments

• background: Evision.Mat.

  Background image for object.

• object: Evision.Mat.

  Object image which will move slowly over the background.

• amplitude: double.

  Amplitude of wave distortion applied to background.

• wavelength: double.

  Length of waves in distortion applied to background.

• wavespeed: double.

  How fast waves will move.

• objspeed: double.

  How fast object will fly over background.

Return

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()

Python prototype (for reference only):

SyntheticSequenceGenerator(background, object, amplitude, wavelength, wavespeed, objspeed) -> <bgsegm_SyntheticSequenceGenerator object>

@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()
• fs: Evision.FileStorage

Python prototype (for reference only):

write(fs) -> None

@spec write(t(), Evision.FileStorage.t(), binary()) :: t() | {:error, String.t()}

write

Positional Arguments

• self: Evision.BgSegm.SyntheticSequenceGenerator.t()
• fs: Evision.FileStorage
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None