[artoolkit-commits] artoolkit/include/AR ar.h,1.2,1.3 matrix.h,1.2,1.3 param.h,1.3,1.4

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/artoolkit/artoolkit/include/AR
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23455

Modified Files:
	ar.h matrix.h param.h 
Log Message:
added documentation

Index: param.h
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/include/AR/param.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** param.h	22 Nov 2004 08:17:34 -0000	1.3
--- param.h	25 Nov 2004 23:24:20 -0000	1.4
***************
*** 116,121 ****
  *
  *  XXXBK
! * \param source XXXBK
! * \param cpara XXXBK
  * \param trans XXXBK
  * \return  XXXBK
--- 116,121 ----
  *
  *  XXXBK
! * \param source input camera matrix
! * \param cpara camera parameter to be set
  * \param trans XXXBK
  * \return  XXXBK
***************
*** 126,138 ****
  						 double *ox, double *oy )
  
! * \brief  XXXBK
  *
! *  XXXBK
! * \param dist_factor XXXBK
! * \param ix XXXBK
! * \param iy XXXBK
! * \param ox XXXBK
! * \param oy XXXBK
! * \return  XXXBK
  */
  int arParamIdeal2Observ( const double dist_factor[4], const double ix, const double iy,
--- 126,139 ----
  						 double *ox, double *oy )
  
! * \brief  Convert ideal screen coordinates of a vertex to observed ones. 
  *
! * Ideal coordinates mean that the distortion of the camera is compensated (so a straight line looks straight). 
! * In observed coordinates the camera-distortion is not compensated and thus a straight line is not shown really straight.
! * \param dist_factor distorsion factors of used camera
! * \param ix x in ideal screen coordinates
! * \param iy y in ideal screen coordinates
! * \param ox resulted x in observed screen coordinates
! * \param oy resulted y in observed screen coordinates
! * \return 0 if success, -1 otherwise
  */
  int arParamIdeal2Observ( const double dist_factor[4], const double ix, const double iy,
***************
*** 142,154 ****
                           double *ix, double *iy )
  
! * \brief XXXBK
! *
! * XXXBK
! * \param dist_factor XXXBK
! * \param ox  XXXBK
! * \param oy XXXBK
! * \param ix XXXBK
! * \param iy XXXBK
! * \return  XXXBK
  */
  int arParamObserv2Ideal( const double dist_factor[4], const double ox, const double oy,
--- 143,156 ----
                           double *ix, double *iy )
  
