Finder Class Reference

DNC finder used to perform a search on a PointCloud. More...

Inherits INativeHandle.

Public Member Functions
void	Dispose ()
	IDisposable implementation.
SearchResult[]	Find (DensePointCloud pointCloud, SearchParameters parameters)
	Search for objects on the given pointCloud . More...
void	Save (string fileName)
	Saves the finder to the given fileName . More...
TeachParameters	GetTeachParameters ()
	Gets the TeachParameters with which this Finder was trained. More...
TeachParameters	GetTeachParameters (out double resolution, out double fringe)
	Gets the TeachParameters with which this Finder was trained, including resolution and fringe. More...

Static Public Member Functions
static Finder	FromFile (string fileName)
	Loads a finder from the given fileName . More...
static Finder	FromHandle (IntPtr handle)
	Create a finder from the given handle . More...

Protected Member Functions
virtual void	Dispose (bool disposing)
	IDisposable helper function. More...

Properties
IntPtr	Handle [get]
	Native handle of the Finder.
bool	IsDisposed [get]
	Gets if the native handle has been disposed.
Properties inherited from INativeHandle
IntPtr	Handle [get]
	The native handle of the object.
bool	IsDisposed [get]
	Possibility to check whether the object has already been disposed of.

Events
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...

Detailed Description

DNC finder used to perform a search on a PointCloud.

Member Function Documentation

Dispose()

virtual void Dispose ( bool  disposing )

protectedvirtual

IDisposable helper function.

Parameters

disposing

Find()

SearchResult[] Find	(	DensePointCloud	pointCloud,
		SearchParameters	parameters
	)

Search for objects on the given pointCloud .

Parameters

pointCloud	PointCloud to search on.
parameters	Search parameters to use.

Returns

Found results.

Exceptions

ArgumentNullException	When pointCloud is null.
CvbException	When an error occurs during the search.

FromFile()

static Finder FromFile ( string  fileName )

static

Loads a finder from the given fileName .

Parameters

fileName

File to load.

Returns

Loaded finder.

Exceptions

ArgumentException	When fileName is null or empty.
CvbException	When an error occurs during loading or creating the finder.

FromHandle()

static Finder FromHandle ( IntPtr  handle )

static

Create a finder from the given handle .

Parameters

handle

Native handle.

Returns

Created finder.

GetTeachParameters() [1/2]

TeachParameters GetTeachParameters

(

)

Gets the TeachParameters with which this Finder was trained.

Returns

TeachParameters with which this Finder was trained.

GetTeachParameters() [2/2]

TeachParameters GetTeachParameters	(	out double	resolution,
		out double	fringe
	)

Gets the TeachParameters with which this Finder was trained, including resolution and fringe.

Parameters

resolution	Variable to receive the resolution.
fringe	Variable to receive the fringe.

Returns

TeachParameters with which this Finder was trained.

Save()

void Save

(

string

fileName

)

Saves the finder to the given fileName .

Parameters

fileName

Path to save the finder to.

Exceptions

CvbException

When an error occurs during saving.

Event Documentation

ObjectDisposing

NativeHandleEventDelegate ObjectDisposing

Raised when this object is about to be disposed via the IDisposable.Dispose method.

This event is raised right before this object is disposed. The dispose itself cannot be canceled.