This class computes the euclidean distance of a given Region. More...

Inheritance diagram for gaia2::EuclideanDistance:

Public Member Functions
	EuclideanDistance (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...

	EuclideanDistance (int dimension)

float	operator() (const float const p1, const float const p2) const

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...

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...

Protected Attributes inherited from gaia2::DistanceFunction
PointLayout	_layout

ParameterMap	_params

Region	_region

Detailed Description

This class computes the euclidean distance of a given Region.

Parameters

descriptorNames	the names of the descriptors to be included in the computation of the distance. Only accepts real descriptors, can use wildcards.
except	the names of the descriptors to be removed from the selected list specified before. Can use wildcards.

Member Function Documentation

Real EuclideanDistance::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: