Class that applies a kernel to the image that approximates a two-dimensional Gaussian distribution. By varying the size of this kernel, you can reduce the strength of noise, or you can attenuate image features below a certain size. Optional subsampling and/or scaling are performed last.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.ImageProcessing CogIPOneImageGaussSampler
Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 79.0.0.0
Syntax
The CogIPOneImageGaussSampler type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogIPOneImageGaussSampler | Constructs a new instance of this class. |
| CogIPOneImageGaussSampler(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogIPOneImageGaussSampler(CogIPOneImageGaussSampler) | 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 | 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.) |
| 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 | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfCarePelsMinFraction | This bit will be set in the EventArgs of a Changed event every time the value returned by CarePelsMinFraction may have changed. |
| SfEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by Enabled may have changed. |
| SfInputImageMask | This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageMask may have changed. |
| SfInputImageMaskOffsetX | This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageMaskOffsetX may have changed. |
| SfInputImageMaskOffsetY | This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageMaskOffsetY may have changed. |
| SfIntermediateImageComputationPolicy | This bit will be set in the EventArgs of a Changed event every time the value returned by IntermediateImageComputationPolicy may have changed. |
| SfIntermediateImageMask | This bit will be set in the EventArgs of a Changed event every time the value returned by IntermediateImageMask may have changed. |
| SfIntermediateImageMaskOffsetX | This bit will be set in the EventArgs of a Changed event every time the value returned by IntermediateImageMaskOffsetX may have changed. |
| SfIntermediateImageMaskOffsetY | This bit will be set in the EventArgs of a Changed event every time the value returned by IntermediateImageMaskOffsetY may have changed. |
| SfIntermediateImageMaskSelect | This bit will be set in the EventArgs of a Changed event every time the value returned by IntermediateImageMaskSelect may have changed. |
| SfMagnitudeShift | This bit will be set in the EventArgs of a Changed event every time the value returned by MagnitudeShift 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. |
| SfOutputImageFormat | This bit will be set in the EventArgs of a Changed event every time the value returned by OutputImageFormat may have changed. |
| SfOutputImageMask | This bit will be set in the EventArgs of a Changed event every time the value returned by OutputImageMask may have changed. |
| SfOutputSelect | This bit will be set in the EventArgs of a Changed event every time the value returned by OutputSelect 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. |
| SfSigmaX | This bit will be set in the EventArgs of a Changed event every time the value returned by SigmaX may have changed. |
| SfSigmaY | This bit will be set in the EventArgs of a Changed event every time the value returned by SigmaY may have changed. |
| SfSmoothnessX | This bit will be set in the EventArgs of a Changed event every time the value returned by SmoothnessX may have changed. |
| SfSmoothnessY | This bit will be set in the EventArgs of a Changed event every time the value returned by SmoothnessY may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | CarePelsMinFraction | Only meaningfull when IntermediateImageComputationPolicy is UseCarePelsMinFraction. Zero has a special meaning: it means "accept any non-zero fraction, no matter how small." |
| 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. |
| InputImageMask | Mask indicating areas of Care (mask value 255) and Don't Care (mask value zero). The mask is aligned to the InputImage using the InputImageMaskOffsetX & Y values. |
| InputImageMaskOffsetX | X offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the InputImage to the upper-left corner of the InputImageMask, in pixel coordinates of the InputImage. |
| InputImageMaskOffsetY | Y offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the InputImage to the upper-left corner of the InputImageMask, in pixel coordinates of the InputImage. |
| IntermediateImageComputationPolicy | How to use the kernel and the InputImageMask to determine whether to compute a pixel value or copy from the InputImage. |
| IntermediateImageMask | Mask indicating areas of Care (mask value 255) and Don't Care (mask value zero). The mask is aligned to the intermediate image using the IntermediateImageMaskOffsetX & Y values. |
| IntermediateImageMaskOffsetX | X offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the intermediate image to the upper-left corner of the IntermediateImageMask, in pixel coordinates of the intermediate image. |
| IntermediateImageMaskOffsetY | Y offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the intermediate image to the upper-left corner of the IntermediateImageMask, in pixel coordinates of the intermediate image. |
| IntermediateImageMaskSelect | Decides whether to use the IntermediateImageMask, or use the InputImageMask as the IntermediateImageMask. |
| MagnitudeShift | Bitwise shifts the pixel values of the result. Valid shift values are from -7 to 7. Negative values will darken the result by dividing the pixel value results by 2 for each bit specified. Similarly, positive values will brighten by multiplying by 2. |
| OperatorName | Returns/sets a displayable operator name. |
| OutputImageFormat | Obsolete. The pixel depth of the image to generate by the Gaussian operation. |
| OutputImageMask | This is the computed mask that helps us figure out which output pixels were computed and which were copied from InputImage. |
| OutputSelect | Whether the operator should output just an image, or an image plus a computed image mask. |
| SampleX | Subsampling rate in the X direction that reduces the image width, dividing by the specified value. Sampling is performed after the Gaussian filter is applied. In general, SampleX should be less than SmoothnessX. |
| SampleY | Subsampling rate in the Y direction that reduces the image height, dividing by the specified value. Sampling is performed after the Gaussian filter is applied. In general, SampleY should be less than SmoothnessY. |
| SigmaX | Returns the standard deviation of the Gaussian curve along the X axis. |
| SigmaY | Returns the standard deviation of the Gaussian curve along the Y axis. |
| SmoothnessX | Smoothness in the X direction. The smoothness value determines the sigma of the Gaussian curve and in turn the size of the Gaussian kernel. For speed efficiency, it is recommended that the smoothness not exceed 24 for CogImage8Grey or CogImage24PlanarColor, and not exceed 39 for CogImage16Grey. |
| SmoothnessY | Smoothness in the Y direction. The smoothness value determines the sigma of the Gaussian curve and in turn the size of the Gaussian kernel. For speed efficiency, it is recommended that the smoothness not exceed 24 for CogImage8Grey or CogImage24PlanarColor, and not exceed 39 for CogImage16Grey. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
Primary interface of a CogIPOneImageGaussSampler object. This object performs Gaussian subsampling on an image to produce a new image. See the Gaussian Sampling Theory Topic to learn more about Gaussian Sampling.
See Also