Data Handling

Typedefs
typedef void *	TCLF
typedef void *	TSCLF
typedef void *	TTESTRESULT

Functions
void	PMGetSearchClfTrainParams (TSCLF searchClf, TTrainParams &trainParams, TTrainSearchParams &trainSearchParams)
	Retrieves the parameters that have been used during the generation of a search classifier.
cvbbool_t	PMOpenClf (const char *szFileName, TCLF &clf)
	Open a classifier from a given file path.
cvbbool_t	PMOpenClfW (const wchar_t *szFileName, TCLF &clf)
	Open a classifier from a given file path.
cvbbool_t	PMOpenSearchClf (const char *szFileName, TSCLF &searchClf)
	Open a search classifier from a given file path.
cvbbool_t	PMOpenSearchClfW (const wchar_t *szFileName, TSCLF &searchClf)
	Open a search classifier from a given file path.
cvbbool_t	PMSaveClf (const char *szFileName, TCLF Clf)
	Save the given classifier to a file.
cvbbool_t	PMSaveClfW (const wchar_t *szFileName, TCLF Clf)
	Save the given classifier to a file.
cvbbool_t	PMSaveSearchClf (const char *szFileName, TSCLF searchClf)
	Attempts to save the given search classifier to a file.
cvbbool_t	PMSaveSearchClfW (const wchar_t *szFileName, TSCLF searchClf)
	Attempts to save the given search classifier to a file.

Detailed Description

Typedef Documentation

TCLF

typedef void* TCLF

Handle to a classification for regression classifier.

TSCLF

typedef void* TSCLF

Handle to a search classifier.

TTESTRESULT

typedef void* TTESTRESULT

Handle to a leave-out or sample test result.

Function Documentation

PMGetSearchClfTrainParams()

void PMGetSearchClfTrainParams	(	TSCLF	searchClf,
		TTrainParams &	trainParams,
		TTrainSearchParams &	trainSearchParams )

Retrieves the parameters that have been used during the generation of a search classifier.

Parameters

[in]	searchClf	Handle of search classifier.
[out]	trainParams	General training parameters and feature map (see also description of TTrainParams).
[out]	trainSearchParams	Parameters specific to the training of search classifies (TSCLF; see also description of TTrainSearchParams).

PMOpenClf()

cvbbool_t PMOpenClf	(	const char *	szFileName,
		TCLF &	clf )

Open a classifier from a given file path.

If the classifier can be successfully loaded from the given path its reference count will be initialized to 1 and a ReleaseObject call (see CVCImg.dll reference) will be needed to release the memory occupied by the classifier.

Parameters

[in]	szFileName	Pointer to a zero-terminated string containing the name of the file to be loaded.
[out]	clf	Receives the classifier handle if the classifier was loaded successfully. If loading failed, the handle will be set to NULL.

Returns

TRUE if opening the classifier from the specified path was successful, FALSE if not

PMOpenClfW()

cvbbool_t PMOpenClfW	(	const wchar_t *	szFileName,
		TCLF &	clf )

Open a classifier from a given file path.

If the classifier can be successfully loaded from the given path its reference count will be initialized to 1 and a ReleaseObject call (see CVCImg.dll reference) will be needed to release the memory occupied by the classifier.

Parameters

[in]	szFileName	Pointer to a zero-terminated string containing the name of the file to be loaded.
[out]	clf	Receives the classifier handle if the classifier was loaded successfully. If loading failed, the handle will be set to NULL.

Returns

TRUE if opening the classifier from the specified path was successful, FALSE if not

PMOpenSearchClf()

cvbbool_t PMOpenSearchClf	(	const char *	szFileName,
		TSCLF &	searchClf )

Open a search classifier from a given file path.

If the classifier can be successfully loaded from the given path its reference count will be initialized to 1 and a ReleaseObject call (see CVCImg.dll reference) will be needed to release the memory occupied by the classifier.

Parameters

[in]	szFileName	Pointer to a zero-terminated string containing the name of the file to be loaded.
[out]	searchClf	Receives the classifier handle if the classifier was loaded successfully. If loading failed, the handle will be set to NULL.

Returns

TRUE if opening the classifier from the specified path was successful, FALSE if not

PMOpenSearchClfW()

cvbbool_t PMOpenSearchClfW	(	const wchar_t *	szFileName,
		TSCLF &	searchClf )

Open a search classifier from a given file path.

If the classifier can be successfully loaded from the given path its reference count will be initialized to 1 and a ReleaseObject call (see CVCImg.dll reference) will be needed to release the memory occupied by the classifier.

Parameters

[in]	szFileName	Pointer to a zero-terminated string containing the name of the file to be loaded.
[out]	searchClf	Receives the classifier handle if the classifier was loaded successfully. If loading failed, the handle will be set to NULL.

Returns

TRUE if opening the classifier from the specified path was successful, FALSE if not

PMSaveClf()

cvbbool_t PMSaveClf	(	const char *	szFileName,
		TCLF	Clf )

Save the given classifier to a file.

Note that this function cannot be used to save search classifiers. For saving search classifiers please use PMSaveSearchClf.

Parameters

[in]	szFileName	Pointer to the zero-terminated string containing the file name to save the classifier to. Note that existing files will be overwritten.
[in]	Clf	Handle of the classifier.

Returns

TRUE if saving the classifier to the specified path was successful, FALSE if not

PMSaveClfW()

cvbbool_t PMSaveClfW	(	const wchar_t *	szFileName,
		TCLF	Clf )

Save the given classifier to a file.

Note that this function cannot be used to save search classifiers. For saving search classifiers please use PMSaveSearchClf.

Parameters

[in]	szFileName	Pointer to the zero-terminated string containing the file name to save the classifier to. Note that existing files will be overwritten.
[in]	Clf	Handle of the classifier.

Returns

TRUE if saving the classifier to the specified path was successful, FALSE if not

PMSaveSearchClf()

cvbbool_t PMSaveSearchClf	(	const char *	szFileName,
		TSCLF	searchClf )

Attempts to save the given search classifier to a file.

Parameters

[in]	szFileName	Pointer to zero-terminated string containing the file name to save to.
[in]	searchClf	Handle of the search classifier.

Returns

TRUE if saving the search classifier to the specified path was successful, FALSE if not

PMSaveSearchClfW()

cvbbool_t PMSaveSearchClfW	(	const wchar_t *	szFileName,
		TSCLF	searchClf )

Attempts to save the given search classifier to a file.

Parameters

[in]	szFileName	Pointer to zero-terminated string containing the file name to save to.
[in]	searchClf	Handle of the search classifier.

Returns

TRUE if saving the search classifier to the specified path was successful, FALSE if not