View Source Evision.LineDescriptor.LSDDetector (Evision v0.2.9)
Summary
Functions
Clears the algorithm state
Creates ad LSDDetector object, using smart pointers.
createLSDDetectorWithParams
Detect lines inside an image.
Variant 1:
detect
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
getDefaultName
LSDDetectorWithParams
Reads algorithm parameters from a file storage
save
Stores algorithm parameters in a file storage
write
Types
@type t() :: %Evision.LineDescriptor.LSDDetector{ref: reference()}
Type that represents an LineDescriptor.LSDDetector
struct.
ref.
reference()
The underlying erlang resource variable.
Functions
@spec clear(Keyword.t()) :: any() | {:error, String.t()}
@spec clear(t()) :: t() | {:error, String.t()}
Clears the algorithm state
Positional Arguments
- self:
Evision.LineDescriptor.LSDDetector.t()
Python prototype (for reference only):
clear() -> None
Creates ad LSDDetector object, using smart pointers.
Return
- retval:
Evision.LineDescriptor.LSDDetector.t()
Python prototype (for reference only):
createLSDDetector() -> retval
@spec createLSDDetectorWithParams(Keyword.t()) :: any() | {:error, String.t()}
@spec createLSDDetectorWithParams(Evision.LineDescriptor.LSDParam.t()) :: t() | {:error, String.t()}
createLSDDetectorWithParams
Positional Arguments
- params:
Evision.LineDescriptor.LSDParam
Return
- retval:
Evision.LineDescriptor.LSDDetector.t()
Python prototype (for reference only):
createLSDDetectorWithParams(params) -> retval
@spec detect(t(), Evision.Mat.maybe_mat_in(), integer(), integer()) :: [Evision.LineDescriptor.KeyLine.t()] | {:error, String.t()}
Detect lines inside an image.
Positional Arguments
self:
Evision.LineDescriptor.LSDDetector.t()
image:
Evision.Mat
.input image
scale:
integer()
.scale factor used in pyramids generation
numOctaves:
integer()
.number of octaves inside pyramid
Keyword Arguments
mask:
Evision.Mat
.mask matrix to detect only KeyLines of interest
Return
keypoints:
[Evision.LineDescriptor.KeyLine]
.vector that will store extracted lines for one or more images
Python prototype (for reference only):
detect(image, scale, numOctaves[, mask]) -> keypoints
@spec detect( t(), Evision.Mat.maybe_mat_in(), integer(), integer(), [{:mask, term()}] | nil ) :: [Evision.LineDescriptor.KeyLine.t()] | {:error, String.t()}
@spec detect( t(), [Evision.Mat.maybe_mat_in()], [[Evision.LineDescriptor.KeyLine.t()]], integer(), integer() ) :: t() | {:error, String.t()}
Variant 1:
detect
Positional Arguments
self:
Evision.LineDescriptor.LSDDetector.t()
images:
[Evision.Mat]
.input images
keylines:
[[Evision.LineDescriptor.KeyLine]]
.set of vectors that will store extracted lines for one or more images
scale:
integer()
.scale factor used in pyramids generation
numOctaves:
integer()
.number of octaves inside pyramid
Keyword Arguments
masks:
[Evision.Mat]
.vector of mask matrices to detect only KeyLines of interest from each input image
Has overloading in C++
Python prototype (for reference only):
detect(images, keylines, scale, numOctaves[, masks]) -> None
Variant 2:
Detect lines inside an image.
Positional Arguments
self:
Evision.LineDescriptor.LSDDetector.t()
image:
Evision.Mat
.input image
scale:
integer()
.scale factor used in pyramids generation
numOctaves:
integer()
.number of octaves inside pyramid
Keyword Arguments
mask:
Evision.Mat
.mask matrix to detect only KeyLines of interest
Return
keypoints:
[Evision.LineDescriptor.KeyLine]
.vector that will store extracted lines for one or more images
Python prototype (for reference only):
detect(image, scale, numOctaves[, mask]) -> keypoints
@spec detect( t(), [Evision.Mat.maybe_mat_in()], [[Evision.LineDescriptor.KeyLine.t()]], integer(), integer(), [{:masks, term()}] | nil ) :: t() | {:error, String.t()}
detect
Positional Arguments
self:
Evision.LineDescriptor.LSDDetector.t()
images:
[Evision.Mat]
.input images
keylines:
[[Evision.LineDescriptor.KeyLine]]
.set of vectors that will store extracted lines for one or more images
scale:
integer()
.scale factor used in pyramids generation
numOctaves:
integer()
.number of octaves inside pyramid
Keyword Arguments
masks:
[Evision.Mat]
.vector of mask matrices to detect only KeyLines of interest from each input image
Has overloading in C++
Python prototype (for reference only):
detect(images, keylines, scale, numOctaves[, masks]) -> None
@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.LineDescriptor.LSDDetector.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.LineDescriptor.LSDDetector.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 lSDDetector(Keyword.t()) :: any() | {:error, String.t()}
@spec lSDDetector(Evision.LineDescriptor.LSDParam.t()) :: t() | {:error, String.t()}
LSDDetectorWithParams
Positional Arguments
- params:
Evision.LineDescriptor.LSDParam
Return
- self:
Evision.LineDescriptor.LSDDetector.t()
Python prototype (for reference only):
LSDDetectorWithParams(_params) -> <line_descriptor_LSDDetector object>
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}
Reads algorithm parameters from a file storage
Positional Arguments
- self:
Evision.LineDescriptor.LSDDetector.t()
- func:
Evision.FileNode
Python prototype (for reference only):
read(fn) -> None
save
Positional Arguments
- self:
Evision.LineDescriptor.LSDDetector.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 write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}
Stores algorithm parameters in a file storage
Positional Arguments
- self:
Evision.LineDescriptor.LSDDetector.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.LineDescriptor.LSDDetector.t()
- fs:
Evision.FileStorage
- name:
String
Has overloading in C++
Python prototype (for reference only):
write(fs, name) -> None