View Source Evision.StructuredLight.StructuredLightPattern (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an StructuredLight.StructuredLightPattern struct.

Functions

Clears the algorithm state

Decodes the structured light pattern, generating a disparity map

Decodes the structured light pattern, generating a disparity map

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

Generates the structured light pattern to project.

Generates the structured light pattern to project.

getDefaultName

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Link to this section Types

@type t() :: %Evision.StructuredLight.StructuredLightPattern{ref: reference()}

Type that represents an StructuredLight.StructuredLightPattern struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

Clears the algorithm state

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()

Python prototype (for reference only):

clear() -> None
Link to this function

decode(self, patternImages)

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

Decodes the structured light pattern, generating a disparity map

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()

  • patternImages: [[Evision.Mat]].

    The acquired pattern images to decode (vector<vector<Mat>>), loaded as grayscale and previously rectified.

Keyword Arguments
  • blackImages: [Evision.Mat].

    The all-black images needed for shadowMasks computation.

  • whiteImages: [Evision.Mat].

    The all-white images needed for shadowMasks computation.

  • flags: int.

    Flags setting decoding algorithms. Default: DECODE_3D_UNDERWORLD.

Return
  • retval: bool

  • disparityMap: Evision.Mat.t().

    The decoding result: a CV_64F Mat at image resolution, storing the computed disparity map.

Note: All the images must be at the same resolution.

Python prototype (for reference only):

decode(patternImages[, disparityMap[, blackImages[, whiteImages[, flags]]]]) -> retval, disparityMap
Link to this function

decode(self, patternImages, opts)

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

Decodes the structured light pattern, generating a disparity map

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()

  • patternImages: [[Evision.Mat]].

    The acquired pattern images to decode (vector<vector<Mat>>), loaded as grayscale and previously rectified.

Keyword Arguments
  • blackImages: [Evision.Mat].

    The all-black images needed for shadowMasks computation.

  • whiteImages: [Evision.Mat].

    The all-white images needed for shadowMasks computation.

  • flags: int.

    Flags setting decoding algorithms. Default: DECODE_3D_UNDERWORLD.

Return
  • retval: bool

  • disparityMap: Evision.Mat.t().

    The decoding result: a CV_64F Mat at image resolution, storing the computed disparity map.

Note: All the images must be at the same resolution.

Python prototype (for reference only):

decode(patternImages[, disparityMap[, blackImages[, whiteImages[, flags]]]]) -> retval, disparityMap
@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.StructuredLight.StructuredLightPattern.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
@spec generate(t()) :: [Evision.Mat.t()] | false | {:error, String.t()}

Generates the structured light pattern to project.

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()
Return
  • retval: bool

  • patternImages: [Evision.Mat].

    The generated pattern: a vector<Mat>, in which each image is a CV_8U Mat at projector's resolution.

Python prototype (for reference only):

generate([, patternImages]) -> retval, patternImages
@spec generate(t(), [{atom(), term()}, ...] | nil) ::
  [Evision.Mat.t()] | false | {:error, String.t()}

Generates the structured light pattern to project.

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()
Return
  • retval: bool

  • patternImages: [Evision.Mat].

    The generated pattern: a vector<Mat>, in which each image is a CV_8U Mat at projector's resolution.

Python prototype (for reference only):

generate([, patternImages]) -> retval, patternImages
@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.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 read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()
  • fn_: Evision.FileNode.t()

Python prototype (for reference only):

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

save

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.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 write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()
  • fs: Evision.FileStorage.t()

Python prototype (for reference only):

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

write

Positional Arguments
  • self: Evision.StructuredLight.StructuredLightPattern.t()
  • fs: Evision.FileStorage.t()
  • name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None