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

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

Clears the algorithm state

Positional Arguments

• self: Evision.Legacy.TrackerKCF.t()

Python prototype (for reference only):

clear() -> None

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

Constructor

Return

• retval: legacy::TrackerKCF

Python prototype (for reference only):

create() -> retval

@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.Legacy.TrackerKCF.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.Legacy.TrackerKCF.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 init(t(), Evision.Mat.maybe_mat_in(), {number(), number(), number(), number()}) ::
  boolean() | {:error, String.t()}

Initialize the tracker with a known bounding box that surrounded the target

Positional Arguments

• self: Evision.Legacy.TrackerKCF.t()

• image: Evision.Mat.

  The initial frame

• boundingBox: Rect2d.

  The initial bounding box

Return

• retval: bool

@return True if initialization went succesfully, false otherwise

Python prototype (for reference only):

init(image, boundingBox) -> retval

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

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.Legacy.TrackerKCF.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.Legacy.TrackerKCF.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 update(t(), Evision.Mat.maybe_mat_in()) ::
  {number(), number(), number(), number()} | false | {:error, String.t()}

Update the tracker, find the new most likely bounding box for the target

Positional Arguments

• self: Evision.Legacy.TrackerKCF.t()

• image: Evision.Mat.

  The current frame

Return

• retval: bool

• boundingBox: Rect2d.

  The bounding box that represent the new target location, if true was returned, not modified otherwise

@return True means that target was located and false means that tracker cannot locate target in current frame. Note, that latter does not imply that tracker has failed, maybe target is indeed missing from the frame (say, out of sight)

Python prototype (for reference only):

update(image) -> retval, boundingBox

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

Stores algorithm parameters in a file storage

Positional Arguments

• self: Evision.Legacy.TrackerKCF.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.Legacy.TrackerKCF.t()
• fs: Evision.FileStorage
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None