Evision v0.1.28

View Source Evision.PhaseUnwrapping.HistogramPhaseUnwrapping (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an PhaseUnwrapping.HistogramPhaseUnwrapping struct.

Functions

create()

Constructor

create(opts)

Constructor

getInverseReliabilityMap(self)

Get the reliability map computed from the wrapped phase map.

getInverseReliabilityMap(self, opts)

Get the reliability map computed from the wrapped phase map.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Evision.PhaseUnwrapping.HistogramPhaseUnwrapping{ref: reference()}

Type that represents an PhaseUnwrapping.HistogramPhaseUnwrapping struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

Link to this function

create()

View Source 
@spec create() :: Evision.HistogramPhaseUnwrapping.t() | {:error, String.t()}

Constructor

Keyword Arguments

  • parameters: Evision.HistogramPhaseUnwrapping.Params.t().

    HistogramPhaseUnwrapping parameters HistogramPhaseUnwrapping::Params: width,height of the phase map and histogram characteristics.

Return
  • retval: Evision.HistogramPhaseUnwrapping.t()

Python prototype (for reference only):

create([, parameters]) -> retval
Link to this function

create(opts)

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

Constructor

Keyword Arguments

  • parameters: Evision.HistogramPhaseUnwrapping.Params.t().

    HistogramPhaseUnwrapping parameters HistogramPhaseUnwrapping::Params: width,height of the phase map and histogram characteristics.

Return
  • retval: Evision.HistogramPhaseUnwrapping.t()

Python prototype (for reference only):

create([, parameters]) -> retval
Link to this function

getInverseReliabilityMap(self)

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

Get the reliability map computed from the wrapped phase map.

Positional Arguments
  • self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()
Return

  • reliabilityMap: Evision.Mat.t().

    Image where the reliability map is stored.

Python prototype (for reference only):

getInverseReliabilityMap([, reliabilityMap]) -> reliabilityMap
Link to this function

getInverseReliabilityMap(self, opts)

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

Get the reliability map computed from the wrapped phase map.

Positional Arguments
  • self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()
Return

  • reliabilityMap: Evision.Mat.t().

    Image where the reliability map is stored.

Python prototype (for reference only):

getInverseReliabilityMap([, reliabilityMap]) -> reliabilityMap