Class for generating a histogram.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.ImageProcessing CogHistogram
Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 83.0.0.0
Syntax
The CogHistogram type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogHistogram | Constructs a new instance of this class. |
| CogHistogram(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogHistogram(CogHistogram) | 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 | Generates a histogram from the provided InputImage and optional Region, creating a CogHistogramResult object that provides the result of the analysis. If Region is nothing then histogram will be generated from the entire InputImage. |
| 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 | |
 | SfBinMode | This bit will be set in the EventArgs of a Changed event every time the value returned by BinMode 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. |
| SfNumBins | This bit will be set in the EventArgs of a Changed event every time the value returned by NumBins may have changed. |
| SfRegionMode | This bit will be set in the EventArgs of a Changed event every time the value returned by RegionMode may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | BinMode | The BinMode specifies how bin processing should be performed. |
| 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. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| InputImageMask | Mask indicating areas of Care (Non-Zero Mask Pixels) and Don't Care (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. |
| NumBins | Specifies the size of the histogram. When an image is analyzed, each histogram bin is computed up to index NumBins-1. Pixel values that are greater than or equal to NumBins will be included in the total number of samples and placed in the highest bin. |
| RegionMode | The RegionMode specifies how the region should be interpreted. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
Interface for configuring and generating a histogram.
See Also