View Source Evision.RGBD.RgbdOdometry (Evision v0.2.7)

Summary

Types

t()

Type that represents an RGBD.RgbdOdometry struct.

Types

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

Type that represents an RGBD.RgbdOdometry struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

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

create

Keyword Arguments
  • cameraMatrix: Evision.Mat.

    Camera matrix

  • minDepth: float.

    Pixels with depth less than minDepth will not be used (in meters)

  • maxDepth: float.

    Pixels with depth larger than maxDepth will not be used (in meters)

  • maxDepthDiff: float.

    Correspondences between pixels of two given frames will be filtered out if their depth difference is larger than maxDepthDiff (in meters)

  • iterCounts: [integer()].

    Count of iterations on each pyramid level.

  • minGradientMagnitudes: [float].

    For each pyramid level the pixels will be filtered out if they have gradient magnitude less than minGradientMagnitudes[level].

  • maxPointsPart: float.

    The method uses a random pixels subset of size frameWidth x frameHeight x pointsPart

  • transformType: integer().

    Class of transformation

Return
  • retval: RgbdOdometry

Constructor.

Python prototype (for reference only):

create([, cameraMatrix[, minDepth[, maxDepth[, maxDepthDiff[, iterCounts[, minGradientMagnitudes[, maxPointsPart[, transformType]]]]]]]]) -> retval
@spec create(Keyword.t()) :: any() | {:error, String.t()}
@spec create(
  [
    cameraMatrix: term(),
    iterCounts: term(),
    maxDepth: term(),
    maxDepthDiff: term(),
    maxPointsPart: term(),
    minDepth: term(),
    minGradientMagnitudes: term(),
    transformType: term()
  ]
  | nil
) :: t() | {:error, String.t()}

create

Keyword Arguments
  • cameraMatrix: Evision.Mat.

    Camera matrix

  • minDepth: float.

    Pixels with depth less than minDepth will not be used (in meters)

  • maxDepth: float.

    Pixels with depth larger than maxDepth will not be used (in meters)

  • maxDepthDiff: float.

    Correspondences between pixels of two given frames will be filtered out if their depth difference is larger than maxDepthDiff (in meters)

  • iterCounts: [integer()].

    Count of iterations on each pyramid level.

  • minGradientMagnitudes: [float].

    For each pyramid level the pixels will be filtered out if they have gradient magnitude less than minGradientMagnitudes[level].

  • maxPointsPart: float.

    The method uses a random pixels subset of size frameWidth x frameHeight x pointsPart

  • transformType: integer().

    Class of transformation

Return
  • retval: RgbdOdometry

Constructor.

Python prototype (for reference only):

create([, cameraMatrix[, minDepth[, maxDepth[, maxDepthDiff[, iterCounts[, minGradientMagnitudes[, maxPointsPart[, transformType]]]]]]]]) -> retval
Link to this function

getCameraMatrix(named_args)

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

getCameraMatrix

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: Evision.Mat.t()

Python prototype (for reference only):

getCameraMatrix() -> retval
Link to this function

getIterationCounts(named_args)

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

getIterationCounts

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: Evision.Mat.t()

Python prototype (for reference only):

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

getMaxDepth

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxDepth() -> retval
Link to this function

getMaxDepthDiff(named_args)

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

getMaxDepthDiff

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxDepthDiff() -> retval
Link to this function

getMaxPointsPart(named_args)

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

getMaxPointsPart

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxPointsPart() -> retval
Link to this function

getMaxRotation(named_args)

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

getMaxRotation

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxRotation() -> retval
Link to this function

getMaxTranslation(named_args)

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

getMaxTranslation

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: double

Python prototype (for reference only):

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

getMinDepth

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: double

Python prototype (for reference only):

getMinDepth() -> retval
Link to this function

getMinGradientMagnitudes(named_args)

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

getMinGradientMagnitudes

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
Return
  • retval: Evision.Mat.t()

Python prototype (for reference only):

getMinGradientMagnitudes() -> retval
Link to this function

getTransformType(named_args)

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

getTransformType

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

Python prototype (for reference only):

getTransformType() -> retval
Link to this function

prepareFrameCache(named_args)

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

prepareFrameCache(self, frame, cacheType)

View Source
@spec prepareFrameCache(t(), Evision.RGBD.OdometryFrame.t(), integer()) ::
  {number(), number()} | {:error, String.t()}

prepareFrameCache

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • frame: OdometryFrame
  • cacheType: integer()
Return
  • retval: Size

Python prototype (for reference only):

prepareFrameCache(frame, cacheType) -> retval
Link to this function

setCameraMatrix(named_args)

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

setCameraMatrix(self, val)

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

setCameraMatrix

Positional Arguments

Python prototype (for reference only):

setCameraMatrix(val) -> None
Link to this function

setIterationCounts(named_args)

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

setIterationCounts(self, val)

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

setIterationCounts

Positional Arguments

Python prototype (for reference only):

setIterationCounts(val) -> None
@spec setMaxDepth(Keyword.t()) :: any() | {:error, String.t()}
@spec setMaxDepth(t(), number()) :: t() | {:error, String.t()}

setMaxDepth

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: double

Python prototype (for reference only):

setMaxDepth(val) -> None
Link to this function

setMaxDepthDiff(named_args)

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

setMaxDepthDiff(self, val)

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

setMaxDepthDiff

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: double

Python prototype (for reference only):

setMaxDepthDiff(val) -> None
Link to this function

setMaxPointsPart(named_args)

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

setMaxPointsPart(self, val)

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

setMaxPointsPart

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: double

Python prototype (for reference only):

setMaxPointsPart(val) -> None
Link to this function

setMaxRotation(named_args)

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

setMaxRotation(self, val)

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

setMaxRotation

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: double

Python prototype (for reference only):

setMaxRotation(val) -> None
Link to this function

setMaxTranslation(named_args)

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

setMaxTranslation(self, val)

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

setMaxTranslation

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: double

Python prototype (for reference only):

setMaxTranslation(val) -> None
@spec setMinDepth(Keyword.t()) :: any() | {:error, String.t()}
@spec setMinDepth(t(), number()) :: t() | {:error, String.t()}

setMinDepth

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: double

Python prototype (for reference only):

setMinDepth(val) -> None
Link to this function

setMinGradientMagnitudes(named_args)

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

setMinGradientMagnitudes(self, val)

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

setMinGradientMagnitudes

Positional Arguments

Python prototype (for reference only):

setMinGradientMagnitudes(val) -> None
Link to this function

setTransformType(named_args)

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

setTransformType(self, val)

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

setTransformType

Positional Arguments
  • self: Evision.RGBD.RgbdOdometry.t()
  • val: integer()

Python prototype (for reference only):

setTransformType(val) -> None