! * \brief Convert observed screen coordinates of a vertex to ideal ones. 
! 
! * Ideal coordinates mean that the distortion of the camera is compensated (so a straight line looks straight).
! * In observed coordinates the camera-distortion is not compensated and thus a straight line is not shown really straight.
! * \param dist_factor distorsion factors of used camera
! * \param ox x in observed screen coordinates
! * \param oy y in observed screen coordinates
! * \param ix resulted x in ideal screen coordinates
! * \param iy resulted y in ideal screen coordinates
! * \return 0 if success, -1 otherwise
  */
  int arParamObserv2Ideal( const double dist_factor[4], const double ox, const double oy,
***************
*** 172,176 ****
  * Save manipulated camera intrinsic parameters in a file.
  * \param filename name of the parameters file.
! * \param num XXXBK
  * \param param parameters to save
  * \return 0 if success, -1 if Error (file not found, file structure problem)
--- 174,178 ----
  * Save manipulated camera intrinsic parameters in a file.
  * \param filename name of the parameters file.
! * \param num number of variable arguments
  * \param param parameters to save
  * \return 0 if success, -1 if Error (file not found, file structure problem)
***************
*** 184,188 ****
  * a file (itselft, a resulted output of calibration step). 
  * \param filename name of the parameters file.
! * \param num XXXBK
  * \param param result of the loaded parameters
  * \return 0 if success, -1 if Error (file not found, file structure problem)
--- 186,190 ----
  * a file (itselft, a resulted output of calibration step). 
  * \param filename name of the parameters file.
! * \param num number of variable arguments
  * \param param result of the loaded parameters
  * \return 0 if success, -1 if Error (file not found, file structure problem)

Index: ar.h
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/include/AR/ar.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** ar.h	22 Nov 2004 02:11:05 -0000	1.2
--- ar.h	25 Nov 2004 23:24:20 -0000	1.3
***************
*** 75,86 ****
  * \brief main structure for detected marker.
  *
  * \remark lines are represented by 3 values a,b,c for ax+by+c=0
! * \param area XXXBK
! * \param id marker identity number
! * \param dir XXXBK
! * \param cf confidence value
  * \param pos center of marker (in ideal screen coordinates)
  * \param line line equations for four side of the marker (in ideal screen coordinates)
! * \param vertex marker coordinates (in ideal screen coordinates)
  */
  typedef struct {
--- 75,87 ----
  * \brief main structure for detected marker.
  *
+ * Store information after contour detection (in idea screen coordinate, after distorsion compensated).
  * \remark lines are represented by 3 values a,b,c for ax+by+c=0
! * \param area number of pixels in the labeled region
! * \param id marker identitied number
! * \param dir Direction that tells about the rotation about the marker (possible values are 0, 1, 2 or 3). This parameter makes it possible to tell about the line order of the detected marker (so which line is the first one) and so find the first vertex. This is important to compute the transformation matrix in arGetTransMat().
! * \param cf confidence value (probability to be a marker)
  * \param pos center of marker (in ideal screen coordinates)
  * \param line line equations for four side of the marker (in ideal screen coordinates)
! * \param vertex edge points of the marker (in ideal screen coordinates)
  */
  typedef struct {
***************
*** 97,107 ****
  * \brief internal structure use for marker detection.
  * 
! * Store information after contour detection.
! * \param area XXXBK
! * \param pos center of marker (in ideal screen coordinates)
  * \param coord_num numer of pixels in the contour.
! * \param x_coord x coordinate of pixels of contour.
! * \param y_coord y coordinate of pixels of contour.
! * \param vertex marker coordinates (in ideal screen coordinates)
  * 
  */
--- 98,109 ----
  * \brief internal structure use for marker detection.
  * 
! * Store information after contour detection (in observed screen coordinate, before distorsion correction).
! * \param area number of pixels in the labeled region
! * \param pos position of the center of the marker (in observed screen coordinates)
  * \param coord_num numer of pixels in the contour.
! * \param x_coord x coordinate of the pixels of contours (size limited by AR_CHAIN_MAX).
! * \param y_coord y coordinate of the pixels of contours (size limited by AR_CHAIN_MAX).
! * \param vertex position of the vertices of the marker. (in observed screen coordinates)
! 		 rem:the first vertex is stored again as the 5th entry in the array  for convenience of drawing a line-strip easier.
  * 
  */
***************
*** 247,251 ****
  *                The pixel format depend of your architecture. Generally ABGR, but the images 
  *                are treated as a gray scale, so the order of BGR components does not matter. 
! *                However the ordering of the alpha component, A, is important.
  * \param thresh  specifies the threshold value (between 0-255) to be used to convert
  *                the input image into a binary image.
--- 249,253 ----
  *                The pixel format depend of your architecture. Generally ABGR, but the images 
  *                are treated as a gray scale, so the order of BGR components does not matter. 
! *                However the ordering of the alpha comp, A, is important.
  * \param thresh  specifies the threshold value (between 0-255) to be used to convert
  *                the input image into a binary image.

Index: matrix.h
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/include/AR/matrix.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** matrix.h	22 Nov 2004 02:11:05 -0000	1.2
--- matrix.h	25 Nov 2004 23:24:20 -0000	1.3
***************
*** 140,144 ****
  *
  * copy one matrix to another. The two ARMat must
! * be allocate
  * \param dest the destination matrix of the copy
  * \param source the original matrix source
--- 140,144 ----
  *
  * copy one matrix to another. The two ARMat must
! * be allocated.
  * \param dest the destination matrix of the copy
  * \param source the original matrix source
***************
*** 171,175 ****
  *
  * Allocates and initializes a matrix to a 
! * a unit matrix.
  * \param dim dimensions of the unit matrix (square)
  * \return the matrix allocated if success, NULL if error
--- 171,175 ----
  *
  * Allocates and initializes a matrix to a 
! * an identity matrix.
  * \param dim dimensions of the unit matrix (square)
  * \return the matrix allocated if success, NULL if error
***************
*** 187,191 ****
  * \param a first matrix
  * \param b second matrix
! * \return 0 if success, -1 if error
  */
  int    arMatrixMul(ARMat *dest, ARMat *a, ARMat *b);
--- 187,191 ----
  * \param a first matrix
  * \param b second matrix
! * \return 0 if success, -1 if error (multiplication impossible, or destination matrix have not comptabile size)
  */
  int    arMatrixMul(ARMat *dest, ARMat *a, ARMat *b);
***************
*** 211,215 ****
  * \param dest the destination matrix of the copy
  * \param source the source matrix
! * \return 0 if success, -1 if error
  */
  int    arMatrixTrans(ARMat *dest, ARMat *source);
--- 211,215 ----
  * \param dest the destination matrix of the copy
  * \param source the source matrix
! * \return 0 if success, -1 if error (source and destination matrix have different size)
  */
  int    arMatrixTrans(ARMat *dest, ARMat *source);
***************
*** 221,225 ****
  * allocate matrix (the source matrix is unmodified).
  * \param source the matrix to transpose
! * \return the allocated matrix if success, NULL if error
  */
  ARMat  *arMatrixAllocTrans(ARMat *source);
--- 221,225 ----
  * allocate matrix (the source matrix is unmodified).
  * \param source the matrix to transpose
! * \return the allocated matrix if success, NULL if error (creation or transposition impossible)
  */
  ARMat  *arMatrixAllocTrans(ARMat *source);
***************
*** 234,238 ****
  * \param dest result matrix of the inverse operation
  * \param source source matrix
! * \return 0 if success, -1 if error
  */
  int    arMatrixInv(ARMat *dest, ARMat *source);
--- 234,238 ----
  * \param dest result matrix of the inverse operation
  * \param source source matrix
! * \return 0 if success, -1 if error (not square matrix)
  */
  int    arMatrixInv(ARMat *dest, ARMat *source);
***************
*** 270,279 ****
  * \brief compute the PCA of a matrix.
  *
! * XXXBK
! * \param input XXXBK
! * \param evec XXXBK
! * \param ev XXXBK
! * \param mean XXXBK
! * \return XXXBK
  */
  int    arMatrixPCA( ARMat *input, ARMat *evec, ARVec *ev, ARVec *mean );
--- 270,279 ----
  * \brief compute the PCA of a matrix.
  *
! * Compute the Principal Component Analysis (PCA) of a matrix.
! * \param input source matrix
! * \param evec eigen vector computed
! * \param ev eigen value computed
! * \param mean mean computed
! * \return 0 if success to compute, -1 otherwise
  */
  int    arMatrixPCA( ARMat *input, ARMat *evec, ARVec *ev, ARVec *mean );
***************
*** 282,290 ****
  * \brief compute the PCA of a matrix.
  *
! * XXXBK
! * \param input XXXBK
! * \param evec XXXBK 
! * \param ev XXXBK
! * \return XXXBK
  */
  int    arMatrixPCA2( ARMat *input, ARMat *evec, ARVec *ev );
--- 282,290 ----
  * \brief compute the PCA of a matrix.
  *
! * Compute the Principal Component Analysis (PCA) of a matrix.
! * \param input source matrix
! * \param evec result matrix
! * \param ev egein value computed
! * \return 0 if success to compute, -1 otherwise
  */
  int    arMatrixPCA2( ARMat *input, ARMat *evec, ARVec *ev );
***************
*** 305,309 ****
  * Allocates and initializes new vector structure.
  * \param clm dimension of vector
! * \return the allocated vector, NULL if error
  */
  ARVec  *arVecAlloc( int clm );
--- 305,309 ----
  * Allocates and initializes new vector structure.
  * \param clm dimension of vector
! * \return the allocated vector, NULL if error (impossible allocation)
  */
  ARVec  *arVecAlloc( int clm );
***************
*** 313,317 ****
  *
  * Delete a vector structure (deallocate used memory).
! * \param v vector to delete
  * \return 0
  */
--- 313,317 ----
  *
  * Delete a vector structure (deallocate used memory).
! * \param v the vector to delete
  * \return 0
  */

[artoolkit-commits] artoolkit/include/AR ar.h,1.2,1.3 matrix.h,1.2,1.3 param.h,1.3,1.4

Optical marker tracking and overlay for augmented reality.

[artoolkit-commits] artoolkit/include/AR ar.h,1.2,1.3 matrix.h,1.2,1.3 param.h,1.3,1.4