Transform2DLinear ClassCognex VisionPro 9.20

Linear 2D coordinate transform.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision Transform2DLinear

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.10.0.0
Syntax

public sealed class Transform2DLinear : ChangedEventShareableBase, 
	ITransform2D, IChangedEvent, IObject

The Transform2DLinear type exposes the following members.

Constructors

  NameDescription
Public methodTransform2DLinear

Constructs a new instance of this class.

Top
Methods

  NameDescription
Public methodBestFitLinearTransform

Returns a new linear transform which best describes this transform over the given set of points. The points must be expressed in 'from' coordinates.

Public methodCompose

Returns a new linear transform which is the composition of the given transform (on the right side) and this one (on the left side).

Public methodComposeBase

Returns a new transform which is the composition of the given transform (on the right side) and this one (on the left side).

Public methodCopy

Returns a new copy of this transform.

Public methodCopyBase

Returns a new copy of this transform.

Public methodEquals
Compares the equality of this object with another.
(Overrides ChangedEventShareableBase Equals(Object).)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides ChangedEventShareableBase GetHashCode .)
Public methodGetMatrixElement

Access the selected element of the 2-by-2 matrix in this transform.

Public methodGetMatrixElementsTranslation

Extract the named parameters from this transform.

Public methodGetScalingAspectRotationSkewTranslation

Extract the named parameters from this transform. Rotation and Skew are in radians.

Public methodGetScalingsRotationsTranslation

Extract the named parameters from this transform. RotationX and RotationY are in radians.

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides ShareableBase GetTypeMeta .)
Public methodIdentity
Public methodInvert

Returns a new linear transform which is the inverse of this one.

Public methodInvertBase

Returns a new transform which is the inverse of this one.

Public methodLinearTransform

Returns a new linear transform which best describes this transform at the given point. The point must be expressed in 'from' coordinates.

Public methodMapAngle

Maps the given angle (in radians) through this transform and returns the result (in radians).

Public methodMapArea

Maps the given area through this transform and returns the result.

Public methodMapPoint

Maps the given x,y point through this transform, filling in the mapped x,y coordinates.

Public methodMapPoints

Map the supplied points through this transform.

Public methodMapVector

Maps the given x,y vector through this transform, filling in the mapped x,y vector components.

Public methodMatrixIdentity

Returns true if the 2-by-2 matrix in this transform is an identity mapping within the given tolerance. The tolerance is applied to each matrix element.

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.

(Overrides ChangedEventShareableBase ResumeAndRaiseChangedEvent .)
Public methodSetMatrixElement

Access the selected element of the 2-by-2 matrix in this transform.

Public methodSetMatrixElementsTranslation

Set this transform from the given parameters.

Public methodSetScalingAspectRotationSkewTranslation

Set this transform from the given parameters. Rotation and Skew are in radians.

Public methodSetScalingsRotationsTranslation

Set this transform from the given parameters. RotationX and RotationY are in radians.

Public methodSingular

Returns true if this transform is singular. A transform is singular if the matrix determinant equals zero within the given tolerance.

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.

(Overrides ChangedEventShareableBase SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides Object ToString .)
Top
Operators

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

  NameDescription
Public fieldStatic memberSfAspect
Public fieldStatic memberSfGetMatrixElement
Public fieldStatic memberSfLinear
Public fieldStatic memberSfMatrixDeterminant
Public fieldStatic memberSfRotation
Public fieldStatic memberSfRotationX
Public fieldStatic memberSfRotationY
Public fieldStatic memberSfScaling
Public fieldStatic memberSfScalingX
Public fieldStatic memberSfScalingY
Public fieldStatic memberSfSkew
Public fieldStatic memberSfTranslationX
Public fieldStatic memberSfTranslationY
Top
Properties

  NameDescription
Public propertyAspect
Get

Returns the aspect of this transform. Aspect is the ratio of scaling along the y axis over scaling along the x axis. When aspect is set the rotation, skew, and scaling remain unchanged.

Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides ChangedEventShareableBase ChangedEventSuspended.)
Public propertyHandle (Overrides ChangedEventShareableBase Handle.)
Public propertyLinear

Returns true if this is a linear transform.

Public propertyMatrixDeterminant

Returns the determinant of the 2-by-2 matrix in this transformation.

Public propertyRotation
Get

Gets the rotation of this transform (in radians). When rotation is set the skew, scaling, and aspect remain unchanged.

Public propertyRotationX

Returns the x-axis rotation of this transform (in radians). When set, RotationY, ScalingX, and ScalingY remain unchanged.

Public propertyRotationY

Returns the y-axis rotation of this transform (in radians). When set, RotationX, ScalingX, and ScalingY remain unchanged.

Public propertyScaling
Get

Returns/sets the scaling of this transform. When scaling is set the rotation, skew, and aspect remain unchanged.

Public propertyScalingX

Returns the x-axis scaling of this transform. When set, RotationX, RotationY, and ScalingY remain unchanged.

Public propertyScalingY

Returns the y-axis scaling of this transform. When set, RotationX, RotationY, and ScalingX remain unchanged.

Public propertySkew
Get

Gets the skew of this transform (in radians). When skew is set the rotation, scaling, and aspect remain unchanged.

Public propertyTranslationX
Get

Gets the x component of the translation vector.

Public propertyTranslationY
Get

Gets the y component of the translation vector.

Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides ChangedEventShareableBase Changed.)
Top
Remarks

Transform2DLinear represents a two-dimensional linear transformation between two coordinate spaces. It enables you to map points from the from coordinate space to the to coordinate space. It defaults to the identity transform. Transform2DLinear represents a linear transformation as a (2x2) matrix and a translation vector. There are three different parameterization methodsfor the matrix, each based on the following general 2-d linear transformation: Where (xA, yA) is the input point, (Tx, Ty) is the translation vector, and the rest is the (2x2) matrix that represents the scaling and rotation.

See Also