Class that performs a simultaneous separable convlution and sampling. A common use of this is downsampling with Gaussian smoothing.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.ImageProcessing CogIPOneImageSampleConvolve
Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 91.0.0.0
Syntax
The CogIPOneImageSampleConvolve type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogIPOneImageSampleConvolve | Constructs a new instance of this class. |
| CogIPOneImageSampleConvolve(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogIPOneImageSampleConvolve(CogIPOneImageSampleConvolve) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | attachCom | |
| 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 | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Execute | Perform a single image operation using the input image and region to produce the output image. |
| 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.) |
| GetKernelXValue | Get the X axis kernel value at the specified index. |
| GetKernelYValue | Get the Y axis kernel value at the specified index. |
| 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. |
| SetGaussSample | Configure both the X axis and Y axis kernels to perform Gaussian sampling at the specified sample rates. The X axis sigma will be approximately 0.5 * floor(SampleX), while the Y axis sigma will be approximately 0.5 * floor(SampleY). This method may modify any or all of SampleX, SampleY, KernelXSize, KernelYSize, as well as the actual kernel values returned by GetKernelXValue(...) or GetKernelYValue(...). |
| SetGaussSigma | Configure both the X axis and Y axis kernels to perform Gaussian sampling at the specified sigma, leaving the sampling rate (SampleX, SampleY) unchanged. This method may modify any or all of KernelSizeX, KernelSizeY, as well as the actual kernel values returned by GetKernelXValue(...) or GetKernelYValue(...). |
| SetKernelXValue | Set the X axis kernel value at the specified index to the specified value. |
| SetKernelYValue | Set the Y axis kernel value at the specified index to the specified value. |
| 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 | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | __com | |
| __disposed | |
 | __factory | |
| Creator | |
 | SfEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by Enabled may have changed. |
| SfGetKernelXValue | This bit will be set in the EventArgs of a Changed event every time the value returned by GetKernelXValue may have changed. |
| SfGetKernelYValue | This bit will be set in the EventArgs of a Changed event every time the value returned by GetKernelYValue may have changed. |
| SfKernelXSize | This bit will be set in the EventArgs of a Changed event every time the value returned by KernelXSize may have changed. |
| SfKernelYSize | This bit will be set in the EventArgs of a Changed event every time the value returned by KernelYSize may have changed. |
| SfOperatorName | This bit will be set in the EventArgs of a Changed event every time the value returned by OperatorName may have changed. |
| SfSampleX | This bit will be set in the EventArgs of a Changed event every time the value returned by SampleX may have changed. |
| SfSampleY | This bit will be set in the EventArgs of a Changed event every time the value returned by SampleY 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. |
| Enabled | Whether this one image operator will be used to compute the output image. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| KernelXSize | Get or set the size of the X axis kernel. Directly setting this property to a larger value will cause new X kernel elements, each with an initial value of zero, to be added. Directly setting this property to a smaller value will cause existing X kernel elements to be discarded. Note that directly setting this property is considered an advanced usage. |
| KernelYSize | Get or set the size of the Y axis kernel. Directly setting this property to a larger value will cause new Y kernel elements, each with an initial value of zero, to be added. Directly setting this property to a smaller value will cause existing Y kernel elements to be discarded. Note that directly setting this property is considered an advanced usage. |
| OperatorName | Returns/sets a displayable operator name. |
| SampleX | Get or set the sample rate in the X direction. To specify sampling every third pixel in the X direction, set SampleX to 3.0. Note that non-integer sampling is fully supported. |
| SampleY | Get or set the sample rate in the Y direction. To specify sampling every third pixel in the Y direction, set SampleY to 3.0. Note that non-integer sampling is fully supported. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
See Also