Documentation Doxygen

Code/KirbyTrack.c

@@ -1,3 +1,14 @@
+/**
+ * \file      KirbyTrack.c
+ * \author    Jacques / Antoine
+ * \date       avril - mai 2017
+ * \brief      Figure Imposé : Suivi d'un objet coloré.
+ *
+ * \details   Suivie d'un Kirby (Rose) ou d'une étoile (Jaune) par une caméra avec mode interface utilisateur ou configuration
+ *           
+ */
+
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <cv.h> 
@@ -6,7 +17,22 @@
 #include <SFML/Audio.hpp>
 #include <SFML/Graphics.hpp>
 #include <SFML/Window.hpp>
-
+/**
+ * \def SFML 
+ * \brief Programme en mode affichage interface utilisateur
+ * 
+ * \def CONFIG
+ * \brief Programme en mode configuration couleur
+ *
+ * \def KIRBY
+ * \brief Programme en mode suivi de Kirby (Objet rose)
+ * 
+ * \def ETOILE
+ * \brief Programme en mide suivi de l'étoile (Objet jaune)
+ * 
+ * \def JEU
+ * \brief Coefficient de tolérance pour le suivi d'objet
+ */
 //#define CONFIG
 #define SFML
 
@@ -19,18 +45,120 @@
 //ATTENTION SFML SUPPORTE UN NOMBRE LIMITE DE SPRITE EN FCT DU PC
 
 /*Headers*/
-void maj_angle(int vecX, int vecY, int rayon, double* angle); //Met à jour l'angle selon la distance CentreCamera - Cible
-int ajust_pos(int pos, int ref);
-void controle_moteur(double* angle);//Envoie les angles au moteur
+/**
+ * \fn void maj_angle(int vecX, int vecY, int rayon, double* angle)
+ * \brief Met à jour \a angle selon la distance entre le centre de la caméra et la cible, avec un tolérance circulaire définie par rayon
+ * \author Jacques
+ * \param vecX composante X de la cible par rapport au centre de l'image
+ * \param vecY composante Y de la cible par rapport au centre de l'image
+ * \param rayon tolérance avant changement d'angle
+ * \param angle tableau contenant les deux angles à modifier
+ */
+void maj_angle(int vecX, int vecY, int rayon, double* angle); //Met à jour l'angle selon la distance CentreCamera - Cible  
+
+/**
+ * \fn int ajust_pos(int pos, int ref) 
+ * \brief permet d'éviter des positions supérieures à ref considérées comme aberrantes.
+ * \details retourne 0 si la position est supérieure à ref.
+ * \author Jacques
+ * \param pos position à tester
+ * \param ref position de référence
+ * \return renvoie la position corrigée
+ */
+int ajust_pos(int pos, int ref); 
+
+/**
+ * \fn void controle_moteur(double* angle)
+ * \brief Fonction d'envoie des angles aux moteurs
+ * \details 
+ * \author Jacques
+ * \param angle tableau des angles moteurs
+ */
+void controle_moteur(double* angle);//Envoie les angles au moteur 
+
+/**
+ * \fn int limite_moteur(int val_pwm)
+ * \brief Fonction qui vérifie que les valeurs envoyees aux moteurs sont correctes
+ * \details Valeur minimale = 30, valeur maximale = 130 (déterminées expérimentalement)
+ * \author Jacques
+ * \param val_pwm valeur pwm dont on veut vérifier la valeur
+ * \return renvoie l'angle corrigée
+ */
 int limite_moteur(int val_pwm);//Verifie que les valeurs envoyees aux moteurs sont correctes
 
+/**
+ * \fn void config(int* LowH, int* HighH, int* LowS, int* HighS, int* LowV, int* HighV)
+ * \brief Fonction d'affichage du panneau de configuration de la \a couleur à suivre
+ * \author Antoine
+ * \details Panneau de configuration comprenant 6 slidebarres pour configurer la couleur suivie en HSV. La fonction modifie les valeurs limites LowH/   
+ * HighH de la plage HUE, LowS/HighS de la plage SATURATION, LowV/HighV de la plage VALUE.
+
+ * \param LowH Valeur \a basse de la plage de HUE suivie. 
+ * \param HighH Valeur \a haute de la plage de HUE suivie.
+ * \param LowS Valeur \a basse de la plage de SATURATION suivie.
+ * \param HighS Valeur \a haute de la plage de SATURATION suivie.
+ * \param LowV Valeur \a basse de la plage de VALUE suivie.
+ * \param HighV Valeur \a haute de la plage de VALUE suivie.
+ */
 void config(int* LowH, int* HighH, int* LowS, int* HighS, int* LowV, int* HighV); //Affiche le panneau de configuration de tracking avec les arguments comme valeur de base
