View Source Evision.XImgProc.SelectiveSearchSegmentationStrategy (Evision v0.2.9)

Summary

Types

t()

Type that represents an XImgProc.SelectiveSearchSegmentationStrategy struct.

Functions

Clears the algorithm state

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

Return the score between two regions (between 0 and 1)

Inform the strategy that two regions will be merged

Reads algorithm parameters from a file storage

Set a initial image, with a segmentation.

Set a initial image, with a segmentation.

Stores algorithm parameters in a file storage

Types

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

Type that represents an XImgProc.SelectiveSearchSegmentationStrategy 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.SelectiveSearchSegmentationStrategy.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.SelectiveSearchSegmentationStrategy.t()
Return
  • retval: bool

Python prototype (for reference only):

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

Return the score between two regions (between 0 and 1)

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

  • r1: integer().

    The first region

  • r2: integer().

    The second region

Return
  • retval: float

Python prototype (for reference only):

get(r1, r2) -> 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.SelectiveSearchSegmentationStrategy.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
@spec merge(Keyword.t()) :: any() | {:error, String.t()}
@spec merge(t(), integer(), integer()) :: t() | {:error, String.t()}

Inform the strategy that two regions will be merged

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

  • r1: integer().

    The first region

  • r2: integer().

    The second region

Python prototype (for reference only):

merge(r1, r2) -> None
@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
  • self: Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()
  • func: Evision.FileNode

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.SelectiveSearchSegmentationStrategy.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 setImage(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setImage(self, img, regions, sizes)

View Source
@spec setImage(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in()
) ::
  t() | {:error, String.t()}

Set a initial image, with a segmentation.

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

  • img: Evision.Mat.

    The input image. Any number of channel can be provided

  • regions: Evision.Mat.

    A segmentation of the image. The parameter must be the same size of img.

  • sizes: Evision.Mat.

    The sizes of different regions

Keyword Arguments
  • image_id: integer().

    If not set to -1, try to cache pre-computations. If the same set og (img, regions, size) is used, the image_id need to be the same.

Python prototype (for reference only):

setImage(img, regions, sizes[, image_id]) -> None
Link to this function

setImage(self, img, regions, sizes, opts)

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

Set a initial image, with a segmentation.

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

  • img: Evision.Mat.

    The input image. Any number of channel can be provided

  • regions: Evision.Mat.

    A segmentation of the image. The parameter must be the same size of img.

  • sizes: Evision.Mat.

    The sizes of different regions

Keyword Arguments
  • image_id: integer().

    If not set to -1, try to cache pre-computations. If the same set og (img, regions, size) is used, the image_id need to be the same.

Python prototype (for reference only):

setImage(img, regions, sizes[, image_id]) -> 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