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

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

Clears the algorithm state

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

Python prototype (for reference only):

clear() -> None

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

Constructor

Keyword Arguments

• parameters: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.Params.

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

Return

• retval: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

Python prototype (for reference only):

create([, parameters]) -> retval

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

@spec create([{:parameters, term()}] | nil) :: t() | {:error, String.t()}

Constructor

Keyword Arguments

• parameters: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.Params.

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

Return

• retval: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

Python prototype (for reference only):

create([, parameters]) -> retval

@spec empty(Keyword.t()) :: any() | {:error, String.t()}

@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.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

Return

• retval: bool

Python prototype (for reference only):

empty() -> retval

@spec getDefaultName(Keyword.t()) :: any() | {:error, String.t()}

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

getDefaultName

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

Return

• retval: String

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 getInverseReliabilityMap(Keyword.t()) :: any() | {:error, String.t()}

@spec getInverseReliabilityMap(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

@spec getInverseReliabilityMap(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

@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()
• func: Evision.FileNode

Python prototype (for reference only):

read(fn) -> None

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

save

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.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 unwrapPhaseMap(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

Unwraps a 2D phase map.

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

• wrappedPhaseMap: Evision.Mat.

  The wrapped phase map of type CV_32FC1 that needs to be unwrapped.

Keyword Arguments

• shadowMask: Evision.Mat.

  Optional CV_8UC1 mask image used when some pixels do not hold any phase information in the wrapped phase map.

Return

• unwrappedPhaseMap: Evision.Mat.t().

  The unwrapped phase map.

Python prototype (for reference only):

unwrapPhaseMap(wrappedPhaseMap[, unwrappedPhaseMap[, shadowMask]]) -> unwrappedPhaseMap

@spec unwrapPhaseMap(t(), Evision.Mat.maybe_mat_in(), [{:shadowMask, term()}] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Unwraps a 2D phase map.

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()

• wrappedPhaseMap: Evision.Mat.

  The wrapped phase map of type CV_32FC1 that needs to be unwrapped.

Keyword Arguments

• shadowMask: Evision.Mat.

  Optional CV_8UC1 mask image used when some pixels do not hold any phase information in the wrapped phase map.

Return

• unwrappedPhaseMap: Evision.Mat.t().

  The unwrapped phase map.

Python prototype (for reference only):

unwrapPhaseMap(wrappedPhaseMap[, unwrappedPhaseMap[, shadowMask]]) -> unwrappedPhaseMap

@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()
• fs: Evision.FileStorage

Python prototype (for reference only):

write(fs) -> None

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

write

Positional Arguments

• self: Evision.PhaseUnwrapping.HistogramPhaseUnwrapping.t()
• fs: Evision.FileStorage
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None