This class computes the harmonic distance between keys. More...

Inheritance diagram for gaia2::KeyDistance:

Public Member Functions
	KeyDistance (const PointLayout &layout, const ParameterMap &params)

Real	operator() (const Point &p1, const Point &p2, int seg1, int seg2) const
	This function computes the distance between the two given points. More...

Public Member Functions inherited from gaia2::DistanceFunction
	DistanceFunction (const PointLayout &layout, const ParameterMap &params)

const PointLayout &	layout () const

const Region &	checkFixedLength (const Region &region) const
	Checks that the given Region only contains fixed-length descriptors and throws an exception if not. More...

Protected Attributes
int	_keyIndex

Protected Attributes inherited from gaia2::DistanceFunction
PointLayout	_layout

ParameterMap	_params

Region	_region

Additional Inherited Members
Public Attributes inherited from gaia2::DistanceFunction
QString	name
	Name for the metric, usually the key that was used to instantiate it from the factory.

QStringList	validParams
	List of valid parameters this analyzer accepts. More...

Detailed Description

This class computes the harmonic distance between keys.

Range is from 0 to 1. This distance has been written by Nico and is more likely to serve as an example than a useful distance, but still...

Parameters

name	the name of the descriptor containing the key value. Default is "key_key".

Member Function Documentation

Real gaia2::KeyDistance::operator()	(	const Point &	p1,
		const Point &	p2,
		int	seg1,
		int	seg2
	)		const

virtual

This function computes the distance between the two given points.

It needs to be implemented in each subclass. It takes as optional arguments the number of the segments on which to operate.

The documentation for this class was generated from the following files: