The plane estimator operator.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DRangeImagePlaneEstimator
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0
Syntax
The Cog3DRangeImagePlaneEstimator type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DRangeImagePlaneEstimator |
Construct a default Cog3DRangeImagePlaneEstimator object.
|
| Cog3DRangeImagePlaneEstimator(Cog3DRangeImagePlaneEstimator) |
Construct a deep copy of the supplied Cog3DRangeImagePlaneEstimator object.
|
 | Cog3DRangeImagePlaneEstimator(SerializationInfo, StreamingContext) |
Serialization constructor for Cog3DRangeImagePlaneEstimator object.
|
Methods
| Name | Description | |
|---|---|---|
| AddPoint |
Add a point to the locations. The values are in selected space.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| DeletePoint |
Delete a point from the input point list using the index specified
|
| Dispose |
Destruct this Cog3DRangeImagePlaneEstimator.
|
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Execute |
Perform plane fitting on the supplied range image.
|
| Finalize |
Finalize this Cog3DRangeImagePlaneEstimator.
(Overrides Object Finalize .) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData |
Serializer for the Cog3DRangeImagePlaneEstimator.
(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) |
| GetPoint |
Gets the (x,y) coordinates defined in selected space for a single point using the index.
The points are used only when FitMethod is set to Points.
|
| GetPointX |
Gets the X (defined in selected space) for a single point using the index.
The points are used only when FitMethod is set to Points.
|
| GetPointY |
Gets the Y (defined in selected space) for a single point using the index.
The points are used only when FitMethod is set to Points.
|
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) | (Overrides CogObjectBase GetProperties( Attribute ).) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event 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 CogSerializableChangedEventBase.) |
| SetPoint |
Sets the (x,y) coordinates defined in selected space for a single point using the index.
The points are used only when FitMethod is set to Points.
|
| SetPointX |
Sets the X (defined in selected space) for a single point using the index.
The points are used only when FitMethod is set to Points.
|
| SetPointY |
Sets the Y (defined in selected space) for a single point using the index.
The points are used only when FitMethod is set to Points.
|
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfFitMethod |
This bit will be set in the EventArgs of a Changed event every time
the value returned by FitMethod may have cahnged.
|
| SfGetPointX |
This bit will be set in the EventArgs of a Changed event every time
the value returned by GetPointX may have cahnged.
|
| SfGetPointY |
This bit will be set in the EventArgs of a Changed event every time
the value returned by GetPointY may have cahnged.
|
| SfInputImageMask |
This bit will be set in the EventArgs of a Changed event every time
the value returned by InputImageMask may have cahnged.
|
| SfInputImageMaskOffsetX |
This bit will be set in the EventArgs of a Changed event every time
the value returned by InputImageMaskOffsetX may have cahnged.
|
| SfInputImageMaskOffsetY |
This bit will be set in the EventArgs of a Changed event every time
the value returned by InputImageMaskOffsetY may have cahnged.
|
| SfNeighborhoodSizeXInPixels |
This bit will be set in the EventArgs of a Changed event every time
the value returned by NeighborhoodSizeXInPixels may have cahnged.
|
| SfNeighborhoodSizeYInPixels |
This bit will be set in the EventArgs of a Changed event every time
the value returned by NeighborhoodSizeYInPixels may have cahnged.
|
 | SfNextSf | |
| SfNumPoints |
This bit will be set in the EventArgs of a Changed event every time
the value returned by NumPoints may have cahnged.
|
| SfPlaneDirection |
This bit will be set in the EventArgs of a changed event every time
the value returned by PlaneDirection may have cahnged.
|
| SfRegionMode |
This bit will be set in the EventArgs of a Changed event every time
the value returned by RegionMode may have cahnged.
|
| SfResidualsRMSThreshold |
This bit will be set in the EventArgs of a Changed event every time
the value returned by ResidualsRMSThreshold may have cahnged.
|
| SfRobustFitParameters |
This bit will be set in the EventArgs of a changed event every time
the value returned by RobustFitParameters may have cahnged.
|
| SfTimeout |
This bit will be set in the EventArgs of a changed event every time
the value returned by Timeout may have cahnged.
|
| SfTimeoutEnabled |
This bit will be set in the EventArgs of a changed event every time
the value returned by TimeoutEnabled may have cahnged.
|
| SfZLookupMethod |
This bit will be set in the EventArgs of a Changed event every time
the value returned by ZLookupMethod may have cahnged.
|
Properties
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.) |
| FitMethod |
Gets or sets the FitMethod.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| InputImageMask |
Gets or sets the input image mask.
The input image mask allows you to ignore regions
of the range image by masking them out.
|
| InputImageMaskOffsetX |
Gets or sets the InputImageMask X offset value in pixels.
|
| InputImageMaskOffsetY |
Gets or sets the InputImageMask Y offset value in pixels.
|
| NeighborhoodSizeXInPixels |
Gets or sets the NeighborhoodSizeXInPixels.
Only used when
FitMethodZLookupMethod
is set to NeighborhoodMedian or Neighborhood.
|
| NeighborhoodSizeYInPixels |
Gets or sets the NeighborhoodSizeYInPixels.
Only used when
FitMethodZLookupMethod |
| NumPoints |
Gets or sets the number of 2D locations specified in selected space.
The points are used only when FitMethod is set to Points.
|
| PlaneDirection |
Gets or sets the plane direction.
|
| RegionMode |
Gets or sets the region mode. This controls how the optional run time
region is applied to the input image.
|
| ResidualsRMSThreshold |
Gets or sets the Residuals RMS Threshold.
|
| RobustFitParameters |
These parameters control the plane fitting, as opposed to the
sampling, of points from the supplied range image.
|
| SelectedIndex |
For Cognex internal use only
|
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.) |
| Timeout |
Gets or sets the maximum allowable execution time in milliseconds.
This value only applies if
TimeoutEnabled
is true.
|
| TimeoutEnabled |
Gets or sets whether to enable the timeout.
|
| ZLookupMethod |
Gets or sets the ZLookupMethod.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also