cvr::location Class Reference

The location class specifies an interest point and a small surrounding region in an image or channel. More...

#include <cvrLocation.h>

Inheritance diagram for cvr::location:

[legend]

Collaboration diagram for cvr::location:

[legend]

List of all members.

Public Member Functions
	location ()
	location (const ipoint &pos, const float &ang, const float &rad)
	location (const fpoint &pos, const float &ang, const float &rad)
	location (const location &other)
location &	copy (const location &other)
location &	operator= (const location &other)
bool	operator== (const location &p) const
bool	operator!= (const location &p) const
bool	operator< (const location &other)
bool	operator> (const location &other)
location &	scale (const float &factor)
location &	scale (const location &other, const float &factor)
location &	shift (const ipoint &shft)
location &	shift (const fpoint &shft)
location &	shift (const location &other, const ipoint &shft)
location &	shift (const location &other, const fpoint &shft)
location &	rotate (const float &ang)
location &	rotate (const location &other, const float &ang)
bool	contains (const ipoint &p) const
bool	contains (const fpoint &p) const
float	distance (const location &other)
Public Attributes
fpoint	position
float	angle
float	radius

---

Detailed Description

The location class specifies an interest point and a small surrounding region in an image or channel.

It is mainly used in the extraction of local descriptors. There are some functors to extract the important or salient locations in an image, for example cvr::pyramidLocationSearch.

A locations is represented by its position in an image or channel, an orientation and a radius.

---

Constructor & Destructor Documentation

cvr::location::location

(

)

default constructor

cvr::location::location	(	const ipoint &	pos,
		const float &	ang,
		const float &	rad
	)

Constructor.

Parameters:

	pos	position of the center point of the location
	ang	angle of the location (in radians)
	rad	radius or size of the location

cvr::location::location	(	const fpoint &	pos,
		const float &	ang,
		const float &	rad
	)

Constructor.

Parameters:

	pos	position of the center point of the location
	ang	angle of the location (in radians)
	rad	radius or size of the location

cvr::location::location

(

const location &

other

)

copy constructor

---

Member Function Documentation

bool cvr::location::contains

(

const fpoint &

p

)

const

Check if the given point can be considered within the location, i.e.

if ||p-position||_L2 < radius

Parameters:

p

query point

bool cvr::location::contains

(

const ipoint &

p

)

const

Check if the given point can be considered within the location, i.e.

if ||p-position||_L2 < radius

Parameters:

p

query point

location& cvr::location::copy

(

const location &

other

)

copy operator

float cvr::location::distance

(

const location &

other

)

returns the distance between the borders of two locations or zero if they overlap or one of the locations lies inside the other one.

bool cvr::location::operator!=

(

const location &

p

)

const

operator !=

bool cvr::location::operator<

(

const location &

other

)

Comparison operator: less than.

A location is smaller than another one if its radius is smaller, or in case of equal radii, if the position is smaller, i.e. if it has smaller y-coordinate, or in case of equal y-position, if it has smaller x-coordinate.

location& cvr::location::operator=

(

const location &

other

)

alias for copy operator

bool cvr::location::operator==

(

const location &

p

)

const

operator ==

bool cvr::location::operator>

(

const location &

other

)

Comparison operator: greater than.

A location is greater than another one if its radius is greater, or in case of equal radii, if the position is greater, i.e. if it has greater y-coordinate, or in case of equal y-position, if it has greater x-coordinate.

location& cvr::location::rotate	(	const location &	other,
		const float &	ang
	)

Rotate the location by adding the given angle in radians to the angle of the other location and leave the result here.

Parameters:

	other	location to be rotated
	ang	rotation angle

location& cvr::location::rotate

(

const float &

ang

)

Rotate the location by adding the given angle in radians to the actual angle.

Parameters:

ang

rotation angle

location& cvr::location::scale	(	const location &	other,
		const float &	factor
	)

Multiply the other location's radius and position with the given factor and leave the result here.

Parameters:

	other	location to be scaled
	factor	scaling factor for radius and position.

location& cvr::location::scale

(

const float &

factor

)

Multiply the radius and position with the given factor.

Parameters:

factor

scaling factor for radius and position.

location& cvr::location::shift	(	const location &	other,
		const fpoint &	shft
	)

Shift the other location by the given point and leave the result here.

Parameters:

	other	location to be shifted
	shft	shift the position of other by this offset

location& cvr::location::shift	(	const location &	other,
		const ipoint &	shft
	)

Shift the other location by the given point and leave the result here.

Parameters:

	other	location to be shifted
	shft	shift the position of other by this offset

location& cvr::location::shift

(

const fpoint &

shft

)

Shift the location by the given point.

Parameters:

shft

shift the position by this offset

location& cvr::location::shift

(

const ipoint &

shft

)

Shift the location by the given point.

Parameters:

shft

shift the position by this offset

---

Member Data Documentation

float cvr::location::angle

Angle in radians of the location.

It is usually given for the image coordinates, i.e. for a left coordinate system, in which positive angles are given clock-wise.

fpoint cvr::location::position

Position of the location.

float cvr::location::radius

Radius or size of the location.

---

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

• cvrLocation.h