Operator Reference

lines_gausslines_gaussLinesGaussLinesGausslines_gauss (Operator)

lines_gausslines_gaussLinesGaussLinesGausslines_gauss — Detect lines and their width.

Signature

Herror lines_gauss(const Hobject Image, Hobject* Lines, double Sigma, double Low, double High, const char* LightDark, const char* ExtractWidth, const char* LineModel, const char* CompleteJunctions)

Herror T_lines_gauss(const Hobject Image, Hobject* Lines, const Htuple Sigma, const Htuple Low, const Htuple High, const Htuple LightDark, const Htuple ExtractWidth, const Htuple LineModel, const Htuple CompleteJunctions)

void LinesGauss(const HObject& Image, HObject* Lines, const HTuple& Sigma, const HTuple& Low, const HTuple& High, const HTuple& LightDark, const HTuple& ExtractWidth, const HTuple& LineModel, const HTuple& CompleteJunctions)

HXLDCont HImage::LinesGauss(const HTuple& Sigma, const HTuple& Low, const HTuple& High, const HString& LightDark, const HString& ExtractWidth, const HString& LineModel, const HString& CompleteJunctions) const

HXLDCont HImage::LinesGauss(double Sigma, double Low, double High, const HString& LightDark, const HString& ExtractWidth, const HString& LineModel, const HString& CompleteJunctions) const

HXLDCont HImage::LinesGauss(double Sigma, double Low, double High, const char* LightDark, const char* ExtractWidth, const char* LineModel, const char* CompleteJunctions) const

HXLDCont HImage::LinesGauss(double Sigma, double Low, double High, const wchar_t* LightDark, const wchar_t* ExtractWidth, const wchar_t* LineModel, const wchar_t* CompleteJunctions) const   ( Windows only)

static void HOperatorSet.LinesGauss(HObject image, out HObject lines, HTuple sigma, HTuple low, HTuple high, HTuple lightDark, HTuple extractWidth, HTuple lineModel, HTuple completeJunctions)

HXLDCont HImage.LinesGauss(HTuple sigma, HTuple low, HTuple high, string lightDark, string extractWidth, string lineModel, string completeJunctions)

HXLDCont HImage.LinesGauss(double sigma, double low, double high, string lightDark, string extractWidth, string lineModel, string completeJunctions)

def lines_gauss(image: HObject, sigma: Union[float, int], low: Union[float, int], high: Union[float, int], light_dark: str, extract_width: str, line_model: str, complete_junctions: str) -> HObject

Description

The operator lines_gausslines_gaussLinesGaussLinesGausslines_gauss can be used to extract lines (curvilinear structures) from the image ImageImageImageimageimage. The extracted lines are returned in LinesLinesLineslineslines as subpixel precise XLD-contours.

The parameter LightDarkLightDarkLightDarklightDarklight_dark determines, whether bright ('light'"light""light""light""light") or dark ('dark'"dark""dark""dark""dark") lines are extracted.

If ExtractWidthExtractWidthExtractWidthextractWidthextract_width is set to 'true'"true""true""true""true" the line width is extracted for each line point.

LineModelLineModelLineModellineModelline_model determines if and how the position and width of asymmetric lines (lines having different contrast on each side of the line) should be compensated. The following values can be set for LineModelLineModelLineModellineModelline_model:

'bar-shaped'"bar-shaped""bar-shaped""bar-shaped""bar-shaped":

Bar-shaped line model. Covers most use cases.

'parabolic'"parabolic""parabolic""parabolic""parabolic":

Parabolic line model. Can be used for the extraction of backlit tubular objects (e.g., blood vessels in X-ray images) where the lines appear very sharp.

'gaussian'"gaussian""gaussian""gaussian""gaussian":

Gaussian line model. Can be used for the extraction of backlit tubular objects (e.g., blood vessels in X-ray images) where the lines appear less sharp.

'none'"none""none""none""none":

The effects of asymmetric lines are not compensated.

The parameter LineModelLineModelLineModellineModelline_model is only effective if ExtractWidthExtractWidthExtractWidthextractWidthextract_width='true'"true""true""true""true".

Because the line extractor is unable to extract certain junctions because of differential geometric reasons, it tries to extract these by different means if CompleteJunctionsCompleteJunctionsCompleteJunctionscompleteJunctionscomplete_junctions is set to 'true'"true""true""true""true".

