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.

Referenced by copy().

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.

References TL_NO_ERROR.


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.

References tlLocation::disp, TL_ERRNO_MSG, TL_ERROR_NULL_POINTER, tlLocation::x, and tlLocation::y.

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.

References tlLocation::disp, TL_ERRNO_MSG, TL_ERROR_NULL_POINTER, tlLocation::x, and tlLocation::y.

Referenced by tlCameraTSAI::dewarp(), and tlCameraTSAI::warp().

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.

References tlLocation::disp, tlPoint(), tlLocation::x, and tlLocation::y.

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.

References TL_ERRNO_MSG, TL_ERROR_NULL_POINTER, tlLocation::x, and tlLocation::y.

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.

Referenced by tlLine::clip(), tlLine::copy(), tlObject::define(), tlSpiral::get(), tlSpiral::getLast(), tlSpiral::getNext(), tlMask::merge(), tlLine::set(), tl_find_shape(), tlObject::tlObject(), tlCameraSVSBase::toImage(), tlLocation::toLocation(), and tlSpiral::toNext().

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.

References tlLocation::disp, tlLocation::x, and tlLocation::y.

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.

References tlLocation::disp, tlLocation::x, and tlLocation::y.

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.

Referenced by tlLocation::toLocation(), and tlCameraSVSBase::toWorld().

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.

References tlLocation::disp, tlLocation::setLocation(), tlLocation::setWorldLocation(), tlLocation::tlLocation(), tlLocation::wx, tlLocation::wy, tlLocation::wz, tlLocation::x, and tlLocation::y.

Referenced by tlCameraSVSBase::toImage(), and tlCameraSVSBase::toWorld().

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.

References tlLocation::disp, tlLocation::wx, tlLocation::wy, tlLocation::wz, tlLocation::x, and tlLocation::y.


Member Data Documentation

int tlLocation::x [inherited]

X location of the object [pix].

Referenced by tlMask::adjust(), tlChain::blindExtract(), tlHist2D::build(), tlHist::build(), tlPixelArray::clear(), tlRect::collapse(), tlRect::copy(), copy(), tlPixelArray::copy(), tlObject::copy(), tlMask::copy(), tlRect::copyTo(), copyTo(), tlImage::crop(), tlObject::define(), tlCameraTSAI::dewarp(), dist(), tlImage::drawCross(), tlImage::drawLine(), tlImage::drawMask(), tlImage::drawObject(), tlImage::drawPoint(), tlImage::drawRect(), tlImage::drawText(), tlRect::expand(), tlObject::extract(), tlChain::extract(), tlImage::fillObject(), tlImage::fillRect(), tlColorModel::filter(), tlBackground::filter(), tlPixelArray::findBestShape(), tlPixelArray::findShape(), tlCameraSVSBase::getDisparity(), tlPixelArray::getMax(), tlPixelArray::getMin(), tlPixelArray::getPixel(), tlObject::getPredictedPosition(), tlObject::getPredictedX(), tlCameraSVSBase::getRight(), tlSourceVideoFile::grab(), tlDigitizerVRm::grab(), tlDigitizerV4L::grab(), tlDigitizerPXC200::grab(), tlDigitizerDX::grab(), tlDigitizerDT3130::grab(), tlCameraSVSHead::grab(), tlSourceVideoFile::grabQueued(), tlDigitizerPXC200::grabQueued(), tlDigitizerDT3130::grabQueued(), tlSpiral::init(), tlRect::intersect(), tlMask::invert(), tlChain::isIn(), tlPixelArray::mask(), tlPixelArray::median(), tlMask::merge(), tlMask::minimize(), tlMask::set(), tlLine::set(), tlColor::set(), tlLocation::setLocation(), tlPixelArray::setPixel(), tlLocation::shift(), tl_channel_put(), tl_channel_swap(), tl_convolution(), tl_convolution_x(), tl_convolution_y(), tl_copy_array(), tl_copy_hrarray(), tl_copy_hrsubarray(), tl_copy_subarray(), tl_dilate_all(), tl_dilate_bin(), tl_dilate_gray(), tl_edges_bin(), tl_erode_all(), tl_erode_bin(), tl_erode_gray(), tl_extract_color_gray(), tl_extract_color_hsi(), tl_extract_color_max_gray(), tl_extract_color_max_hsi(), tl_extract_color_max_nrg(), tl_extract_color_max_rgb(), tl_extract_color_max_yuv(), tl_extract_color_min_gray(), tl_extract_color_min_hsi(), tl_extract_color_min_nrg(), tl_extract_color_min_rgb(), tl_extract_color_min_yuv(), tl_extract_color_nrg(), tl_extract_color_rgb(), tl_extract_color_yuv(), tl_filter_gray(), tl_filter_hrgray(), tl_filter_hsi(), tl_filter_nrg(), tl_filter_rgb(), tl_find_best_object(), tl_find_best_shape(), tl_find_object(), tl_find_shape(), tl_gray2bin(), tl_gray2rgb(), tl_hrgray2bin(), tl_hrgray2gray(), tl_hsi2bin(), tl_hsi2gray(), tl_hsi2rgb(), tl_normalize_gray(), tl_nrg2bin(), tl_nrg2gray(), tl_pixel_add(), tl_pixel_hradd(), tl_pixel_hrscale(), tl_pixel_hrsub(), tl_pixel_scale(), tl_pixel_sub(), tl_rgb2bin(), tl_rgb2gray(), tl_rgb2hsi(), tl_rgb2nrg(), tl_rgb2yuv(), tl_thin_hitandmiss(), tl_to_channel(), tl_yuv2bin(), tl_yuv2gray(), tl_yuv2nrg(), tl_yuv2rgb(), tlLocation::tlLocation(), tlMask::tlMask(), tlSpiral::tlSpiral(), tlCameraTSAI::toImage(), tlLocation::toLocation(), tlPixelArray::toRect(), tlCameraTSAI::toWorld(), tlCameraSVSBase::toWorld(), tlBackground::update(), and tlCameraTSAI::warp().

