View Source Evision.XImgProc.Segmentation.SelectiveSearchSegmentationStrategy (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an XImgProc.Segmentation.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)

getDefaultName

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

Link to this section Types

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

Type that represents an XImgProc.Segmentation.SelectiveSearchSegmentationStrategy struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

Clears the algorithm state

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

Python prototype (for reference only):

clear() -> None
@spec empty(Evision.XImgProc.SelectiveSearchSegmentationStrategy.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.Segmentation.SelectiveSearchSegmentationStrategy.t()
Return
  • retval: bool

Python prototype (for reference only):

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

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

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

  • r1: int.

    The first region

  • r2: int.

    The second region

Return
  • retval: float

Python prototype (for reference only):

get(r1, r2) -> retval
@spec getDefaultName(Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()) ::
  binary() | {:error, String.t()}

getDefaultName

Positional Arguments
  • self: Evision.XImgProc.Segmentation.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(
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t(),
  integer(),
  integer()
) ::
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()
  | {:error, String.t()}

Inform the strategy that two regions will be merged

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

  • r1: int.

    The first region

  • r2: int.

    The second region

Python prototype (for reference only):

merge(r1, r2) -> None
@spec read(
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t(),
  Evision.FileNode.t()
) ::
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()
  | {:error, String.t()}

Reads algorithm parameters from a file storage

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

Python prototype (for reference only):

read(fn_) -> None
@spec save(Evision.XImgProc.SelectiveSearchSegmentationStrategy.t(), binary()) ::
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()
  | {:error, String.t()}

save

Positional Arguments
  • self: Evision.XImgProc.Segmentation.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
Link to this function

setImage(self, img, regions, sizes)

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

Set a initial image, with a segmentation.

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

  • img: Evision.Mat.t().

    The input image. Any number of channel can be provided

  • regions: Evision.Mat.t().

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

  • sizes: Evision.Mat.t().

    The sizes of different regions

Keyword Arguments
  • image_id: int.

    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(
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) ::
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()
  | {:error, String.t()}

Set a initial image, with a segmentation.

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

  • img: Evision.Mat.t().

    The input image. Any number of channel can be provided

  • regions: Evision.Mat.t().

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

  • sizes: Evision.Mat.t().

    The sizes of different regions

Keyword Arguments
  • image_id: int.

    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(
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t(),
  Evision.FileStorage.t()
) ::
  Evision.XImgProc.SelectiveSearchSegmentationStrategy.t()
  | {:error, String.t()}

Stores algorithm parameters in a file storage

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

Python prototype (for reference only):

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

write

Positional Arguments
  • self: Evision.XImgProc.Segmentation.SelectiveSearchSegmentationStrategy.t()
  • fs: Evision.FileStorage.t()
  • name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None