From d57ab82f3877091f3bc141d96b0936c5bd4d9aee Mon Sep 17 00:00:00 2001 From: Alexey Rogachevskiy Date: Wed, 6 May 2020 15:03:39 +0300 Subject: [PATCH] docs: Fix up according to MD037 --- docs/en/camera_calib.md | 30 +++++++++++++++--------------- docs/ru/bigchallenges.md | 2 +- docs/ru/camera_calib.md | 38 +++++++++++++++++++------------------- 3 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/en/camera_calib.md b/docs/en/camera_calib.md index 20aefe46..95ae8470 100644 --- a/docs/en/camera_calib.md +++ b/docs/en/camera_calib.md @@ -57,7 +57,7 @@ Turn on Clover and connect to its Wi-Fi. ## Calibration -Run script **_calibrate_cam_**: +Run script ***calibrate_cam***: **Windows:** @@ -97,7 +97,7 @@ To calibrate the camera, make at least 25 photos of the chessboard at various an ![img](../assets/calibration.jpg) -To make a photo, enter command **_catch_**. +To make a photo, enter command ***catch***. ```(bash) >catch @@ -113,9 +113,9 @@ Chessboard not found, now 0 (25 required) Image added, now 1 (25 required) ``` -> Instead of entering command **_catch_** each time, you can just press **_Enter_** (enter a blank line). +> Instead of entering command ***catch*** each time, you can just press ***Enter*** (enter a blank line). -After you have made a sufficient number of images, enter command **_finish_**. +After you have made a sufficient number of images, enter command ***finish***. ```(bash) ... @@ -125,7 +125,7 @@ Calibration successful! ### Calibration by the existing images -If you already have images, you can calibrate the camera by them with the help of script **_calibrate_cam_ex_**. +If you already have images, you can calibrate the camera by them with the help of script ***calibrate_cam_ex***. ```(bash) >calibrate_cam_ex @@ -141,22 +141,22 @@ Square size: # Length of cell edge (mm) Path: # Path to the folder with images ``` -Apart from that, this script works similarly to **_calibrate_cam_**. +Apart from that, this script works similarly to ***calibrate_cam***. -The program will process all received pictures, and create file **_camera_info_****_._****_yaml_** in the current folder. Using this file, you can equalize distortions in the images obtained from this camera. +The program will process all received pictures, and create file ***camera_info.yaml*** in the current folder. Using this file, you can equalize distortions in the images obtained from this camera. > If you change the resolution of the received image, you will have to re-calibrate the camera. ## Correcting distortions -Function **_get_undistorted_image(cv2_image, camera_info)_** is responsible for obtaining a corrected image: +Function ***get_undistorted_image(cv2_image, camera_info)*** is responsible for obtaining a corrected image: -* **_cv2_image_**: An image encoded into a cv2 array. -* **_camera_****___****_info_**: The path to the calibration file.¬ +* ***cv2_image***: An image encoded into a cv2 array. +* ***camera_info***: The path to the calibration file.¬ The function returns a cv2 array, into which the corrected image is coded. -> If you are using a fisheye camera provided with Clover, for processing images with resolution 320x240 or 640x480, you can use the existing calibration settings. To do this, pass parameters **_clever_cam_calibration.clevercamcalib.CLEVER_FISHEYE_CAM_320_** or **_clever_cam_calibration.clevercamcalib.CLEVER_FISHEYE_CAM_640_** as argument **_camera_info_**, respectively. +> If you are using a fisheye camera provided with Clover, for processing images with resolution 320x240 or 640x480, you can use the existing calibration settings. To do this, pass parameters ***clever_cam_calibration.clevercamcalib.CLEVER_FISHEYE_CAM_320*** or ***clever_cam_calibration.clevercamcalib.CLEVER_FISHEYE_CAM_640*** as argument ***camera_info***, respectively. ## Examples of operation @@ -203,11 +203,11 @@ The SFTP protocol is used for transferring the file. This example, WinSCP progra Connect to Raspberry Pi via SFTP: -> Password: _**raspberry**_ +> Password: ***raspberry*** ![img](../assets/wcp1.png) -Press “Enter”. Go to _**/home/pi/catkin_ws/src/clever/clever/camera_info/**_, and copy the calibration .yaml file to this folder: +Press “Enter”. Go to ***/home/pi/catkin_ws/src/clever/clever/camera_info/***, and copy the calibration .yaml file to this folder: ![img](../assets/wcp2.jpg) @@ -217,11 +217,11 @@ Connect to Raspberry Pi via SSH: ![img](../assets/pty1.jpg) -Log in with username _**pi**_ and password _**raspberry**_, go to directory _**/home/pi/catkin_ws/src/clever/clever/launch**_ and start editing configuration _**main_camera.launch**_: +Log in with username ***pi*** and password ***raspberry***, go to directory ***/home/pi/catkin_ws/src/clever/clever/launch*** and start editing configuration ***main_camera.launch***: ![img](../assets/pty2.jpg) -In line _**camera node**_, change parameter _**camera_info**_ to _**camera_info.yaml**_: +In line ***camera node***, change parameter ***camera_info*** to ***camera_info.yaml***: ![img](../assets/pty3.jpg) diff --git a/docs/ru/bigchallenges.md b/docs/ru/bigchallenges.md index ba2feea3..edcfecdc 100644 --- a/docs/ru/bigchallenges.md +++ b/docs/ru/bigchallenges.md @@ -243,4 +243,4 @@ python main.py Где - **dist** - Дистанция в метрах -- **cost** - Цена в рублях (150₽ + 30₽ * *n* метров) +- **cost** - Цена в рублях (150₽ + 30₽ × *n* метров) diff --git a/docs/ru/camera_calib.md b/docs/ru/camera_calib.md index db5b3a87..dcd0b6da 100644 --- a/docs/ru/camera_calib.md +++ b/docs/ru/camera_calib.md @@ -54,11 +54,11 @@ sudo python setup.py install > Порт можно настроить в файле _ccc_server/config.py_. -На открытой странице необходимо ввести параметры калибровочной мишени: количество перекрестий в длину и ширину, длину ребра квадрата. Для начала калибровки нажмите кнопку **_Start Calibration_**. +На открытой странице необходимо ввести параметры калибровочной мишени: количество перекрестий в длину и ширину, длину ребра квадрата. Для начала калибровки нажмите кнопку ***Start Calibration***. ![asd](../assets/cam_calib1.png) -На следующей странице при помощи кнопки **_Catch photo_** можно делать фотографии калибровочной мишени. +На следующей странице при помощи кнопки ***Catch photo*** можно делать фотографии калибровочной мишени. ![asd](../assets/cam_calib2.png) @@ -66,11 +66,11 @@ sudo python setup.py install ![asd](../assets/cam_calib3.png) -Если перекрестия были распознаныы правильно, нажмите на клавишу **_Add_**, и перейдите к получению новых фотографий. В противном же случае, ели перекристия были распознаны некорректно, пропустите данную фотографию при помощи клавиши **_Skip_**. +Если перекрестия были распознаныы правильно, нажмите на клавишу ***Add***, и перейдите к получению новых фотографий. В противном же случае, если перекрестия были распознаны некорректно, пропустите данную фотографию при помощи клавиши ***Skip***. >В большинстве случаев найденные углы будут подсвечиваться разными цветами, но иногда подсветка будет становиться красной. это происходит в том случае, если углы распознаны, но неточно. -Чтобы откалибровать камеру, вам требуется сделать как минимум 25 фото шахматной доски с различных ракурсов. После преодоления данного порога появится кнопка **_Finish_**, по нажатию на которую начнется генерация калибровочного файла. +Чтобы откалибровать камеру, вам требуется сделать как минимум 25 фото шахматной доски с различных ракурсов. После преодоления данного порога появится кнопка ***Finish***, по нажатию на которую начнется генерация калибровочного файла. >Это может занять некоторое время. @@ -79,7 +79,7 @@ sudo python setup.py install ![asd](../assets/cam_calib4.png) -Программа обработает все полученные фотографии, и создаст **_.yaml_** файл в нынешней директории. При помощи этого файла можно будет выравнивать искажения на изображениях, полученных с этой камеры. +Программа обработает все полученные фотографии, и создаст ***.yaml*** файл в нынешней директории. При помощи этого файла можно будет выравнивать искажения на изображениях, полученных с этой камеры. > Если вы поменяете разрешение получаемого изображения, вам нужно будет снова калибровать камеру. @@ -87,7 +87,7 @@ sudo python setup.py install Также вы можете воспользоваться предыдущей версией программы, не имеющей web-интерфейса. -Запустите скрипт **_calibrate_cam_**: +Запустите скрипт ***calibrate_cam***: ```bash >calibrate_cam @@ -115,7 +115,7 @@ help, catch (key: Enter), delete, restart, stop, finish Чтобы откалибровать камеру, вам требуется сделать как минимум 25 фото шахматной доски с различных ракурсов. -Чтобы сделать фото, введите команду **_catch_**. +Чтобы сделать фото, введите команду ***catch***. ```bash >catch @@ -131,9 +131,9 @@ Chessboard not found, now 0 (25 required) Image added, now 1 (25 required) ``` -> Вместо того, чтобы каждый раз вводить команду **_catch_**, Вы можете просто нажимать клавишу **_Enter_** (вводить пустую строку). +> Вместо того, чтобы каждый раз вводить команду ***catch***, Вы можете просто нажимать клавишу ***Enter*** (вводить пустую строку). -После того, как будет набрано достаточное количество изображений, введите команду **_finish_**. +После того, как будет набрано достаточное количество изображений, введите команду ***finish***. ```bash ... @@ -143,7 +143,7 @@ Calibration successful! **Калибровка по существующим изображениям:** -Если же у вас уже есть изображения, то вы можете откалибровать камеру по ним при помощи скрипта **_calibrate_from_dir_**. +Если же у вас уже есть изображения, то вы можете откалибровать камеру по ним при помощи скрипта ***calibrate_from_dir***. ```bash >calibrate_from_dir @@ -159,21 +159,21 @@ Square size: # Длина ребра клетки (в мм) Path: # Путь до папки с изображениями ``` -В остальном этот скрипт работает аналогично **_calibrate_cam_**. +В остальном этот скрипт работает аналогично ***calibrate_cam***. -Программа обработает все полученные фотографии, и создаст файл **_camera_info_****_._****_yaml_** в нынешней директории. При помощи этого файла можно будет выравнивать искажения на изображениях, полученных с этой камеры. +Программа обработает все полученные фотографии, и создаст файл ***camera_info.yaml*** в нынешней директории. При помощи этого файла можно будет выравнивать искажения на изображениях, полученных с этой камеры. ## Исправление искажений За получение исправленного изображения отвечает функция **clever_cam_calibration._get_undistorted_image(cv2_image, camera_info)_**: -* **_cv2_image_**: Закодированное в массив cv2 изображение. -* **_camera_****_­__****_info_**: Путь до файла калибровки. +* ***cv2_image***: Закодированное в массив cv2 изображение. +* ***camera_info***: Путь до файла калибровки. Функция возвращает массив cv2, в котором закодировано исправленное изображение. -> Если вы используете fisheye-камеру, поставляемую вместе с Клевером, то для обработки изображений разрешением 320x240 или 640x480 вы можете использовать уже существующие параметры калибровки. Для этого в качестве аргумента **_camera_info_** передайте параметры **_clever_cam_calibration.CLEVER_FISHEYE_CAM_320_** или **_clever_cam_calibration.CLEVER_FISHEYE_CAM_640_** соответственно. +> Если вы используете fisheye-камеру, поставляемую вместе с Клевером, то для обработки изображений разрешением 320x240 или 640x480 вы можете использовать уже существующие параметры калибровки. Для этого в качестве аргумента ***camera_info*** передайте параметры ***clever_cam_calibration.CLEVER_FISHEYE_CAM_320*** или ***clever_cam_calibration.CLEVER_FISHEYE_CAM_640*** соответственно. ## Примеры работы @@ -220,11 +220,11 @@ cv2.destroyAllWindows() Подключимся к Raspberry Pi по SFTP: -> Пароль: _**raspberry**_ +> Пароль: ***raspberry*** ![img](../assets/wcp1.png) -Нажимаем “Войти”. Переходим в _**/home/pi/catkin_ws/src/clever/clever/camera_info/**_ и копируем туда калибровочный .yaml файл: +Нажимаем “Войти”. Переходим в ***/home/pi/catkin_ws/src/clever/clever/camera_info/*** и копируем туда калибровочный .yaml файл: ![img](../assets/wcp2.jpg) @@ -234,11 +234,11 @@ cv2.destroyAllWindows() ![img](../assets/pty1.jpg) -Войдем под логином _**pi**_ и паролем _**raspberry**_, перейдем в директорию _**/home/pi/catkin_ws/src/clever/clever/launch**_ и начнем редактировать конфигурацию _**main_camera.launch**_: +Войдем под логином ***pi*** и паролем ***raspberry***, перейдем в директорию ***/home/pi/catkin_ws/src/clever/clever/launch*** и начнем редактировать конфигурацию ***main_camera.launch***: ![img](../assets/pty2.jpg) -В строке _**camera node**_ заменим параметр _**camera_info**_ на _**camera_info.yaml**_: +В строке ***camera node*** заменим параметр ***camera_info*** на ***camera_info.yaml***: ![img](../assets/pty3.jpg)