The extraction is done by using partial derivatives of a Gaussian smoothing kernel to determine the parameters of a quadratic polynomial in x and y for each point of the image. The parameter SigmaSigmaSigmasigmasigma determines the amount of smoothing to be performed. Larger values of SigmaSigmaSigmasigmasigma lead to a larger smoothing of the image, but can lead to worse localization of the line. Generally, the localization will be much better than that of lines returned by lines_facetlines_facetLinesFacetLinesFacetlines_facet with comparable parameters. The parameters of the polynomial are used to calculate the line direction for each pixel. Pixels which exhibit a local maximum in the second directional derivative perpendicular to the line direction are marked as line points. The line points found in this manner are then linked to contours. This is done by immediately accepting line points that have a second derivative larger than HighHighHighhighhigh. Points that have a second derivative smaller than LowLowLowlowlow are rejected. All other line points are accepted if they are connected to accepted points by a connected path. This is similar to a hysteresis threshold operation with infinite path length (see hysteresis_thresholdhysteresis_thresholdHysteresisThresholdHysteresisThresholdhysteresis_threshold), here, however contours are extracted with subpixel precision.

For the choice of the thresholds HighHighHighhighhigh and LowLowLowlowlow one has to keep in mind that the second directional derivative depends on the amplitude and width of the line as well as the choice of SigmaSigmaSigmasigmasigma. The value of the second derivative depends linearly on the amplitude, i.e., the larger the amplitude, the larger the response. For the width of the line there is an approximately inverse exponential dependence: The wider the line is, the smaller the response gets. This holds analogously for the dependence on SigmaSigmaSigmasigmasigma: The larger SigmaSigmaSigmasigmasigma is chosen, the smaller the second derivative will be. This means that for larger smoothing correspondingly smaller values for HighHighHighhighhigh and LowLowLowlowlow have to be chosen. Two examples help to illustrate this: If 5 pixel wide lines with an amplitude larger than 100 are to be extracted from an image with a smoothing of SigmaSigmaSigmasigmasigma = 1.5, HighHighHighhighhigh should be chosen larger than 14. If, on the other hand, 10 pixel wide lines with an amplitude larger than 100 and a SigmaSigmaSigmasigmasigma = 3 are to be detected, HighHighHighhighhigh should be chosen larger than 3.5. For the choice of LowLowLowlowlow values between 0.25 HighHighHighhighhigh and 0.5 HighHighHighhighhigh are appropriate.

The parameters LowLowLowlowlow and HighHighHighhighhigh can be calculated from the respective gray value contrast of the lines to be extracted ( and ) and from the chosen value for SigmaSigmaSigmasigmasigma with the following formula:

where is the width (half the diameter) of the lines in the image. and determine the gray value range the lines are expected to differ from the background. Suitable values for LowLowLowlowlow and HighHighHighhighhigh can be calculated using the procedure calculate_lines_gauss_parameters.

The extracted lines are returned in a topologically sound data structure in LinesLinesLineslineslines. This means that lines are correctly split at junction points.

lines_gausslines_gaussLinesGaussLinesGausslines_gauss defines the following attributes for each line point if ExtractWidthExtractWidthExtractWidthextractWidthextract_width was set to 'false'"false""false""false""false":

'angle'"angle""angle""angle""angle":

The angle of the direction perpendicular to the line

'response'"response""response""response""response":

The magnitude of the second derivative

If ExtractWidthExtractWidthExtractWidthextractWidthextract_width was set to 'true'"true""true""true""true", the following attributes are defined in addition to 'angle'"angle""angle""angle""angle" and 'response'"response""response""response""response":

'width_left'"width_left""width_left""width_left""width_left":

The line width to the left of the line

'width_right'"width_right""width_right""width_right""width_right":

The line width to the right of the line

If ExtractWidthExtractWidthExtractWidthextractWidthextract_width was set to 'true'"true""true""true""true" and LineModelLineModelLineModellineModelline_model to a value different from 'none'"none""none""none""none", the following attributes are defined in addition to 'angle'"angle""angle""angle""angle", 'response'"response""response""response""response", 'width_left'"width_left""width_left""width_left""width_left", and 'width_right'"width_right""width_right""width_right""width_right":

'asymmetry'"asymmetry""asymmetry""asymmetry""asymmetry":

