The shape polarization operator is used to determine polarity information along a shape based on image data. Polarity information indicates which side of the shape boundary is dark and which side is light.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro CogShapePolarize
Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0
Syntax
The CogShapePolarize type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogShapePolarize | Constructs a new instance of this class. |
| CogShapePolarize(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogShapePolarize(CogShapePolarize) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | Clone | Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject |
| 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.) |
| Dispose | |
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Execute | Execute will determine the polarity information along the provided shape based on data extracted from the input image. Polarity information indicates which side of the shape boundary is dark and which side is light. |
| Finalize | (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 | |
| 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 ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| 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.) |
| ResumeAndRaiseChangedEvent | Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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. |
| 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. |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfCombineMode | This bit will be set in the EventArgs of a Changed event every time the value returned by CombineMode may have changed. |
| SfContrastThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by ContrastThreshold may have changed. |
| SfMaintainShapeIntegrity | This bit will be set in the EventArgs of a Changed event every time the value returned by MaintainShapeIntegrity may have changed. |
| SfMinPolarityPerimeter | This bit will be set in the EventArgs of a Changed event every time the value returned by MinPolarityPerimeter may have changed. |
| SfProbeOffsetInPixels | This bit will be set in the EventArgs of a Changed event every time the value returned by ProbeOffsetInPixels may have changed. |
| SfProbeResolution | This bit will be set in the EventArgs of a Changed event every time the value returned by ProbeResolution may have changed. |
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. |
| CombineMode | Indicates the mode that the shape polarization operator will use for combining the original shape polarities with the polarities derived from the image. |
| ContrastThreshold | The minimum absolute contrast difference between a polarity sample point's probes that is required to make a polarity determination. If the difference is less than the threshold then the polarity sample point is assigned an undefined polarity. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| MaintainShapeIntegrity | If true then the shape will not be broken up into sections due to differing polarities along the shape's boundary. In this case, the MinPolarityPerimeter property is ignored. A primitive shape that is broken up into sections will become a contour. |
| MinPolarityPerimeter | The minimum length a constant-polarity section of the shape must have in order to be preserved. Sections that are shorter than this length will be combined with neighboring sections and the polarity will be set based on polarity of its neighbors. |
| ProbeOffsetInPixels | The probe offset specifies the distance from the shape to each of the two points where the image intensity is sampled. This parameter is specified in image pixel units. |
| ProbeResolution | The probe resolution specifies the maximum arc length, in shape selected space units, between adjacent polarity sample points along the original shape. Some portions of the shape may be sampled more densely than the specified probe resolution. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
The shape polarization operator is used to determine polarity information along a shape based on image data. Polarity information indicates which side of the shape boundary is dark and which side is light.
See Also