Found |
[Missing <summary> documentation for "T:RAYLASE.Marker.JobElement.ImageProcessing.FoundTemplate"]
Inheritance HierarchySystemObject
RAYLASE.Marker.JobElement.ImageProcessingBaseFoundImageProcessingObject
RAYLASE.Marker.JobElement.ImageProcessingFoundTemplate
RAYLASE.Marker.JobElement.ImageProcessingBaseFoundImageProcessingObject
RAYLASE.Marker.JobElement.ImageProcessingFoundTemplate
Namespace: RAYLASE.Marker.JobElement.ImageProcessing
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0
SyntaxC#
public class FoundTemplate : BaseFoundImageProcessingObject, IFoundObject
The FoundTemplate type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FoundTemplate(FoundTemplate) | Copy constructor. |
| FoundTemplate(dvec3, dvec2, Double, dvec3) | Constructs a template from its center, size and angle. |
Properties| Name | Description | |
|---|---|---|
 | Angle |
The angle of the first side (i. e. the width of the smallest
bounding box) relative to the x axis in rad, measured
counterclockwise.
(Inherited from BaseFoundImageProcessingObject) |
| Area |
The area enclosed of the object's contour.
(Inherited from BaseFoundImageProcessingObject) |
| BoundingBox | The corner points of the template's (possibly rotated) bounding box as Point[]. |
| BoundingBoxD | The corner points of the template's (possibly rotated) bounding box as dvec3[]. |
| Center |
The center of the object in micrometers in world coordinates in
the workspace's coordinate system.
(Inherited from BaseFoundImageProcessingObject) |
| DistanceToOrigin |
Distance of the object's center to the workspace's center in
world coordinates in the workspace's coordinate system.
(Inherited from BaseFoundImageProcessingObject) |
| 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 or circumference of the object's contour.
(Inherited from BaseFoundImageProcessingObject) |
| 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) |
| Quality | A quality value for found templates between 0 and 1; 1 is the highest quality. |
| 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) |
Methods| Name | Description | |
|---|---|---|
| CloneDeep |
Creates a deep clone of this template.
(Overrides BaseFoundImageProcessingObjectCloneDeep) |
| ConvertDvec3ArrayToPointArray | Converts dvec3[] into Point[]. |
| CreateBoundingBoxD | Creates the (possibly rotated) bounding box of the template. |
| IsCenterEqual |
Checks if this object has the same center as the other object.
(Inherited from BaseFoundImageProcessingObject) |
 | 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) |
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) |
See Also