The asymmetry of the line point

'contrast'"contrast""contrast""contrast""contrast":

The contrast of the line point

Here, the asymmetry is positive if the asymmetric part, i.e., the part with the weaker gradient, is on the right side of the line, while it is negative if the asymmetric part is on the left side of the line.

The contrast results from the difference between the gray value of the line and the gray value of the background. The contrast is positive if bright lines are extracted, while it is negative if dark lines are extracted. The returned contrast may be larger than the maximum gray value the input image type is able to represent, especially if the line model specified by LineModelLineModelLineModellineModelline_model is not present in the image. For example, for byte images, the contrast may be greater than 255.

Use get_contour_attrib_xldget_contour_attrib_xldGetContourAttribXldGetContourAttribXldget_contour_attrib_xld to obtain attribute values. See the operator reference of get_contour_attrib_xldget_contour_attrib_xldGetContourAttribXldGetContourAttribXldget_contour_attrib_xld for further information about contour attributes.

lines_gausslines_gaussLinesGaussLinesGausslines_gauss can be executed on OpenCL devices.

Attention

In general, but in particular if the line width is to be extracted, should be selected, where is the width (half the diameter) of the lines in the image. As the lowest allowable value must be selected. If, for example, lines with a width of 4 pixels (diameter 8 pixels) are to be extracted, should be selected. Note that the attributes 'width_left'"width_left""width_left""width_left""width_left", 'width_right'"width_right""width_right""width_right""width_right", 'asymmetry'"asymmetry""asymmetry""asymmetry""asymmetry", and 'contrast'"contrast""contrast""contrast""contrast" are set to zero if SigmaSigmaSigmasigmasigma is set too low.

lines_gausslines_gaussLinesGaussLinesGausslines_gauss uses a special implementation that is optimized using SSE2 or AVX2 instructions, if the system parameters 'sse2_enable'"sse2_enable""sse2_enable""sse2_enable""sse2_enable" or 'avx2_enable'"avx2_enable""avx2_enable""avx2_enable""avx2_enable" are set to 'true'"true""true""true""true" (see set_systemset_systemSetSystemSetSystemset_system). These implementations are slightly inaccurate compared to the pure C version due to numerical issues. If you prefer accuracy over performance you can set the respective system parameter to 'false'"false""false""false""false" (using set_systemset_systemSetSystemSetSystemset_system) before you call lines_gausslines_gaussLinesGaussLinesGausslines_gauss. This way lines_gausslines_gaussLinesGaussLinesGausslines_gauss does not use SSE2 or AVX2 accelerations. Don't forget to set 'sse2_enable'"sse2_enable""sse2_enable""sse2_enable""sse2_enable" or 'avx2_enable'"avx2_enable""avx2_enable""avx2_enable""avx2_enable" back to 'true'"true""true""true""true" afterwards.

When lines_gausslines_gaussLinesGaussLinesGausslines_gauss is run on OpenCL devices, the same limitations apply as for derivate_gaussderivate_gaussDerivateGaussDerivateGaussderivate_gauss: SigmaSigmaSigmasigmasigma must be chosen so that the required filter mask is smaller than 129 pixels. Also note that the results can vary compared to the CPU implementation.

Note that filter operators may return unexpected results if an image with a reduced domain is used as input. Please refer to the chapter Filters.

Execution Information

  • Supports OpenCL compute devices.
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on internal data level.

This operator supports canceling timeouts and interrupts.

Parameters

ImageImageImageimageimage (input_object)  singlechannelimage objectHImageHObjectHObjectHobject (byte / int1 / int2 / uint2 / int4 / real)

Input image.

LinesLinesLineslineslines (output_object)  xld_cont-array objectHXLDContHObjectHObjectHobject *

Extracted lines.

SigmaSigmaSigmasigmasigma (input_control)  number HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Amount of Gaussian smoothing to be applied.

Default: 1.5

Suggested values: 1, 1.2, 1.5, 1.8, 2, 2.5, 3, 4, 5

Value range: 0 ≤ Sigma Sigma Sigma sigma sigma

Recommended increment: 0.1

LowLowLowlowlow (input_control)  number HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Lower threshold for the hysteresis threshold operation.

Default: 3

Suggested values: 0, 0.5, 1, 2, 3, 4, 5, 8, 10

Value range: 0 ≤ Low Low Low low low

