Gaia
gaia2::SummedSegmentDistance Class Reference

This class calculates a distance between segments from two points and sums the results. More...

#include <summedsegmentdistance.h>

Inheritance diagram for gaia2::SummedSegmentDistance:
gaia2::DistanceFunction

Public Member Functions

 SummedSegmentDistance (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 PointLayoutlayout () const
 
const RegioncheckFixedLength (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
 
bool _cross
 
- 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 calculates a distance between segments from two points and sums the results.

The cross param defines whether only segments at the same position should be compared, or each with each. The function used to calculate the distance between two segments is given by the distance param.

WARNING: this metric is not final, and it might change its behavior in the future.

Parameters
distancethe name of the distance to be compressed.
paramsthe ParameterMap to be used when creating the specified distance.
crosscompare segments at the same position or each with each

Member Function Documentation

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