View Source Evision.OdometryFrame (Evision v1.0.0-rc.0)

Summary

Types

t()

Type that represents an OdometryFrame struct.

Functions

Get the original user-provided depth image

Get the original user-provided depth image

Get the gray image generated from the user-provided BGR/Gray image

Get the gray image generated from the user-provided BGR/Gray image

Get the original user-provided BGR/Gray image

Get the original user-provided BGR/Gray image

Get the valid pixels mask generated for the ICP calculations intersected with the user-provided mask

Get the valid pixels mask generated for the ICP calculations intersected with the user-provided mask

Get the normals image either generated for the ICP calculations or user-provided

Get the normals image either generated for the ICP calculations or user-provided

Get the depth image generated from the user-provided one after conversion, rescale or filtering for ICP algorithm needs

Get the depth image generated from the user-provided one after conversion, rescale or filtering for ICP algorithm needs

Get the image generated for the ICP calculations from one of the pyramids specified by pyrType. Returns empty image if the pyramid is empty or there's no such pyramid level

Get the image generated for the ICP calculations from one of the pyramids specified by pyrType. Returns empty image if the pyramid is empty or there's no such pyramid level

Get the amount of levels in pyramids (all of them if not empty should have the same number of levels) or 0 if no pyramids were prepared yet

Construct a new OdometryFrame object. All non-empty images should have the same size.

Construct a new OdometryFrame object. All non-empty images should have the same size.

Types

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

Type that represents an OdometryFrame struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

@spec getDepth(Keyword.t()) :: any() | {:error, String.t()}
@spec getDepth(t()) :: Evision.Mat.t() | {:error, String.t()}

Get the original user-provided depth image

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • depth: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getDepth([, depth]) -> depth
@spec getDepth(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Get the original user-provided depth image

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • depth: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getDepth([, depth]) -> depth
Link to this function

getGrayImage(named_args)

View Source
@spec getGrayImage(Keyword.t()) :: any() | {:error, String.t()}
@spec getGrayImage(t()) :: Evision.Mat.t() | {:error, String.t()}

Get the gray image generated from the user-provided BGR/Gray image

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • image: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getGrayImage([, image]) -> image
Link to this function

getGrayImage(self, opts)

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

Get the gray image generated from the user-provided BGR/Gray image

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • image: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getGrayImage([, image]) -> image
@spec getImage(Keyword.t()) :: any() | {:error, String.t()}
@spec getImage(t()) :: Evision.Mat.t() | {:error, String.t()}

Get the original user-provided BGR/Gray image

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • image: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getImage([, image]) -> image
@spec getImage(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Get the original user-provided BGR/Gray image

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • image: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getImage([, image]) -> image
@spec getMask(Keyword.t()) :: any() | {:error, String.t()}
@spec getMask(t()) :: Evision.Mat.t() | {:error, String.t()}

Get the valid pixels mask generated for the ICP calculations intersected with the user-provided mask

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • mask: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getMask([, mask]) -> mask
@spec getMask(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Get the valid pixels mask generated for the ICP calculations intersected with the user-provided mask

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • mask: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getMask([, mask]) -> mask
@spec getNormals(Keyword.t()) :: any() | {:error, String.t()}
@spec getNormals(t()) :: Evision.Mat.t() | {:error, String.t()}

Get the normals image either generated for the ICP calculations or user-provided

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • normals: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getNormals([, normals]) -> normals
@spec getNormals(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Get the normals image either generated for the ICP calculations or user-provided

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • normals: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getNormals([, normals]) -> normals
Link to this function

getProcessedDepth(named_args)

View Source
@spec getProcessedDepth(Keyword.t()) :: any() | {:error, String.t()}
@spec getProcessedDepth(t()) :: Evision.Mat.t() | {:error, String.t()}

Get the depth image generated from the user-provided one after conversion, rescale or filtering for ICP algorithm needs

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • depth: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getProcessedDepth([, depth]) -> depth
Link to this function

getProcessedDepth(self, opts)

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

Get the depth image generated from the user-provided one after conversion, rescale or filtering for ICP algorithm needs

Positional Arguments
  • self: Evision.OdometryFrame.t()
Return
  • depth: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getProcessedDepth([, depth]) -> depth
Link to this function

getPyramidAt(named_args)

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

getPyramidAt(self, pyrType, level)

View Source
@spec getPyramidAt(t(), Evision.OdometryFramePyramidType.enum(), integer()) ::
  Evision.Mat.t() | {:error, String.t()}

Get the image generated for the ICP calculations from one of the pyramids specified by pyrType. Returns empty image if the pyramid is empty or there's no such pyramid level

Positional Arguments
  • self: Evision.OdometryFrame.t()

  • pyrType: OdometryFramePyramidType.

    Type of pyramid

  • level: size_t.

    Level in the pyramid

Return
  • img: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getPyramidAt(pyrType, level[, img]) -> img
Link to this function

getPyramidAt(self, pyrType, level, opts)

View Source
@spec getPyramidAt(
  t(),
  Evision.OdometryFramePyramidType.enum(),
  integer(),
  [{atom(), term()}, ...] | nil
) :: Evision.Mat.t() | {:error, String.t()}

Get the image generated for the ICP calculations from one of the pyramids specified by pyrType. Returns empty image if the pyramid is empty or there's no such pyramid level

Positional Arguments
  • self: Evision.OdometryFrame.t()

  • pyrType: OdometryFramePyramidType.

    Type of pyramid

  • level: size_t.

    Level in the pyramid

Return
  • img: Evision.Mat.t().

    Output image

Python prototype (for reference only):

getPyramidAt(pyrType, level[, img]) -> img
Link to this function

getPyramidLevels(named_args)

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

Get the amount of levels in pyramids (all of them if not empty should have the same number of levels) or 0 if no pyramids were prepared yet

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

Python prototype (for reference only):

getPyramidLevels() -> retval
@spec odometryFrame() :: t() | {:error, String.t()}

Construct a new OdometryFrame object. All non-empty images should have the same size.

Keyword Arguments
  • depth: Evision.Mat.

    A depth image, should be CV_8UC1

  • image: Evision.Mat.

    An BGR or grayscale image (or noArray() if it's not required for used ICP algorithm). Should be CV_8UC3 or CV_8C4 if it's BGR image or CV_8UC1 if it's grayscale. If it's BGR then it's converted to grayscale image automatically.

  • mask: Evision.Mat.

    A user-provided mask of valid pixels, should be CV_8UC1

  • normals: Evision.Mat.

    A user-provided normals to the depth surface, should be CV_32FC4

Return
  • self: Evision.OdometryFrame.t()

Python prototype (for reference only):

OdometryFrame([, depth[, image[, mask[, normals]]]]) -> <OdometryFrame object>
Link to this function

odometryFrame(named_args)

View Source
@spec odometryFrame(Keyword.t()) :: any() | {:error, String.t()}
@spec odometryFrame(
  [depth: term(), image: term(), mask: term(), normals: term()]
  | nil
) ::
  t() | {:error, String.t()}

Construct a new OdometryFrame object. All non-empty images should have the same size.

Keyword Arguments
  • depth: Evision.Mat.

    A depth image, should be CV_8UC1

  • image: Evision.Mat.

    An BGR or grayscale image (or noArray() if it's not required for used ICP algorithm). Should be CV_8UC3 or CV_8C4 if it's BGR image or CV_8UC1 if it's grayscale. If it's BGR then it's converted to grayscale image automatically.

  • mask: Evision.Mat.

    A user-provided mask of valid pixels, should be CV_8UC1

  • normals: Evision.Mat.

    A user-provided normals to the depth surface, should be CV_32FC4

Return
  • self: Evision.OdometryFrame.t()

Python prototype (for reference only):

OdometryFrame([, depth[, image[, mask[, normals]]]]) -> <OdometryFrame object>