Recommended increment: 0.5

HighHighHighhighhigh (input_control)  number HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Upper threshold for the hysteresis threshold operation.

Default: 8

Suggested values: 0, 0.5, 1, 2, 3, 4, 5, 8, 10, 12, 15, 18, 20, 25

Value range: 0 ≤ High High High high high

Recommended increment: 0.5

Restriction: High >= Low

LightDarkLightDarkLightDarklightDarklight_dark (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Extract bright or dark lines.

Default: 'light' "light" "light" "light" "light"

List of values: 'dark'"dark""dark""dark""dark", 'light'"light""light""light""light"

ExtractWidthExtractWidthExtractWidthextractWidthextract_width (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Should the line width be extracted?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

LineModelLineModelLineModellineModelline_model (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Line model used to correct the line position and width.

Default: 'bar-shaped' "bar-shaped" "bar-shaped" "bar-shaped" "bar-shaped"

List of values: 'bar-shaped'"bar-shaped""bar-shaped""bar-shaped""bar-shaped", 'gaussian'"gaussian""gaussian""gaussian""gaussian", 'none'"none""none""none""none", 'parabolic'"parabolic""parabolic""parabolic""parabolic"

CompleteJunctionsCompleteJunctionsCompleteJunctionscompleteJunctionscomplete_junctions (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Should junctions be added where they cannot be extracted?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

Example (HDevelop)

* Detection of lines in an aerial image
read_image(Image,'mreut4_3')
lines_gauss(Image,Lines,1.5,3,8,'light','true','bar-shaped','true')
dev_display(Lines)

Example (C)

/* Detection of lines in an aerial image */
read_image(&Image,"mreut4_3");
lines_gauss(Image:&Lines:1.5,3,8,"light","true","bar-shaped","true");
disp_xld(Lines,WindowHandle);

Example (C++)

/* Detection of lines in an aerial image */
HWindow w(0,0,520,560);
HImage Image("mreut4_3");
HXLDContArray Lines = Image.LinesGauss(1.5,3,8,"light","true",
                                       "bar-shaped","true");
Lines.Display(w);

Example (HDevelop)

* Detection of lines in an aerial image
read_image(Image,'mreut4_3')
lines_gauss(Image,Lines,1.5,3,8,'light','true','bar-shaped','true')
dev_display(Lines)

Complexity

Let A be the number of pixels in the domain of ImageImageImageimageimage. Then the runtime complexity is O(A*SigmaSigmaSigmasigmasigma).

The amount of temporary memory required is dependent on the height H of the domain of ImageImageImageimageimage and the width W of ImageImageImageimageimage. Let S = W*H, then lines_gausslines_gaussLinesGaussLinesGausslines_gauss requires at least 55*S bytes of temporary memory during execution.

Result

lines_gausslines_gaussLinesGaussLinesGausslines_gauss returns 2 ( H_MSG_TRUE) if all parameters are correct and no error occurs during execution. If the input is empty the behavior can be set via set_system(::'no_object_result',<Result>:)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If necessary, an exception is raised.

Possible Successors

gen_polygons_xldgen_polygons_xldGenPolygonsXldGenPolygonsXldgen_polygons_xld

Alternatives

lines_facetlines_facetLinesFacetLinesFacetlines_facet

See also

bandpass_imagebandpass_imageBandpassImageBandpassImagebandpass_image, dyn_thresholddyn_thresholdDynThresholdDynThresholddyn_threshold, topographic_sketchtopographic_sketchTopographicSketchTopographicSketchtopographic_sketch

References

C. Steger: “Extracting Curvilinear Structures: A Differential Geometric Approach”. In B. Buxton, R. Cipolla, eds., “Fourth European Conference on Computer Vision”, Lecture Notes in Computer Science, Volume 1064, Springer Verlag, pp. 630-641, 1996.
C. Steger: “Extraction of Curved Lines from Images”. In “13th International Conference on Pattern Recognition”, Volume II, pp. 251-255, 1996.
C. Steger: “An Unbiased Detector of Curvilinear Structures”. IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 20, no. 2, pp. 113-125, 1998.
C. Steger: “Unbiased extraction of lines with parabolic and Gaussian profiles”. Computer Vision and Image Understanding, vol. 117, no. 2, pp. 97-112, 2013.

Module

2D Metrology