Few docs adjustments

Author: danielkonecny

README.md

@@ -1,6 +1,19 @@
-# How to launch
+# Image Grabber
+Image Grabber allows you to capture images (JPG) or video (AVI) with multiple Basler USB Cameras at once. It logs all 
+captured data to a CSV file for later use.
 
+## How to launch
 In the project root folder:
-1. cmake .
-2. make
-3. ./ImageGrabber
+1. Build and compile: `make`.
+2. Run with help: `./ImageGrabber -h`.
+3. Run with the arguments according to help: `./ImageGrabber ...`.
+4. Exit the app with `Ctrl+C`.
+
+## Arguments
+* `-f` (`--framerate`) - Set framerate (fps) of recording (default: 25).
+* `-h` (`--help`) - Show help.
+* `-i` (`--image`) - Save images instead of video. Optional argument setting the image quality. Quality has to be 
+  between 0 and 100, the higher is the better (default: 95).
+* `-o` (`--output`) - Set folder for video/image and log output (default: out). This folder has to contain folders: 
+  img, log, vid.
+* `-v` (`--verbose`) - Print information about the camera state.

src/ArgumentsParser.cpp

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            ArgumentsParser.cpp
- * @version         1.0
+ * @version         2.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            03. 04. 2021
+ * @date            27. 04. 2021
  */
 
 
@@ -42,14 +42,14 @@ long long ArgumentsParser::LoadNumber(char *numberAsChars) {
 
 void ArgumentsParser::PrintHelp() {
     cout << "IMAGE GRABBER" << endl <<
-         "-f (framerate)     Set framerate (fps) of recording (default: " << DEFAULT_FRAME_RATE << ")." << endl <<
-         "-h (help)          Show help." << endl <<
-         "-i (image)         Save images instead of video. Optional argument setting the image quality." << endl <<
-         "                   Quality has to be between 0 and 100, the higher is the better (default: " <<
+         "-f (--framerate)  Set framerate (fps) of recording (default: " << DEFAULT_FRAME_RATE << ")." << endl <<
+         "-h (--help)       Show help." << endl <<
+         "-i (--image)      Save images instead of video. Optional argument setting the image quality." << endl <<
+         "                  Quality has to be between 0 and 100, the higher is the better (default: " <<
          DEFAULT_IMG_QUALITY << ")." << endl <<
-         "-o (output)        Set folder for video/image and log output (default: " << DEFAULT_OUT_DIR << ")." << endl <<
-         "                   This folder has to contain folders: img, log, vid." << endl <<
-         "-v (verbose)       Print information about the camera state." << endl;
+         "-o (--output)     Set folder for video/image and log output (default: " << DEFAULT_OUT_DIR << ")." << endl <<
+         "                  This folder has to contain folders: img, log, vid." << endl <<
+         "-v (--verbose)    Print information about the camera state." << endl;
 }
 
 bool ArgumentsParser::ProcessArguments(int argc, char *argv[]) {

src/ArgumentsParser.h

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            ArgumentsParser.h
- * @version         1.0
+ * @version         2.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            03. 04. 2021
+ * @date            27. 04. 2021
  */
 
 using namespace std;

src/ImageEventHandler.cpp

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            ImageEventHandler.cpp
- * @version         1.0
+ * @version         2.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            02. 04. 2021
+ * @date            27. 04. 2021
  */
 
 #include <iostream>
@@ -130,7 +130,7 @@ void ImageEventHandler::OnImageGrabbed(
             imwrite(imgNameString, imgMat, vector<int>({IMWRITE_JPEG_QUALITY, imgQuality}));
 
             timestampFile << "\"img\"," << cameraSerialNum << ",\"" << imgNameString << "\","
-                          << timestamp << ",\"" << datetimeString << "\"\n";
+                          << timestamp << ",\"" << datetimeString << "\"" << endl;
         } else {
             vidOutput.write(imgMat);
 
@@ -140,9 +140,8 @@ void ImageEventHandler::OnImageGrabbed(
             string vidNameString = vidNameStream.str();
 
             timestampFile << "\"vid\"," << cameraSerialNum << ",\"" << vidNameString << "\","
-                          << timestamp << ",\"" << datetimeString << "\"\n";
+                          << timestamp << ",\"" << datetimeString << "\"" << endl;
         }
-        timestampFile.flush();
 
         if (verbose) {
             cout << "Camera " << cameraSerialNum << " grabbed image at " <<

src/ImageEventHandler.h

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            ImageEventHandler.h
- * @version         1.0
+ * @version         2.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            02. 04. 2021
+ * @date            27. 04. 2021
  */
 
 #include <iostream>

src/ImageGrabber.cpp

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            ImageGrabber.cpp
- * @version         2.0
+ * @version         3.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            03. 04. 2021
+ * @date            27. 04. 2021
  */
 
 #include <iostream>

src/ImageGrabber.h

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            ImageGrabber.h
- * @version         1.0
+ * @version         3.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            02. 04. 2021
+ * @date            27. 04. 2021
  */
 
 #include <iostream>

src/main.cpp

@@ -2,10 +2,10 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            main.cpp
- * @version         2.0
+ * @version         3.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
- * @date            03. 04. 2021
+ * @date            27. 04. 2021
  */
 
 #include <iostream>

src/main.h

@@ -2,7 +2,7 @@
  * Image Grabber
  * Application for grabbing images from Basler cameras using Pylon API.
  * @file            main.h
- * @version         1.0
+ * @version         3.0
  * @author          Daniel Konecny (xkonec75)
  * @organisation    Brno University of Technology - Faculty of Information Technologies
  * @date            02. 04. 2021