LineMaxOperatorBase ClassCognex VisionPro 9.22

This class provides functionality for finding lines in images. It will return candidate lines that meet the requirements specified by its properties.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.LineMax.Implementation LineMaxOperatorBase
        Cognex.Vision.LineMax LineMaxOperator

Namespace: Cognex.Vision.LineMax.Implementation
Assembly: Cognex.Vision.LineMax.Net (in Cognex.Vision.LineMax.Net.dll) Version: 9.22.2.0
Syntax

public abstract class LineMaxOperatorBase : ChangedEventShareableBase

The LineMaxOperatorBase type exposes the following members.

Constructors

  NameDescription
Protected methodLineMaxOperatorBase
Top
Methods

  NameDescription
Public methodEquals
Compares the equality of this object with another.
(Overrides ChangedEventShareableBase Equals(Object).)
Public methodExecute(IImage, IRegion)

Performs line finding on the supplied image. The inspection results are stored in a LineMaxResults object.

Public methodExecute(IImageCollection, IRegionCollection)

Performs line finding on the supplied image. The inspection results are stored in a LineMaxResults object.

Public methodExecute(IImage, IRegion, Image8Grey, Int32, Int32)

Performs line finding on the supplied image. The inspection results are stored in a LineMaxResults object.

Public methodExecute(IImageCollection, IRegionCollection, Image8GreyCollection, Int32Collection, Int32Collection)

Performs line finding on the supplied image. The inspection results are stored in a LineMaxResults object.

Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides ChangedEventShareableBase GetHashCode .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Inherited from ShareableBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodResumeAndRaiseChangedEvent

Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.

(Inherited from ChangedEventShareableBase.)
Public methodSuspendChangedEvent

Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.

(Inherited from ChangedEventShareableBase.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two LineMaxOperatorBase objects.
Public operatorStatic memberInequality
Compares the inequality of two LineMaxOperatorBase objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfAssurance
Public fieldStatic memberSfCoverageThreshold
Public fieldStatic memberSfDistanceTolerance
Public fieldStatic memberSfEdgeAngleTolerance
Public fieldStatic memberSfEdgeDetectionParams
Public fieldStatic memberSfExpectedLineNormal
Public fieldStatic memberSfFittingMode
Public fieldStatic memberSfLengthThreshold
Public fieldStatic memberSfLineAngleTolerance
Public fieldStatic memberSfMaxNumLines
Public fieldStatic memberSfPolarity
Public fieldStatic memberSfRegionMode
Public fieldStatic memberSfTimeout
Public fieldStatic memberSfTimeoutEnabled
Top
Properties

  NameDescription
Public propertyAssurance
Get

Gets the tradeoff between speed and reliability when FittingMode is set to RANSAC mode.

Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Inherited from ChangedEventShareableBase.)
Public propertyCoverageThreshold
Get

Gets the minimum acceptable proportion of inliers relative to the number of intersected projection regions. Line segments must meet this constraint to become results.

Public propertyDistanceTolerance
Get

Gets the maximum allowable distance between a line and an inlier of the line. Edge points must meet this constraint to become inliers of the line.

Public propertyEdgeAngleTolerance
Get

Gets the maximum allowable angle between a line and an inlier of the line. Edge points must meet this constraint to become inliers of the line.

Public propertyEdgeDetectionParams
Get

Gets the parameters for generating edge points from image data.

Public propertyExpectedLineNormal
Get

Gets the expected line orientation.

Public propertyFittingMode
Get

Gets the method to use when generating candidate lines. If you select Exhaustive mode, a candidate line will be generated for every possible pair of edge points. If you select RANSAC mode, a candidate line will be generated from a smaller number of randomly chosen point pairs.

Public propertyHandle (Overrides ChangedEventShareableBase Handle.)
Public propertyLengthThreshold
Get

Gets the minimum acceptable length of a line segment. Line segments must meet this constraint to become results.

Public propertyLineAngleTolerance
Get

Gets the maximum allowable angle between the normal of a line and the ExpectedLineNormal value. Lines must meet this constraint to become results.

Public propertyMaxNumLines
Get

Gets the maximum number of lines to be found. A LineMaxMulti license must be available to execute the tool with MaxNumLines set to greater than or equal to 0.

Public propertyPolarity
Get

Gets the polarity constraint. Edge points must meet this constraint to become inliers.

Public propertyRegionMode
Get

Gets the technique, PixelAlignedBoundingBoxAdjustMask or PixelAlignedBoundingBox, used to apply the region to the inspection image.

Public propertyTimeout
Get

Gets the maximum amount of time that the inspection is allowed to execute.

Public propertyTimeoutEnabled
Get

Gets the applicability of Timeout.

Top
Events

  NameDescription
Public eventChanged

The actual event.

(Inherited from ChangedEventShareableBase.)
Top
Remarks

Line finding is accomplished in two phases. The first phase, edge detection, finds edge points within the image(s). The second phase, line fitting, creates lines from roughly collinear subsets of the found edge points.

The first phase, edge detection, finds edge points within the image(s) using parameters defined in the LineMaxEdgeDetectionParams class. First, the input image is smoothed and decimated, using GradientKernelSizeInPixels. Gradient vectors are then computed for each pixel in the decimated image. Both the gradient vectors and the input image are projected over many caliper-like projection regions, using ProjectionLengthInPixels. A pixel is considered a candidate edge point if its projected gradient magnitude exceeds ContrastThreshold and if the ratio of its projected gradient magnitude and its intensity exceeds NormalizedContrastThreshold. Only edge points with gradient directions sufficiently consistent with ExpectedLineNormal can possibly constitute the expected lines at the angle ExpectedLineNormal (where the gradient direction consistency is determined by LineAngleTolerance and EdgeAngleTolerance). Therefore, only such edge points are included in the line fitting phase. Edge points with inconsistent gradient directions are excluded from the line fitting phase and placed into the UnconsideredOutliers collection.

The second phase, line fitting, creates lines from roughly collinear subsets of the found edge points, using parameters defined in the LineMaxOperatorBase class. Lines are evaluated using a RANSAC or an Exhaustive point selection methodology, depending on the FittingMode setting. Under RANSAC mode, the user may adjust Assurance to fit the desired result optimality and operation speed. Line fitting is performed by iteratively evaluating candidate lines created from the found edge points. During each iteration two points are randomly selected from the found edge points, a candidate line is modeled from the selected points, and the candidate line inliers are determined. An edge point is assigned to the inlier list of a candidate line only if it is in the proximity of the candidate line (determined by DistanceTolerance ) and if its gradient direction is consistent with the angle of the candidate line (determined by EdgeAngleTolerance ). Each edge point can only be assigned to the inlier list of a single line and each line is only allowed to contain at most one edge point from each projection region. When the RANSAC iterations reach the maximum, the inliers of the best found line candidate will be identified. Then the found line will be refined using a least squares regression fit to the inliers, and the set of inliers will be re-evaluated using the refined line. The refinement will be repeated a maximum of three times until the number of inliers ceases to further increase. Any edge points that are not inliers of the found line are placed into the ConsideredOutliers collection.

See Also