Class that subsamples the pixels in a image by blocks specified by SampleX and SampleY to produce an image of reduced size. Pixels selected will be the closest to each blocks center or the average pixel value if SpatialAverage is enabled.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.ImageProcessing CogIPOneImageSubSampler
Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 93.1.0.0
Syntax
The CogIPOneImageSubSampler type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogIPOneImageSubSampler | Constructs a new instance of this class. |
| CogIPOneImageSubSampler(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogIPOneImageSubSampler(CogIPOneImageSubSampler) | 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.) |
| 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 | |
|---|---|---|
 | __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. |
| 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. |
| SfSpatialAverage | This bit will be set in the EventArgs of a Changed event every time the value returned by SpatialAverage 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. |
| OperatorName | Returns/sets a displayable operator name. |
| SampleX | The factor used to divide the image into blocks of SampleX pixels along its width. The output image is produced from either most central pixel of each block specified by SampleX and SampleY, or if SpatialAverage is enabled, the average of the block. |
| SampleY | The factor used to divide the image into blocks of SampleY pixels along its height. The output image is produced from either most central pixel of each block specified by SampleX and SampleY, or if SpatialAverage is enabled, the average of the block. |
| SpatialAverage | A flag designating that the image should be averaged, and not merely sampled. The pixel values from each pixel in the sample-size blocks are summed, and the result is divided by the number of pixels in the block. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
Primary interface of a CogIPOneImageSubSampler object. This object samples an image in the x- and y-directions to produce a new image. You can configure this object to perform spatial averaging instead of sampling.
Subsampling divides an image into blocks of SampleX by SampleY pixels and selects the pixel closest to each block’s center. When there is no pixel at the exact center of a subsampling block (as is the case in the figure), the pixel to the upper left of center is selected.
Spatial averaging divides an image into of SampleX by SampleY pixels. The pixel values from each pixel in the block are summed, and the result is divided by the number of pixels in the block. The averaged pixel value from the block of pixels is then applied to a single pixel in the destination window. Partial blocks in the image are ignored during spatial averaging.
If you specify an even subsampling rate and you do not use spatial averaging, the tool selects the pixel above and to the left of the center of the sampling area. This introduces a one-half pixel shift in the locations of features in the sampled image. The tool automatically adjusts the output image coordinate space tree by shifting the coordinate space by one-half pixel. Because spatial averaging averages pixel values evenly across the sampling area regardless of its size, no such adjustment is required when spatial averaging is enabled.
See Also