TLIB documentation
 

tlPoint Class Reference

Inheritance diagram for tlPoint:

Inheritance graph
[legend]
Collaboration diagram for tlPoint:

Collaboration graph
[legend]

List of all members.


Detailed Description

Point object used for image processing.

Simple point coordinates are stored in tlPoint objects. tlPoint contains both 2D image coordonates, a disparity value, and 3D world coordonates. The tlPoint object also provides convenience routines to update and copy point coordinates.

Public Member Functions

 tlPoint ()
 tlPoint (tlPoint *point)
 tlPoint (int x, int y, int disp=0)
virtual ~tlPoint ()
int copy (tlPoint *point)
int copyTo (tlPoint *point)
tlPointcopy ()
int dist (tlPoint *point)
int dist (int x, int y)
int setLocation (int x, int y, int disp=0)
int setLocation (tlPoint *point)
int shift (int dx, int dy, int ddisp=0)
int setWorldLocation (float wx, float wy, float wz)
tlLocationtoLocation ()
int toLocation (tlLocation *location)

Public Attributes

int x
int y
int disp
float wx
float wy
float wz


Constructor & Destructor Documentation

tlPoint::tlPoint (  ) 

Constructor

Note:
See error management for details.

tlPoint::tlPoint ( tlPoint point  ) 

Constructor

Parameters:
point point location
Note:
See error management for details.

tlPoint::tlPoint ( int  x,
int  y,
int  disp = 0 
)

Constructor

Parameters:
x initial x location [pix]
y initial y location [pix]
disp initial disparity [disp]
Note:
See error management for details.

tlPoint::~tlPoint (  )  [virtual]

Destructor

Note:
See error management for details.


Member Function Documentation

int tlPoint::copy ( tlPoint point  ) 

Copy the point data from an existing tlPoint object.

Parameters:
point [out] destination point
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlPoint::copyTo ( tlPoint point  ) 

Copy point location to a new tlPoint object.

Parameters:
point [out] destination point
Returns:
0 on success, -1 otherwise.
See error management for details.

tlPoint * tlPoint::copy (  ) 

Create a copy of the point.

Returns:
A pointer to a copy of the current point on success, -1 otherwise. See error management for details.
Note:
It is the responsibility of the programmer to delete the point returned.

int tlPoint::dist ( tlPoint point  ) 

Compute the distance to another point

Parameters:
point other extremity of distance to compute
Returns:
The distance between the point on success, -1 otherwise.
See error management for details.

int tlPoint::dist ( int  x,
int  y 
)

Compute the distance to another point

Parameters:
x x coordinate of other extremity of distance to compute
y y coordinate of other extremity of distance to compute
Returns:
The distance between the point on success, -1 otherwise.
See error management for details.

int tlLocation::setLocation ( int  x,
int  y,
int  disp = 0 
) [inherited]

Set the location object parameters.

Parameters:
x x location of the object [pix]
y y location of the object [pix]
disp disparity of the object [disp]
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlLocation::setLocation ( tlPoint point  )  [inherited]

Set the location object parameters.

Parameters:
point tlPoint object
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlLocation::shift ( int  dx,
int  dy,
int  ddisp = 0 
) [inherited]

Shift the object location.

Parameters:
dx shift along x axis [pix]
dy shift along y axis [pix]
ddisp disparity shift [disp]
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlLocation::setWorldLocation ( float  wx,
float  wy,
float  wz 
) [inherited]

Set the world location object parameters.

Parameters:
wx world X location
wy world Y location
wz world Z location
Returns:
0 on success, -1 otherwise.
See error management for details.

tlLocation * tlLocation::toLocation (  )  [inherited]

Get a copy of the location of the object.

Returns:
A pointer to a tlLocation object containing the data.
Note:
It is the responsibility of the programmer to delete the object returned.

int tlLocation::toLocation ( tlLocation location  )  [inherited]

Get the location of the object.

Parameters:
location [out] tlLocation object that will receive the data
Returns:
0 on success, -1 otherwise.
See error management for details.


Member Data Documentation

int tlLocation::x [inherited]

X location of the object [pix].

int tlLocation::y [inherited]

Y location of the object [pix].

int tlLocation::disp [inherited]

Disparity of the object [disp].

int tlLocation::wx [inherited]

X location of the object in real-world coordonates [m].

int tlLocation::wy [inherited]

Y location of the object in real-world coordonates [m].

int tlLocation::wz [inherited]

Z location of the object in real-world coordonates [m].


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

TLIB documentation - generated on 7 May 2008
Please address any questions to seb@tuyphon.com
(C) 2001-2008 - S. Grange
(C) 2001-2007 - VRAI Group, EPFL
All Rights Reserved.