CogBlob Class

Cognex VisionPro

Class for configuring and performing blob analysis. The blob run-time parameters include, but are not limited to, settings for segmentation, connectivity, morphology, masking, filtering, and sorting.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Blob CogBlob

Namespace: Cognex.VisionPro.Blob
Assembly: Cognex.VisionPro.Blob (in Cognex.VisionPro.Blob.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogBlob : CogSerializableChangedEventBase, IDisposable, 
	ICloneable

[SerializableAttribute]
public class CogBlob : CogSerializableChangedEventBase, IDisposable, 
	ICloneable

<SerializableAttribute>
Public Class CogBlob 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable, ICloneable

<SerializableAttribute>
Public Class CogBlob 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable, ICloneable

[SerializableAttribute]
public ref class CogBlob : public CogSerializableChangedEventBase, 
	IDisposable, ICloneable

[SerializableAttribute]
public ref class CogBlob : public CogSerializableChangedEventBase, 
	IDisposable, ICloneable

The CogBlob type exposes the following members.

Constructors

	Name	Description
	CogBlob	Constructs a new instance of this class.
	CogBlob(CogBlob)	Constructs a new instance of this class as a deep copy of the given instance.
	CogBlob(SerializationInfo, StreamingContext)	Serialization constructor for CogBlob object.

Top

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.
	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	Destruct this CogBlob.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Performs blob analysis on the provided InputImage and optional Region, creating a CogBlobResults object which provides the results of the analysis. If Region is nothing then blob analysis will be performed on the entire InputImage.
	Finalize	Finalize this CogBlob. (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	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	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfComputeBlobRLE	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputeBlobRLE may have changed.
	SfComputeInertia	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputeInertia may have changed.
	SfComputeTopology	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputeTopology may have changed.
	SfConnectivityCleanup	This bit will be set in the EventArgs of a Changed event every time the value returned by ConnectivityCleanup may have changed.
	SfConnectivityMinPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by ConnectivityMinPixels may have changed.
	SfConnectivityMode	This bit will be set in the EventArgs of a Changed event every time the value returned by ConnectivityMode may have changed.
	SfExtremaAngle	This bit will be set in the EventArgs of a Changed event every time the value returned by ExtremaAngle may have changed.
	SfExtremaExcludeArea	This bit will be set in the EventArgs of a Changed event every time the value returned by ExtremaExcludeArea may have changed.
	SfExtremaExcludeAreaPercent	This bit will be set in the EventArgs of a Changed event every time the value returned by ExtremaExcludeAreaPercent may have changed.
	SfExtremaExcludeAreaPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by ExtremaExcludeAreaPixels may have changed.
	SfExtremaExcludeMode	This bit will be set in the EventArgs of a Changed event every time the value returned by ExtremaExcludeMode 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.
	SfMorphologyOperations	This bit will be set in the EventArgs of a Changed event every time the value returned by MorphologyOperations may have changed.
	SfNextSf
	SfRegionMode	This bit will be set in the EventArgs of a Changed event every time the value returned by RegionMode may have changed.
	SfRunTimeMeasures	This bit will be set in the EventArgs of a Changed event every time the value returned by RunTimeMeasures may have changed.
	SfSaveSegmentedImage	This bit will be set in the EventArgs of a Changed event every time the value returned by SaveSegmentedImage may have changed.
	SfSaveSegmentedImageBeforeMasking	This bit will be set in the EventArgs of a Changed event every time the value returned by SaveSegmentedImageBeforeMasking may have changed.
	SfSaveSegmentedImageBeforeMorphology	This bit will be set in the EventArgs of a Changed event every time the value returned by SaveSegmentedImageBeforeMorphology may have changed.
	SfSegmentationParams	This bit will be set in the EventArgs of a Changed event every time the value returned by SegmentationParams may have changed.
	SfSortAscending	This bit will be set in the EventArgs of a Changed event every time the value returned by SortAscending may have changed.
	SfSortEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by SortEnabled may have changed.
	SfSortMeasure	This bit will be set in the EventArgs of a Changed event every time the value returned by SortMeasure may have changed.

Top

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. (Inherited from CogSerializableChangedEventBase.)
	ComputeBlobRLE	If false then improve blob processing speed by not saving the run lengths of regions. This will make blob boundaries, blob perimeters, and blob images unavailable.
	ComputeInertia	If false then improve blob processing speed by not computing the inertia, principal inertia, angle, and elongation.
	ComputeTopology	If false then improve blob processing speed by not computing the parent - child relationships between regions.
	ConnectivityCleanup	Determines the cleanup method to use after performing connectivity analysis of the blobs. ConnectivityCleanup is not available when connectivity mode is set to whole image, in which case the cleanup and minimum pixels settings are simply ignored.
	ConnectivityMinPixels	The minimum size, in pixels, of features that will not be cleaned up during connectivity cleanup. ConnectivityCleanup is not available when connectivity mode is set to whole image, in which case the cleanup and minimum pixels settings are simply ignored.
	ConnectivityMode	Determines the connectivity to be used when analyzing blobs.
	ExtremaAngle	The angle (in radians) at which the bounding box or median point is computed when the axis argument of MedianX, MedianY, or GetBoundingBox is ExtremaAngle. The extrema angle is specified in the selected space of the input image.
	ExtremaExcludeArea	The amount of area to exclude when computing either a bounding box or median point, only used when the ExtremaExcludeMode is set to Area. The area is specified in units of the selected space of the InputImage.
	ExtremaExcludeAreaPercent	The amount of area to exclude when computing either a bounding box or median point, only used when the ExtremaExcludeMode is set to AreaPercent. The area is specified in terms of percentage of pixels to exclude.
	ExtremaExcludeAreaPixels	The amount of area to exclude when computing either a bounding box or median point, only used when the ExtremaExcludeMode is set to AreaPixels. The area is specified in image pixel units.
	ExtremaExcludeMode	Indicates if some of the feature's area should be excluded when making the median and bounding box measures. If area should be excluded, the mode also indicates which property specifies the area to be excluded.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	InputImageMask	Mask indicating areas of Care (Non-Zero Mask Pixels) and Don't Care (Zero). Don't Care areas are treated as background/holes when performing grey scale connectivity. 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 image 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 image coordinates of the InputImage.
	MorphologyOperations	A collection of CogBlobMorphologyConstants indicating which morphology operations are to be performed on the segmented image. The operations are performed in the order in which they are added to the collection. Operations can be added multiple times.
	RegionMode	Specifies whether blob analysis will be performed strictly within the confines of the region specified or whether blob analysis will be performed within the image aligned bounding box of the region.
	RunTimeMeasures	A collection indicating how the specified measures will be used during execution of blob analysis. Blob measures can either be used as filter criteria or precomputed such that the time required to calculate the measure is part of the blob execution time.
	SaveSegmentedImage	Save the segmented image as part of the blob results. Otherwise, the image will be released once blob analysis has completed and the CreateSegmentedImage method will return Nothing when requesting this image.
	SaveSegmentedImageBeforeMasking	Save the segmented image, before masking and morphology, as part of the blob results. Otherwise, the image will be released once blob analysis has completed and the CreateSegmentedImage method will return Nothing when requesting this image.
	SaveSegmentedImageBeforeMorphology	Save the segmented image, after masking but before morphology, as part of the blob results. Otherwise, the image will be released once blob analysis has completed and the CreateSegmentedImage method will return Nothing when requesting this image.
	SegmentationParams	Interface which allows the user to select and configure the desired method of image segmentation.
	SortAscending	A value of True will sort the blobs in ascending order. SortAscending is only used if SortEnabled is true.
	SortEnabled	Enables the sorting of the filtered collection of blobs. The SortMeasure and SortAscending properties indicate how the blobs will be sorted.
	SortMeasure	The blob measure that will be used for sorting the filtered collection of blobs. SortMeasure is only used if SortEnabled is true.
	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.)

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)

Top