lti::DBScan< T >::parameters Class Reference

the parameters for the class DBScan More...

#include <ltiDBScan.h>

Inheritance diagram for lti::DBScan< T >::parameters:

[legend]

Collaboration diagram for lti::DBScan< T >::parameters:

[legend]

List of all members.

Public Types
enum	eDistanceType
Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual classifier::parameters *	clone () const
bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
double	eps
int	minPts
int	buckedSize
eDistanceType	distanceMeasure

---

Detailed Description

template<class T = l2SquareDistantor<vector<double> >>
class lti::DBScan< T >::parameters

the parameters for the class DBScan

---

Member Enumeration Documentation

template<class T = l2SquareDistantor<vector<double> >>

enum lti::DBScan::parameters::eDistanceType

this function is required by MSVC only, as a workaround for a very awful bug, which exists since MSVC V.4.0, and still by V.6.0 with all bugfixes (so called "service packs") remains there.

.. This method is also public due to another bug, so please NEVER EVER call this method directly: use read() instead this function is required by MSVC only, as a workaround for a very awful bug, which exists since MSVC V.4.0, and still by V.6.0 with all bugfixes (so called "service packs") remains there... This method is also public due to another bug, so please NEVER EVER call this method directly: use write() instead

---

Constructor & Destructor Documentation

template<class T = l2SquareDistantor<vector<double> >>

lti::DBScan< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::clustering::parameters.

References lti::DBScan< T >::parameters::buckedSize, lti::DBScan< T >::parameters::distanceMeasure, lti::DBScan< T >::parameters::eps, and lti::DBScan< T >::parameters::minPts.

Referenced by lti::DBScan< T >::parameters::clone().

template<class T = l2SquareDistantor<vector<double> >>

lti::DBScan< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::clustering::parameters.

References lti::DBScan< T >::parameters::copy().

template<class T = l2SquareDistantor<vector<double> >>

virtual lti::DBScan< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::clustering::parameters.

---

Member Function Documentation

template<class T = l2SquareDistantor<vector<double> >>

virtual classifier::parameters* lti::DBScan< T >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::clustering::parameters.

References lti::DBScan< T >::parameters::parameters().

template<class T = l2SquareDistantor<vector<double> >>

parameters& lti::DBScan< T >::parameters::copy

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::clustering::parameters.

References lti::DBScan< T >::parameters::buckedSize, lti::clustering::parameters::copy(), lti::DBScan< T >::parameters::distanceMeasure, lti::DBScan< T >::parameters::eps, and lti::DBScan< T >::parameters::minPts.

Referenced by lti::DBScan< T >::parameters::operator=(), and lti::DBScan< T >::parameters::parameters().

template<class T = l2SquareDistantor<vector<double> >>

const char* lti::DBScan< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::clustering::parameters.

template<class T = l2SquareDistantor<vector<double> >>

parameters& lti::DBScan< T >::parameters::operator=

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::unsupervisedClassifier::parameters.

References lti::DBScan< T >::parameters::copy().

template<class T = l2SquareDistantor<vector<double> >>

virtual bool lti::DBScan< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[inline, virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::clustering::parameters.

References lti::DBScan< T >::parameters::buckedSize, lti::DBScan< T >::parameters::distanceMeasure, lti::DBScan< T >::parameters::eps, lti::DBScan< T >::parameters::minPts, lti::ioHandler::readBegin(), and lti::ioHandler::readEnd().

template<class T = l2SquareDistantor<vector<double> >>

bool lti::DBScan< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [inline, virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::clustering::parameters.

References lti::DBScan< T >::parameters::buckedSize, lti::DBScan< T >::parameters::distanceMeasure, lti::DBScan< T >::parameters::eps, lti::DBScan< T >::parameters::minPts, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T = l2SquareDistantor<vector<double> >>

int lti::DBScan< T >::parameters::buckedSize

number of elements stored in each leaf of the kd-tree, which is used als internal datastructure of DBScan

Referenced by lti::DBScan< T >::parameters::copy(), lti::DBScan< T >::parameters::parameters(), lti::DBScan< T >::parameters::read(), and lti::DBScan< T >::parameters::write().

template<class T = l2SquareDistantor<vector<double> >>

eDistanceType lti::DBScan< T >::parameters::distanceMeasure

The kind of distance measurement that is used for computing the distances between the data points.

Values are: l1Distance, l2Distance, l2SquareDistance

Referenced by lti::DBScan< T >::parameters::copy(), lti::DBScan< T >::parameters::parameters(), lti::DBScan< T >::parameters::read(), and lti::DBScan< T >::parameters::write().

template<class T = l2SquareDistantor<vector<double> >>

double lti::DBScan< T >::parameters::eps

Define eps region for a point, where neighbour points must be in.

Referenced by lti::DBScan< T >::parameters::copy(), lti::DBScan< T >::parameters::parameters(), lti::DBScan< T >::parameters::read(), and lti::DBScan< T >::parameters::write().

template<class T = l2SquareDistantor<vector<double> >>

int lti::DBScan< T >::parameters::minPts

Number of points which have to be in the eps-neighbourhood otherwise the points are defined as noise.

Referenced by lti::DBScan< T >::parameters::copy(), lti::DBScan< T >::parameters::parameters(), lti::DBScan< T >::parameters::read(), and lti::DBScan< T >::parameters::write().

---

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

• ltiDBScan.h