View Source Evision.XImgProc.EdgeBoxes (Evision v0.2.4)

Summary

Types

t()

Type that represents an XImgProc.EdgeBoxes struct.

Functions

Clears the algorithm state

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

Returns the step size of sliding window search.

Returns the nms threshold for object proposals.

Returns array containing proposal boxes.

Returns array containing proposal boxes.

Returns the cluster min magnitude.

Returns the edge merge threshold.

Returns the edge min magnitude.

Returns adaptation rate for nms threshold.

Returns the affinity sensitivity.

Returns the scale sensitivity.

Returns the max aspect ratio of boxes.

Returns the max number of boxes to detect.

Returns the minimum area of boxes.

Returns the min score of boxes to detect.

Reads algorithm parameters from a file storage

Sets the step size of sliding window search.

Sets the nms threshold for object proposals.

Sets the cluster min magnitude.

Sets the edge merge threshold.

Sets the edge min magnitude.

Sets the adaptation rate for nms threshold.

Sets the affinity sensitivity

Sets the scale sensitivity.

Sets the max aspect ratio of boxes.

Sets max number of boxes to detect.

Sets the minimum area of boxes.

Sets the min score of boxes to detect.

Stores algorithm parameters in a file storage

Types

@type t() :: %Evision.XImgProc.EdgeBoxes{ref: reference()}

Type that represents an XImgProc.EdgeBoxes struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

Clears the algorithm state

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.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.XImgProc.EdgeBoxes.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
@spec getAlpha(Keyword.t()) :: any() | {:error, String.t()}
@spec getAlpha(t()) :: number() | {:error, String.t()}

Returns the step size of sliding window search.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getAlpha() -> retval
@spec getBeta(Keyword.t()) :: any() | {:error, String.t()}
@spec getBeta(t()) :: number() | {:error, String.t()}

Returns the nms threshold for object proposals.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getBeta() -> retval
Link to this function

getBoundingBoxes(named_args)

View Source
@spec getBoundingBoxes(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

getBoundingBoxes(self, edge_map, orientation_map)

View Source
@spec getBoundingBoxes(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) ::
  {[{number(), number(), number(), number()}], Evision.Mat.t()}
  | {:error, String.t()}

Returns array containing proposal boxes.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()

  • edge_map: Evision.Mat.

    edge image.

  • orientation_map: Evision.Mat.

    orientation map.

Return
  • boxes: [Rect].

    proposal boxes.

  • scores: Evision.Mat.t().

    of the proposal boxes, provided a vector of float types.

Python prototype (for reference only):

getBoundingBoxes(edge_map, orientation_map[, scores]) -> boxes, scores
Link to this function

getBoundingBoxes(self, edge_map, orientation_map, opts)

View Source
@spec getBoundingBoxes(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) ::
  {[{number(), number(), number(), number()}], Evision.Mat.t()}
  | {:error, String.t()}

Returns array containing proposal boxes.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()

  • edge_map: Evision.Mat.

    edge image.

  • orientation_map: Evision.Mat.

    orientation map.

Return
  • boxes: [Rect].

    proposal boxes.

  • scores: Evision.Mat.t().

    of the proposal boxes, provided a vector of float types.

Python prototype (for reference only):

getBoundingBoxes(edge_map, orientation_map[, scores]) -> boxes, scores
Link to this function

getClusterMinMag(named_args)

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

Returns the cluster min magnitude.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getClusterMinMag() -> retval
Link to this function

getDefaultName(named_args)

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

getDefaultName

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return

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
Link to this function

getEdgeMergeThr(named_args)

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

Returns the edge merge threshold.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getEdgeMergeThr() -> retval
Link to this function

getEdgeMinMag(named_args)

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

Returns the edge min magnitude.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getEdgeMinMag() -> retval
@spec getEta(Keyword.t()) :: any() | {:error, String.t()}
@spec getEta(t()) :: number() | {:error, String.t()}

Returns adaptation rate for nms threshold.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getEta() -> retval
@spec getGamma(Keyword.t()) :: any() | {:error, String.t()}
@spec getGamma(t()) :: number() | {:error, String.t()}

Returns the affinity sensitivity.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getGamma() -> retval
@spec getKappa(Keyword.t()) :: any() | {:error, String.t()}
@spec getKappa(t()) :: number() | {:error, String.t()}

Returns the scale sensitivity.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getKappa() -> retval
Link to this function

getMaxAspectRatio(named_args)

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

Returns the max aspect ratio of boxes.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getMaxAspectRatio() -> retval
@spec getMaxBoxes(Keyword.t()) :: any() | {:error, String.t()}
@spec getMaxBoxes(t()) :: integer() | {:error, String.t()}

Returns the max number of boxes to detect.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: integer()

Python prototype (for reference only):

getMaxBoxes() -> retval
Link to this function

getMinBoxArea(named_args)

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

Returns the minimum area of boxes.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getMinBoxArea() -> retval
@spec getMinScore(Keyword.t()) :: any() | {:error, String.t()}
@spec getMinScore(t()) :: number() | {:error, String.t()}

Returns the min score of boxes to detect.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
Return
  • retval: float

Python prototype (for reference only):

getMinScore() -> retval
@spec read(Keyword.t()) :: any() | {:error, String.t()}
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

read(fn) -> None
@spec save(Keyword.t()) :: any() | {:error, String.t()}
@spec save(t(), binary()) :: t() | {:error, String.t()}

save

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.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 setAlpha(Keyword.t()) :: any() | {:error, String.t()}
@spec setAlpha(t(), number()) :: t() | {:error, String.t()}

Sets the step size of sliding window search.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setAlpha(value) -> None
@spec setBeta(Keyword.t()) :: any() | {:error, String.t()}
@spec setBeta(t(), number()) :: t() | {:error, String.t()}

Sets the nms threshold for object proposals.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setBeta(value) -> None
Link to this function

setClusterMinMag(named_args)

View Source
@spec setClusterMinMag(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setClusterMinMag(self, value)

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

Sets the cluster min magnitude.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setClusterMinMag(value) -> None
Link to this function

setEdgeMergeThr(named_args)

View Source
@spec setEdgeMergeThr(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setEdgeMergeThr(self, value)

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

Sets the edge merge threshold.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setEdgeMergeThr(value) -> None
Link to this function

setEdgeMinMag(named_args)

View Source
@spec setEdgeMinMag(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setEdgeMinMag(self, value)

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

Sets the edge min magnitude.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setEdgeMinMag(value) -> None
@spec setEta(Keyword.t()) :: any() | {:error, String.t()}
@spec setEta(t(), number()) :: t() | {:error, String.t()}

Sets the adaptation rate for nms threshold.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setEta(value) -> None
@spec setGamma(Keyword.t()) :: any() | {:error, String.t()}
@spec setGamma(t(), number()) :: t() | {:error, String.t()}

Sets the affinity sensitivity

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setGamma(value) -> None
@spec setKappa(Keyword.t()) :: any() | {:error, String.t()}
@spec setKappa(t(), number()) :: t() | {:error, String.t()}

Sets the scale sensitivity.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setKappa(value) -> None
Link to this function

setMaxAspectRatio(named_args)

View Source
@spec setMaxAspectRatio(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMaxAspectRatio(self, value)

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

Sets the max aspect ratio of boxes.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setMaxAspectRatio(value) -> None
@spec setMaxBoxes(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMaxBoxes(self, value)

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

Sets max number of boxes to detect.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: integer()

Python prototype (for reference only):

setMaxBoxes(value) -> None
Link to this function

setMinBoxArea(named_args)

View Source
@spec setMinBoxArea(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMinBoxArea(self, value)

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

Sets the minimum area of boxes.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setMinBoxArea(value) -> None
@spec setMinScore(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setMinScore(self, value)

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

Sets the min score of boxes to detect.

Positional Arguments
  • self: Evision.XImgProc.EdgeBoxes.t()
  • value: float

Python prototype (for reference only):

setMinScore(value) -> None
@spec write(Keyword.t()) :: any() | {:error, String.t()}
@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

Python prototype (for reference only):

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

write

Positional Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None