ILDataBlobFilter Interface Reference

This interface provide functionalities of data blob filtering. More...

Inheritance diagram for ILDataBlobFilter:

Public Member Functions
BOOL	Filter (ILDataBlob *blob)
ILDataBlobResults *	FilterResults (ILDataBlobResults *blobResults)
void	SetFilterFeature (LPVDataBlobFeatures feature, LPVAggregation aggType, double lowerBound, double upperBound)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Detailed Description

This interface provide functionalities of data blob filtering.

Data blob filter is used to filter data blobs of interest according to their features. There's two common ways to use the data blob filter:

1. Configure a data blob filter, then attach it to the data blob analysis tool via ILDataBlobAnalysis::AddBlobFilter().
2. Manually filter the data blob results to build a new filtered collection via ILDataBlobFilter::FilterResults().

You can have multiple data blob filters in a data blob analysis tool, for each data blob candidate, it's reported as a result if one of the filters' criteria is satisfied.
You can define multiple filtering features in a data blob filter, for each data blob candidate, it's reported as a result if all filtering features' limitations are satisfied.

To use this interface, you should create a LDataBlobFilter object.

Example Code

C++

ILDataBlobFilterPtr dataBlobFilter = LDataBlobFilter::Create();
dataBlobFilter->SetFilterFeature(LPVDataBlobFeatures::LPVDataBlobData, LPVAggregation::LPVAggMax, 100, 9999);
dataBlobResult2 = dataBlobFilter->FilterResults(dataBlobResult);

C#

LDataBlobFilter dataBlobFilter = new LDataBlobFilter();
dataBlobFilter.SetFilterFeature(LPVDataBlobFeatures.LPVDataBlobData, LPVAggregation.LPVAggMax, 100, 9999);
dataBlobResult2 = dataBlobFilter.FilterResults(dataBlobResult);

COM

ILDataBlobFilterPtr dataBlobFilter = LDataBlobFilter::Create();
// or, ILDataBlobFilterPtr dataBlobFilter(__uuidof(LDataBlobFilter)), for absence of built-in Create functions (before 2.2.0)
dataBlobFilter->SetFilterFeature(LPVDataBlobFeatures::LPVDataBlobData, LPVAggregation::LPVAggMax, 100, 9999);
dataBlobResult2 = dataBlobFilter->FilterResults(dataBlobResult);

Member Function Documentation

Filter()

BOOL Filter

(

ILDataBlob *

blob

)

Apply the filter on a single data blob.

Parameters

[in]

blob

The input data blob.

Return values

val	Return true if the input data blob meet the filter's criteria; otherwise, return false.

FilterResults()

ILDataBlobResults* FilterResults

(

ILDataBlobResults *

blobResults

)

Apply the filter on a collection of data blob, and return the filtered new collection.

Parameters

[in]

blobResults

The input data blob collection.

Return values

filterResults

Return the filtered data blob collection.

SetFilterFeature()

void SetFilterFeature	(	LPVDataBlobFeatures	feature,
		LPVAggregation	aggType,
		double	lowerBound,
		double	upperBound
	)

Configure the filtering feature and its limitation. You can define multiple joint filtering features in one data blob filter.

Parameters

[in]	feature	The filtering feature, see LPVDataBlobFeatures.
[in]	aggType	The aggregation type of the data, works only for LPVDataBlobData.
[in]	lowerBound	The lower bound of the limitation.
[in]	upperBound	The upper bound of the limitation.