Class ScanWindow

A scan window within which valid IProfile Point2Ds are to be measured.

Inheritance

object

ScanWindow

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public sealed class ScanWindow : ICloneable

Remarks

This class provides methods for creating scan window objects. Scan windows are used to define the area, in mill coordinates, within which valid IProfile Point2Ds are to be measured. Scan windows can be used to restrict the scan area only to the region of interest, eliminate interference from ambient or stray light, and eliminate erroneous or unnecessary data from machinery. Decreasing the scan window in the scan head's y axis (depth) will allow for faster scanning. Use GetMinScanPeriod() to retrieve the minimum scan period of the entire scan system based on the currently applied scan windows of all scan heads.

Methods

Clone()

Used to make sure that once a scan window is set on a ScanHead via SetWindow(ScanWindow), it will not change if the original is changed.

Declaration

public object Clone()

Returns

Type	Description
object	A shallow copy of this ScanWindow object.

Remarks

This class provides methods for creating scan window objects. Scan windows are used to define the area, in mill coordinates, within which valid IProfile Point2Ds are to be measured. Scan windows can be used to restrict the scan area only to the region of interest, eliminate interference from ambient or stray light, and eliminate erroneous or unnecessary data from machinery. Decreasing the scan window in the scan head's y axis (depth) will allow for faster scanning. Use GetMinScanPeriod() to retrieve the minimum scan period of the entire scan system based on the currently applied scan windows of all scan heads.

CreateScanWindowPolygonal(ICollection<Point2D>)

Creates a polygonal scan window using the points passed in. The points must be ordered in a clockwise fashion and the resulting shape must be convex. The first and last points will be automatically connected so there is no need to duplicate the first point at the end of points.

Declaration

public static ScanWindow CreateScanWindowPolygonal(ICollection<Point2D> points)

Parameters

Type	Name	Description
ICollection<Point2D>	points	The points that make up the polgonal window.

Returns

Type	Description
ScanWindow	The scan window.

Remarks

This class provides methods for creating scan window objects. Scan windows are used to define the area, in mill coordinates, within which valid IProfile Point2Ds are to be measured. Scan windows can be used to restrict the scan area only to the region of interest, eliminate interference from ambient or stray light, and eliminate erroneous or unnecessary data from machinery. Decreasing the scan window in the scan head's y axis (depth) will allow for faster scanning. Use GetMinScanPeriod() to retrieve the minimum scan period of the entire scan system based on the currently applied scan windows of all scan heads.

Exceptions

Type	Condition
ArgumentException	One or more arguments are NaN -or- One or more arguments are NegativeInfinity or PositiveInfinity -or- There are fewer than 3 points in points -or- The polygon is not convex. -or- The points were not supplied in clockwise order.

CreateScanWindowRectangular(double, double, double, double)

Creates a rectangular scan window, in mill coordinates, within which a camera will look for the laser.

Declaration

public static ScanWindow CreateScanWindowRectangular(double windowTop, double windowBottom, double windowLeft, double windowRight)

Parameters

Type	Name	Description
double	windowTop	The top boundary of the ScanWindow in ScanSystemUnits. Must be greater than windowBottom.
double	windowBottom	The bottom boundary of the ScanWindow in ScanSystemUnits. Must be less than windowTop.
double	windowLeft	The left boundary of the ScanWindow in ScanSystemUnits. Must be less than windowRight.
double	windowRight	The right boundary of the ScanWindow in ScanSystemUnits. Must be greater than windowLeft.

Returns

Type	Description
ScanWindow	The created ScanWindow.

Remarks

This class provides methods for creating scan window objects. Scan windows are used to define the area, in mill coordinates, within which valid IProfile Point2Ds are to be measured. Scan windows can be used to restrict the scan area only to the region of interest, eliminate interference from ambient or stray light, and eliminate erroneous or unnecessary data from machinery. Decreasing the scan window in the scan head's y axis (depth) will allow for faster scanning. Use GetMinScanPeriod() to retrieve the minimum scan period of the entire scan system based on the currently applied scan windows of all scan heads.

Exceptions

Type	Condition
ArgumentException	One or more arguments are NaN -or- One or more arguments are NegativeInfinity or PositiveInfinity -or- windowTop is less than or equal to windowBottom -or- windowRight is less than or equal to windowLeft

See Also

SetWindow(ScanWindow)

CreateScanWindowUnconstrained()

Creates an unconstrained scan window within which a camera will look for the laser.

Declaration

public static ScanWindow CreateScanWindowUnconstrained()

Returns

Type	Description
ScanWindow	The created ScanWindow.

Remarks

This class provides methods for creating scan window objects. Scan windows are used to define the area, in mill coordinates, within which valid IProfile Point2Ds are to be measured. Scan windows can be used to restrict the scan area only to the region of interest, eliminate interference from ambient or stray light, and eliminate erroneous or unnecessary data from machinery. Decreasing the scan window in the scan head's y axis (depth) will allow for faster scanning. Use GetMinScanPeriod() to retrieve the minimum scan period of the entire scan system based on the currently applied scan windows of all scan heads.

See Also

SetWindow(ScanWindow)

Implements

ICloneable