This class compresses a distance from [0; inf) into [0; 1) using the following formula: dist = 1 - exp(-alpha*dist), alpha being a compression factor. More...

#include <exponentialcompressdistance.h>

Inheritance diagram for gaia2::ExponentialCompressDistance:

Public Member Functions
	ExponentialCompressDistance (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
DistanceFunction *	_dist

Real	_alpha

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 compresses a distance from [0; inf) into [0; 1) using the following formula: dist = 1 - exp(-alpha*dist), alpha being a compression factor.

Parameters

distance	the name of the distance to be compressed.
params	the parameters for creating the distance to be compressed.
alpha	the compression factor.

Member Function Documentation

Real ExponentialCompressDistance::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.

Implements gaia2::DistanceFunction.

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

src/metrics/exponentialcompressdistance.h
src/metrics/exponentialcompressdistance.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation