Class that holds the SurfaceFX run parameters. These parameters
are used by the Execute() method and control how SurfaceFX
algorithm will generate the output image
that shows the surface curvature.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.SurfaceFX CogSurfaceFX
Namespace: Cognex.VisionPro.SurfaceFX
Assembly: Cognex.VisionPro.SurfaceFX (in Cognex.VisionPro.SurfaceFX.dll) Version: 69.0.0.0
Syntax
The CogSurfaceFX type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogSurfaceFX |
Constructs a default CogSurfaceFX object.
|
| CogSurfaceFX(CogSurfaceFX) |
Constructs a deep copy of the supplied CogSurfaceFX object.
|
 | CogSurfaceFX(SerializationInfo, StreamingContext) |
Serialization constructor for CogSurfaceFX object.
|
Methods
| Name | Description | |
|---|---|---|
| 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 |
Releases all resources used by this CogSurfaceFX object.
|
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Execute |
Generate the output image using the input images held by the
InputVisionData,
the properties of this class
and the given region.
|
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| 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 |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| 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.) |
| 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.) |
| 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 | |
|---|---|---|
  | SfBrightness |
This bit will be set in the EventArgs of a Changed event every time the
value returned by Brightness may have changed.
|
| SfContrast |
This bit will be set in the EventArgs of a Changed event every time the
value returned by Contrast may have changed.
|
| SfMergeAllSelectedSpaceName |
This bit will be set in the EventArgs of a Changed event every time the
value returned by MergeAllSelectedSpaceName may have changed.
|
 | SfNextSf | |
| SfSmoothness |
This bit will be set in the EventArgs of a Changed event every time the
value returned by Smoothness may have changed.
|
| SfSpaceTreeMode |
This bit will be set in the EventArgs of a Changed event every time the
value returned by SpaceTreeMode may have changed.
|
Properties
| Name | Description | |
|---|---|---|
 | Brightness |
Gets or sets the brightness percentage. The brightness percentage for flat areas of the output image.
For CogImag8Grey
100% is equal to 255.
|
| 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.) |
| Contrast |
Gets or sets the contrast. The contrast factor for the output image.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| MergeAllSelectedSpaceName |
Gets or sets the SelectedSpaceName of the outputImage, when SpaceTreeMode is MergeAll.
|
| Smoothness |
Gets or sets the smoothness.
|
| SpaceTreeMode |
Gets or sets the SpaceTreeMode. Allows the user
to choose which coordinate space tree to copy to
the output image, or choose to merge the coordinate spaces from the all of the input images.
|
| 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.) |
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