+
+/**
+ * \fn void affichage_config(IplImage* frame, IplImage* HSV, IplImage* Binaire);
+ * \brief Fonction d'affichage du flux vidéo, du flux en HSV et de sa binarisation
+ * \author Antoine
+ * \param frame image contenant la frame capturé par la caméra
+ * \param HSV image contenant l'image passé en HSV
+ * \param Binaire image contenant l'image binarisée
+ */
 void affichage_config(IplImage* frame, IplImage* HSV, IplImage* Binaire); //Affiche le flux vidéos et ses différent traitements
+
+/**
+ * \fn void Affichage_Tracking(IplImage* frame, int posX, int posY, int width, int height)
+ * \brief Fonction d'affichage des informations de suivi
+ * \details Dessine sur \a frame la zone de tolérance de suivie au centre de l'image et le curseur de position de l'objet ayant pour coordonées \a posX et \a posY
+
+ * \author Antoine
+ * \param frame image a modifier
+ * \param posX composante X du curseur a dessiner
+ * \param posY composante Y du curseur a dessiner
+ * \param width largeur (en \a pixel) de \a frame
+ * \param height hauteur (en \a pixel) de \a frame
+ */
 void Affichage_Tracking(IplImage* frame, int posX, int posY, int width, int height); //Dessine les informations de tracking sur frame
 
+/**
+ * \fn void Position_moy(IplImage* Binaire, int* posX, int * posY)
+ * \brief Effectue le baricentre des pixels d'une image binaire pour obtenir la postion de l'objet
+ * \author Antoine
+ * \param Binaire image binarisée (matrice de 0 ou de 1)
+ * \param posX contient la composante X du barycentre
+ * \param posY contient la composante Y du barycentre
+ */
 void Position_moy(IplImage* Binaire, int* posX, int * posY); //Effectue le baricentre des pixels d'une image binaire pour obtenir la postion de l'objet
+
+/**
+ * \fn void traitement(IplImage* frame, IplImage* HSV, IplImage* Binaire, int LowH, int HighH, int LowS, int HighS, int LowV, int HighV)
+ * \brief Effectue une binarisation de \a frame en fonction des bornes \a HSV
+ * \details Passe la frame en HSV puis binarise l'image en fonction des bornes LowH, HighH, LowS, HighS, LowV, HighV
+ * \author Antoine
+ * \param frame image contenant la frame capturé par la caméra
+ * \param HSV image contenant l'image passé en HSV au terme de la fonction
+ * \param Binaire image contenant l'image binarisée au terme de la fonction
+ * \param LowH Valeur \a basse de la plage de HUE suivie. 
+ * \param HighH Valeur \a haute de la plage de HUE suivie.
+ * \param LowS Valeur \a basse de la plage de SATURATION suivie.
+ * \param HighS Valeur \a haute de la plage de SATURATION suivie.
+ * \param LowV Valeur \a basse de la plage de VALUE suivie.
+ * \param HighV Valeur \a haute de la plage de VALUE suivie.
+ */
 void traitement(IplImage* frame, IplImage* HSV, IplImage* Binaire, int LowH, int HighH, int LowS, int HighS, int LowV, int HighV); //Effectue une binarisation de frame en fonction des bornes HSV
 
+/**
+ * \fn int main(int argc, char* argv[])
+ * \brief Entrée du programme
+ * \author Antoine / Jacques
+ * \return EXIT_SUCCESS : Arrêt normal du programme, EXIT_FAILURE : Le programme a rencontrée une erreur au cours de son execution
+ */
 int main(int argc, char* argv[])
 {
 	//Initialisations