View Source Evision.XImgProc.RICInterpolator (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an XImgProc.RICInterpolator struct.

Functions

getAlpha

getFGSLambda

getFGSSigma

getK

getMaxFlow

getModelIter

getRefineModels

getSuperpixelMode

getSuperpixelNNCnt

getSuperpixelRuler

getSuperpixelSize

getUseGlobalSmootherFilter

getUseVariationalRefinement

Alpha is a parameter defining a global weight for transforming geodesic distance into weight.

Alpha is a parameter defining a global weight for transforming geodesic distance into weight.

Interface to provide a more elaborated cost map, i.e. edge map, for the edge-aware term. This implementation is based on a rather simple gradient-based edge map estimation. To used more complex edge map estimator (e.g. StructuredEdgeDetection that has been used in the original publication) that may lead to improved accuracies, the internal edge map estimation can be bypassed here.

Sets the respective fastGlobalSmootherFilter() parameter.

Sets the respective fastGlobalSmootherFilter() parameter.

Sets the respective fastGlobalSmootherFilter() parameter.

Sets the respective fastGlobalSmootherFilter() parameter.

K is a number of nearest-neighbor matches considered, when fitting a locally affine model for a superpixel segment. However, lower values would make the interpolation noticeably faster. The original implementation of @cite Hu2017 uses 32.

K is a number of nearest-neighbor matches considered, when fitting a locally affine model for a superpixel segment. However, lower values would make the interpolation noticeably faster. The original implementation of @cite Hu2017 uses 32.

MaxFlow is a threshold to validate the predictions using a certain piece-wise affine model. If the prediction exceeds the treshold the translational model will be applied instead.

MaxFlow is a threshold to validate the predictions using a certain piece-wise affine model. If the prediction exceeds the treshold the translational model will be applied instead.

Parameter defining the number of iterations for piece-wise affine model estimation.

Parameter defining the number of iterations for piece-wise affine model estimation.

Parameter to choose wether additional refinement of the piece-wise affine models is employed.

Parameter to choose wether additional refinement of the piece-wise affine models is employed.

Parameter to choose superpixel algorithm variant to use

Parameter to choose superpixel algorithm variant to use

Parameter defines the number of nearest-neighbor matches for each superpixel considered, when fitting a locally affine model.

Parameter defines the number of nearest-neighbor matches for each superpixel considered, when fitting a locally affine model.

Parameter to tune enforcement of superpixel smoothness factor used for oversegmentation.

Parameter to tune enforcement of superpixel smoothness factor used for oversegmentation.

Get the internal cost, i.e. edge map, used for estimating the edge-aware term.

Get the internal cost, i.e. edge map, used for estimating the edge-aware term.

Sets whether the fastGlobalSmootherFilter() post-processing is employed.

Sets whether the fastGlobalSmootherFilter() post-processing is employed.

Parameter to choose wether the VariationalRefinement post-processing is employed.

Parameter to choose wether the VariationalRefinement post-processing is employed.

Link to this section Types

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

Type that represents an XImgProc.RICInterpolator struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

getAlpha

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: float

@copybrief setAlpha @see setAlpha/2

Python prototype (for reference only):

getAlpha() -> retval
@spec getFGSLambda(t()) :: number() | {:error, String.t()}

getFGSLambda

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: float

@copybrief setFGSLambda @see setFGSLambda/2

Python prototype (for reference only):

getFGSLambda() -> retval
@spec getFGSSigma(t()) :: number() | {:error, String.t()}

getFGSSigma

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: float

@copybrief setFGSSigma @see setFGSSigma/2

Python prototype (for reference only):

getFGSSigma() -> retval
@spec getK(t()) :: integer() | {:error, String.t()}

getK

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: int

@copybrief setK @see setK/2

Python prototype (for reference only):

getK() -> retval
@spec getMaxFlow(t()) :: number() | {:error, String.t()}

getMaxFlow

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: float

@copybrief setMaxFlow @see setMaxFlow/2

Python prototype (for reference only):

getMaxFlow() -> retval
@spec getModelIter(t()) :: integer() | {:error, String.t()}

getModelIter

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: int

@copybrief setModelIter @see setModelIter/2

Python prototype (for reference only):

getModelIter() -> retval
@spec getRefineModels(t()) :: boolean() | {:error, String.t()}

getRefineModels

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: bool

@copybrief setRefineModels @see setRefineModels/2

Python prototype (for reference only):

getRefineModels() -> retval
@spec getSuperpixelMode(t()) :: integer() | {:error, String.t()}

getSuperpixelMode

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: int

@copybrief setSuperpixelMode @see setSuperpixelMode/2

Python prototype (for reference only):

getSuperpixelMode() -> retval
Link to this function

getSuperpixelNNCnt(self)

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

getSuperpixelNNCnt

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: int

@copybrief setSuperpixelNNCnt @see setSuperpixelNNCnt/2

Python prototype (for reference only):

getSuperpixelNNCnt() -> retval
Link to this function

getSuperpixelRuler(self)

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

getSuperpixelRuler

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: float

@copybrief setSuperpixelRuler @see setSuperpixelRuler/2

Python prototype (for reference only):

getSuperpixelRuler() -> retval
@spec getSuperpixelSize(t()) :: integer() | {:error, String.t()}

getSuperpixelSize

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: int

@copybrief setSuperpixelSize @see setSuperpixelSize/2

Python prototype (for reference only):

getSuperpixelSize() -> retval
Link to this function

getUseGlobalSmootherFilter(self)

View Source
@spec getUseGlobalSmootherFilter(t()) :: boolean() | {:error, String.t()}

getUseGlobalSmootherFilter

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: bool

@copybrief setUseGlobalSmootherFilter @see setUseGlobalSmootherFilter/2

Python prototype (for reference only):

getUseGlobalSmootherFilter() -> retval
Link to this function

getUseVariationalRefinement(self)

View Source
@spec getUseVariationalRefinement(t()) :: boolean() | {:error, String.t()}

getUseVariationalRefinement

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Return
  • retval: bool

@copybrief setUseVariationalRefinement @see setUseVariationalRefinement/2

Python prototype (for reference only):

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

Alpha is a parameter defining a global weight for transforming geodesic distance into weight.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • alpha: float.

Python prototype (for reference only):

setAlpha([, alpha]) -> None
@spec setAlpha(t(), [{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

Alpha is a parameter defining a global weight for transforming geodesic distance into weight.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • alpha: float.

Python prototype (for reference only):

setAlpha([, alpha]) -> None
Link to this function

setCostMap(self, costMap)

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

Interface to provide a more elaborated cost map, i.e. edge map, for the edge-aware term. This implementation is based on a rather simple gradient-based edge map estimation. To used more complex edge map estimator (e.g. StructuredEdgeDetection that has been used in the original publication) that may lead to improved accuracies, the internal edge map estimation can be bypassed here.

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

  • costMap: Evision.Mat.t().

    a type CV_32FC1 Mat is required.

@see cv::ximgproc::createSuperpixelSLIC

Python prototype (for reference only):

setCostMap(costMap) -> None
@spec setFGSLambda(t()) :: t() | {:error, String.t()}

Sets the respective fastGlobalSmootherFilter() parameter.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • lambda: float.

Python prototype (for reference only):

setFGSLambda([, lambda]) -> None
Link to this function

setFGSLambda(self, opts)

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

Sets the respective fastGlobalSmootherFilter() parameter.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • lambda: float.

Python prototype (for reference only):

setFGSLambda([, lambda]) -> None
@spec setFGSSigma(t()) :: t() | {:error, String.t()}

Sets the respective fastGlobalSmootherFilter() parameter.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • sigma: float.

Python prototype (for reference only):

setFGSSigma([, sigma]) -> None
@spec setFGSSigma(t(), [{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

Sets the respective fastGlobalSmootherFilter() parameter.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • sigma: float.

Python prototype (for reference only):

setFGSSigma([, sigma]) -> None
@spec setK(t()) :: t() | {:error, String.t()}

K is a number of nearest-neighbor matches considered, when fitting a locally affine model for a superpixel segment. However, lower values would make the interpolation noticeably faster. The original implementation of @cite Hu2017 uses 32.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • k: int.

Python prototype (for reference only):

setK([, k]) -> None
@spec setK(t(), [{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

K is a number of nearest-neighbor matches considered, when fitting a locally affine model for a superpixel segment. However, lower values would make the interpolation noticeably faster. The original implementation of @cite Hu2017 uses 32.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • k: int.

Python prototype (for reference only):

setK([, k]) -> None
@spec setMaxFlow(t()) :: t() | {:error, String.t()}

MaxFlow is a threshold to validate the predictions using a certain piece-wise affine model. If the prediction exceeds the treshold the translational model will be applied instead.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • maxFlow: float.

Python prototype (for reference only):

setMaxFlow([, maxFlow]) -> None
@spec setMaxFlow(t(), [{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}

MaxFlow is a threshold to validate the predictions using a certain piece-wise affine model. If the prediction exceeds the treshold the translational model will be applied instead.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • maxFlow: float.

Python prototype (for reference only):

setMaxFlow([, maxFlow]) -> None
@spec setModelIter(t()) :: t() | {:error, String.t()}

Parameter defining the number of iterations for piece-wise affine model estimation.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • modelIter: int.

Python prototype (for reference only):

setModelIter([, modelIter]) -> None
Link to this function

setModelIter(self, opts)

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

Parameter defining the number of iterations for piece-wise affine model estimation.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • modelIter: int.

Python prototype (for reference only):

setModelIter([, modelIter]) -> None
@spec setRefineModels(t()) :: t() | {:error, String.t()}

Parameter to choose wether additional refinement of the piece-wise affine models is employed.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • refineModles: bool.

Python prototype (for reference only):

setRefineModels([, refineModles]) -> None
Link to this function

setRefineModels(self, opts)

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

Parameter to choose wether additional refinement of the piece-wise affine models is employed.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • refineModles: bool.

Python prototype (for reference only):

setRefineModels([, refineModles]) -> None
@spec setSuperpixelMode(t()) :: t() | {:error, String.t()}

Parameter to choose superpixel algorithm variant to use:

  • cv::ximgproc::SLICType SLIC segments image using a desired region_size (value: 100)
  • cv::ximgproc::SLICType SLICO will optimize using adaptive compactness factor (value: 101)
  • cv::ximgproc::SLICType MSLIC will optimize using manifold methods resulting in more content-sensitive superpixels (value: 102).
Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • mode: int.

@see cv::ximgproc::createSuperpixelSLIC

Python prototype (for reference only):

setSuperpixelMode([, mode]) -> None
Link to this function

setSuperpixelMode(self, opts)

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

Parameter to choose superpixel algorithm variant to use:

  • cv::ximgproc::SLICType SLIC segments image using a desired region_size (value: 100)
  • cv::ximgproc::SLICType SLICO will optimize using adaptive compactness factor (value: 101)
  • cv::ximgproc::SLICType MSLIC will optimize using manifold methods resulting in more content-sensitive superpixels (value: 102).
Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • mode: int.

@see cv::ximgproc::createSuperpixelSLIC

Python prototype (for reference only):

setSuperpixelMode([, mode]) -> None
Link to this function

setSuperpixelNNCnt(self)

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

Parameter defines the number of nearest-neighbor matches for each superpixel considered, when fitting a locally affine model.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • spNN: int.

Python prototype (for reference only):

setSuperpixelNNCnt([, spNN]) -> None
Link to this function

setSuperpixelNNCnt(self, opts)

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

Parameter defines the number of nearest-neighbor matches for each superpixel considered, when fitting a locally affine model.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • spNN: int.

Python prototype (for reference only):

setSuperpixelNNCnt([, spNN]) -> None
Link to this function

setSuperpixelRuler(self)

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

Parameter to tune enforcement of superpixel smoothness factor used for oversegmentation.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • ruler: float.

@see cv::ximgproc::createSuperpixelSLIC

Python prototype (for reference only):

setSuperpixelRuler([, ruler]) -> None
Link to this function

setSuperpixelRuler(self, opts)

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

Parameter to tune enforcement of superpixel smoothness factor used for oversegmentation.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • ruler: float.

@see cv::ximgproc::createSuperpixelSLIC

Python prototype (for reference only):

setSuperpixelRuler([, ruler]) -> None
@spec setSuperpixelSize(t()) :: t() | {:error, String.t()}

Get the internal cost, i.e. edge map, used for estimating the edge-aware term.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • spSize: int.

@see setCostMap/2

Python prototype (for reference only):

setSuperpixelSize([, spSize]) -> None
Link to this function

setSuperpixelSize(self, opts)

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

Get the internal cost, i.e. edge map, used for estimating the edge-aware term.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • spSize: int.

@see setCostMap/2

Python prototype (for reference only):

setSuperpixelSize([, spSize]) -> None
Link to this function

setUseGlobalSmootherFilter(self)

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

Sets whether the fastGlobalSmootherFilter() post-processing is employed.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • use_FGS: bool.

Python prototype (for reference only):

setUseGlobalSmootherFilter([, use_FGS]) -> None
Link to this function

setUseGlobalSmootherFilter(self, opts)

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

Sets whether the fastGlobalSmootherFilter() post-processing is employed.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • use_FGS: bool.

Python prototype (for reference only):

setUseGlobalSmootherFilter([, use_FGS]) -> None
Link to this function

setUseVariationalRefinement(self)

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

Parameter to choose wether the VariationalRefinement post-processing is employed.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • use_variational_refinement: bool.

Python prototype (for reference only):

setUseVariationalRefinement([, use_variational_refinement]) -> None
Link to this function

setUseVariationalRefinement(self, opts)

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

Parameter to choose wether the VariationalRefinement post-processing is employed.

Positional Arguments
  • self: Evision.XImgProc.RICInterpolator.t()
Keyword Arguments
  • use_variational_refinement: bool.

Python prototype (for reference only):

setUseVariationalRefinement([, use_variational_refinement]) -> None