View Source Evision.PhaseUnwrapping.PhaseUnwrapping (Evision v0.2.2-rc2)
Summary
Functions
Clears the algorithm state
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
getDefaultName
Reads algorithm parameters from a file storage
save
Unwraps a 2D phase map.
Unwraps a 2D phase map.
Stores algorithm parameters in a file storage
write
Types
@type t() :: %Evision.PhaseUnwrapping.PhaseUnwrapping{ref: reference()}
Type that represents an PhaseUnwrapping.PhaseUnwrapping
struct.
ref.
reference()
The underlying erlang resource variable.
Functions
Clears the algorithm state
Positional Arguments
- self:
Evision.PhaseUnwrapping.PhaseUnwrapping.t()
Python prototype (for reference only):
clear() -> None
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
Positional Arguments
- self:
Evision.PhaseUnwrapping.PhaseUnwrapping.t()
Return
- retval:
bool
Python prototype (for reference only):
empty() -> retval
getDefaultName
Positional Arguments
- self:
Evision.PhaseUnwrapping.PhaseUnwrapping.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 read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}
Reads algorithm parameters from a file storage
Positional Arguments
- self:
Evision.PhaseUnwrapping.PhaseUnwrapping.t()
- fn_:
Evision.FileNode.t()
Python prototype (for reference only):
read(fn_) -> None
save
Positional Arguments
- self:
Evision.PhaseUnwrapping.PhaseUnwrapping.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.PhaseUnwrapping.t()
wrappedPhaseMap:
Evision.Mat.t()
.The wrapped phase map of type CV_32FC1 that needs to be unwrapped.
Keyword Arguments
shadowMask:
Evision.Mat.t()
.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.PhaseUnwrapping.t()
wrappedPhaseMap:
Evision.Mat.t()
.The wrapped phase map of type CV_32FC1 that needs to be unwrapped.
Keyword Arguments
shadowMask:
Evision.Mat.t()
.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.PhaseUnwrapping.t()
- fs:
Evision.FileStorage.t()
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.PhaseUnwrapping.t()
- fs:
Evision.FileStorage.t()
- name:
String
Has overloading in C++
Python prototype (for reference only):
write(fs, name) -> None