int tlLocation::y [inherited]

Y location of the object [pix].

Referenced by tlMask::adjust(), tlChain::blindExtract(), tlHist2D::build(), tlHist::build(), tlPixelArray::clear(), tlRect::collapse(), tlRect::copy(), copy(), tlPixelArray::copy(), tlObject::copy(), tlMask::copy(), tlRect::copyTo(), copyTo(), tlImage::crop(), tlObject::define(), tlCameraTSAI::dewarp(), dist(), tlImage::drawCross(), tlImage::drawLine(), tlImage::drawMask(), tlImage::drawObject(), tlImage::drawPoint(), tlImage::drawRect(), tlImage::drawText(), tlRect::expand(), tlObject::extract(), tlChain::extract(), tlImage::fillObject(), tlImage::fillRect(), tlColorModel::filter(), tlBackground::filter(), tlPixelArray::findBestShape(), tlPixelArray::findShape(), tlCameraSVSBase::getDisparity(), tlPixelArray::getMax(), tlPixelArray::getMin(), tlPixelArray::getPixel(), tlObject::getPredictedPosition(), tlObject::getPredictedY(), tlCameraSVSBase::getRight(), tlSourceVideoFile::grab(), tlDigitizerVRm::grab(), tlDigitizerV4L::grab(), tlDigitizerPXC200::grab(), tlDigitizerDX::grab(), tlDigitizerDT3130::grab(), tlCameraSVSHead::grab(), tlSourceVideoFile::grabQueued(), tlDigitizerPXC200::grabQueued(), tlDigitizerDT3130::grabQueued(), tlSpiral::init(), tlRect::intersect(), tlChain::isIn(), tlPixelArray::mask(), tlPixelArray::median(), tlMask::merge(), tlMask::minimize(), tlMask::set(), tlLine::set(), tlColor::set(), tlLocation::setLocation(), tlPixelArray::setPixel(), tlLocation::shift(), tl_channel_put(), tl_channel_swap(), tl_convolution(), tl_convolution_x(), tl_convolution_y(), tl_copy_array(), tl_copy_hrarray(), tl_copy_hrsubarray(), tl_copy_subarray(), tl_dilate_all(), tl_dilate_bin(), tl_dilate_gray(), tl_edges_bin(), tl_erode_all(), tl_erode_bin(), tl_erode_gray(), tl_extract_color_gray(), tl_extract_color_hsi(), tl_extract_color_max_gray(), tl_extract_color_max_hsi(), tl_extract_color_max_nrg(), tl_extract_color_max_rgb(), tl_extract_color_max_yuv(), tl_extract_color_min_gray(), tl_extract_color_min_hsi(), tl_extract_color_min_nrg(), tl_extract_color_min_rgb(), tl_extract_color_min_yuv(), tl_extract_color_nrg(), tl_extract_color_rgb(), tl_extract_color_yuv(), tl_filter_gray(), tl_filter_hrgray(), tl_filter_hsi(), tl_filter_nrg(), tl_filter_rgb(), tl_find_best_object(), tl_find_best_shape(), tl_find_object(), tl_find_shape(), tl_gray2bin(), tl_gray2rgb(), tl_hrgray2bin(), tl_hrgray2gray(), tl_hsi2bin(), tl_hsi2gray(), tl_hsi2rgb(), tl_normalize_gray(), tl_nrg2bin(), tl_nrg2gray(), tl_pixel_add(), tl_pixel_hradd(), tl_pixel_hrscale(), tl_pixel_hrsub(), tl_pixel_scale(), tl_pixel_sub(), tl_rgb2bin(), tl_rgb2gray(), tl_rgb2hsi(), tl_rgb2nrg(), tl_rgb2yuv(), tl_thin_hitandmiss(), tl_to_channel(), tl_yuv2bin(), tl_yuv2gray(), tl_yuv2nrg(), tl_yuv2rgb(), tlLocation::tlLocation(), tlMask::tlMask(), tlSpiral::tlSpiral(), tlCameraTSAI::toImage(), tlLocation::toLocation(), tlPixelArray::toRect(), tlCameraTSAI::toWorld(), tlCameraSVSBase::toWorld(), tlBackground::update(), and tlCameraTSAI::warp().

int tlLocation::disp [inherited]

int tlLocation::wx [inherited]

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

Referenced by tlLocation::tlLocation(), tlCameraTSAI::toImage(), tlCameraSVSBase::toImage(), tlLocation::toLocation(), and tlCameraTSAI::toWorld().

int tlLocation::wy [inherited]

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

Referenced by tlLocation::tlLocation(), tlCameraTSAI::toImage(), tlCameraSVSBase::toImage(), tlLocation::toLocation(), and tlCameraTSAI::toWorld().

int tlLocation::wz [inherited]

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

Referenced by tlLocation::tlLocation(), tlCameraTSAI::toImage(), tlCameraSVSBase::toImage(), tlLocation::toLocation(), and tlCameraTSAI::toWorld().


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


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