CogBlobResults.GetSiblings Method

CogBlobResults GetSiblings Method

Cognex VisionPro

Get either a filtered or unfiltered collection of the siblings of the blob specified by ID. The filtered blobs will also be sorted if sorting was enabled.

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

Syntax

C++

Copy to Clipboard Print

public CogBlobResultCollection GetSiblings(
	int blobID,
	bool filtered
)

public CogBlobResultCollection GetSiblings(
	int blobID,
	bool filtered
)

Public Function GetSiblings ( 
	blobID As Integer,
	filtered As Boolean
) As CogBlobResultCollection

Public Function GetSiblings ( 
	blobID As Integer,
	filtered As Boolean
) As CogBlobResultCollection

public:
CogBlobResultCollection^ GetSiblings(
	int blobID, 
	bool filtered
)

public:
CogBlobResultCollection^ GetSiblings(
	int blobID, 
	bool filtered
)

Parameters

blobID: Type: System Int32
The ID of the blob the siblings of which are returned.

filtered: Type: System Boolean
If true, the blobs are filtered according to the defined CogBlobMeasure objects. If false, blobs are not filtered.

Return Value

Type: CogBlobResultCollection
The returned CogBlobResultCollection.

Exceptions

Exception	Condition
ArgumentException	blobID is less than 1 or greater than the number of unfiltered blobs in this CogBlobResults.
InvalidOperationException	If no result data is available.

Remarks

Get the siblings of the blob specified by the supplied ID. A blob's siblings are all of the features that have the same parent as the blob. The returned collection includes both the blob you supply and all of its siblings.