FoundLine Class

This class holds the data of a line segment found by image processing. The line segment is defined by two points P1 and P2. All other data is derived from them. Geometry and names:

Copy

 y ^
   |
  \|
a -\
   |\
   | \
   |  \
   |   \ P1    dx
   |    *-------------+ 
   |     \            |
   |      \           |
   |       \          | 
   |  Phi  /\         |
   |______/  \        |
   |          \  _____| dy
   |           \/     |
   |            \ Phi |
   |             \    |
   |              \   |
   |               \  |
   |                \ |
   |                 \|
   |                  * P2
   |                   \
   |                    \
   |                     \     
   |                      \      
   |                    ---\   
   |                  / 90° * PlumbPoint   
   |                  \.     \
   |           R  .           \
   |         .     \           \______
   |    .     Phi   |           \Alpha\
---+-----------------------------\------------------->
   |                             |\                  x
   |                             b \
   |                                \
   |

The Hessian normal form defines a line by the perpendicular distance R from the origin to the line (the point that we call PlumbPoint here) and the angle Phi between the x axis and the line from the origin to the PlumbPoint.

Inheritance Hierarchy

System.Object
  RAYLASE.Marker.JobElement.ImageProcessing.BaseFoundImageProcessingObject
    RAYLASE.Marker.JobElement.ImageProcessing.FoundLine
      RAYLASE.Marker.JobElement.ImageProcessing.FoundTransition

Namespace: RAYLASE.Marker.JobElement.ImageProcessing
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.20.0

Syntax

Copy

public class FoundLine : BaseFoundImageProcessingObject, IFoundObject

The FoundLine type exposes the following members.

Constructors

	Name	Description
	FoundLine(FoundLine)	Copy constructor.
	FoundLine(dvec2, dvec2, dvec3)	Constructs a line using two dvec2 points.
	FoundLine(dvec3, dvec3, dvec3)	Constructs a line using two dvec3 points.
	FoundLine(dvec3, Double, dvec3)	Constructs a line using a dvec3 point and an angle.
	FoundLine(Point, Double, dvec3)	Constructs a line using a System.Drawing.Point and an angle.
	FoundLine(Point, Point, dvec3)	Constructs a line using two points of type System.Drawing.Point.
	FoundLine(PointF, PointF, dvec3)	Constructs a line using two points of type System.Drawing.PointF.

Top

Properties

	Name	Description
	Angle	The angle between the x axis and the line in rad, measured counter clockwise, in the range [-pi,+pi]. (Same as "Alpha" in the sketch above.) (Overrides BaseFoundImageProcessingObject.Angle)
	Area	The area enclosed of the object's contour. (Inherited from BaseFoundImageProcessingObject)
	Center	The center (midpoint) of the line. (Overrides BaseFoundImageProcessingObject.Center)
	DistanceToOrigin	(Overrides BaseFoundImageProcessingObject.DistanceToOrigin)
	DistanceToRoiCenter	The distance between the found object's center and the center of the region of interest in which the object has been found. (Inherited from BaseFoundImageProcessingObject)
	FilterFields	Only for the GUI: This array controls which properties in the result output will have a funnel for transferring a value range around the current value into the filter/selection group. If empty, all relevant properties will have a funnel.
	ImageIndex	The image processing plug-in has a ring buffer array of images where the result of an object finding process is stored. This index is stored here. (Inherited from BaseFoundImageProcessingObject)
	Length	The length of the line. (Overrides BaseFoundImageProcessingObject.Length)
	ObjectColor	The color a found object will have when drawn in a result image. (Inherited from BaseFoundImageProcessingObject)
	ObjectFields	The list of the relevant parameters and their values in the result output.
	ObjectText	The list of parameters and their values as string for showing in the GUI.
	ObjectTypeTitle	The title of an object entry in the list of results.
	ObjectUnit	The unit the found object's coordinate are in. Pixel or millimeter. (Inherited from BaseFoundImageProcessingObject)
	P1	The first point of the line.
	P2	The second point of the line.
	Phi	The angle between the normal of the line and the x axis as used in the Hessian normal form.
	PlumbPoint	This is the point with the shortest distance between the line and the origin.
	Point1	The first point of the line as type System.Drawing.Point.
	Point2	The second point of the line as type System.Drawing.Point.
	R	The distance R between the origin and the line as used in the Hessian normal form.
	RoiCenter	The center of the region of interest in which the object has been found in micrometers in world coordinates in the workspace's coordinate system. (Inherited from BaseFoundImageProcessingObject)
	SearchNo	The sequential number of the search which is done during the image processing job. I. e. an identifier for the 1st, 2nd or 3rd search an object has been found in; the value is 1, 2 or 3. (Inherited from BaseFoundImageProcessingObject)
	Size	The size of the (possibly rotated) bounding box around the object. (Inherited from BaseFoundImageProcessingObject)
	UnitFactor	Unit factor to convert micrometers into millimeters in case the unit is not pixel. (Inherited from BaseFoundImageProcessingObject)

Top

Methods

	Name	Description
	AngleBetween	Retrieves the angle, expressed in degrees, between the two specified lines.
	CalcDistance(dvec3)	Calculates the distance between this line and the given point p.
	CalcDistance(PointF)	Calculates the distance between this line and the given point p.
	CalcDistance(FoundLine, Boolean, dvec3)	Distance between two lines: The distance between two parallel lines 1 and 2 is just the difference R2-R1. This calculation turned out to be instable in case the angles of the lines differ too much. Too much can mean rather small angles if R is big. Therefore another distance definition is used if the flag isMidpointBased is true: This line is the base line which defines the Angle. The given "other" line in the argument is the line we want the distance to know with its start and end points P1 and P2. For the "other line" the mid point M is calculated, and its distance D to the plumb point will be returned as the distance between the lines.
	CalcIntersectionPoint(FoundLine, PointF)	Calculates the intersection point of this line with the given line.
	CalcIntersectionPoint(FoundLine, Nullable<dvec3>, Double)	Calculates the intersection point of this line with the given line.
	CloneDeep	Creates a deep clone of this object. (Overrides BaseFoundImageProcessingObject.CloneDeep())
	GetBorderPoints	Calculates to this line the intersection points P1 and P2 with the given quadrangle. Copy / Line / P1 / +-----------+---------+ \ / \| \ / \| \ / Quad- \| \ / + \ / rangle / P2 + / / \ / / \ / / \ / / \ / \ / \ / +
	IsCenterEqual	Checks if this object has the same center as the other object. (Inherited from BaseFoundImageProcessingObject)
	LinearFunction	Calculates the gradient and y-intercept of the straight line.
	SetFilter	Only for the GUI: Sets a funnel button in front of the displayed property in the result list when the property name is contained in the given string array. The button transfers a value range around the property value into the according value range fields in the dialog. (Inherited from BaseFoundImageProcessingObject)
	ToString	Returns the list of all relevant properties as combined string. (Inherited from BaseFoundImageProcessingObject)
	Vector	Returns from the two points P1 and P2 of the line the vector P1-P2.

Top

Fields

	Name	Description
	_angle	The angle, measured counter clockwise, between the object (in case of a line) or its bounding box and the x axis. (Inherited from BaseFoundImageProcessingObject)
	_area	The area enclosed by the object's contour. (Inherited from BaseFoundImageProcessingObject)
	_center	The center point of the object. (Inherited from BaseFoundImageProcessingObject)
	_length	The length or circumference of the object's contour. (Inherited from BaseFoundImageProcessingObject)

Top

Reference

RAYLASE.Marker.JobElement.ImageProcessing Namespace