Commit c0cf1df9 authored by Matteo Spanio's avatar Matteo Spanio
Browse files

update documentation and config file

parent 6c938233
{
"WorkingPath": "/home/matteo/Scrivania/Projects/workflow/data",
"WorkingPath": "/data",
"FilesName": "BERIO100.mov",
"Brands": true,
"Speed": 7.5,
......
# Documentation
>
\ No newline at end of file
......@@ -60,12 +60,12 @@ or just run `make build` from the root folder.
A Dockerfile is provided to build a Docker image with the *Video Analyser*.
To build the image, run the following command from the root folder:
```
docker build -t mpai-video-analyser .
docker build -t mpai-video-analyzer .
```
To run the container, run the following command:
```
docker run -it --rm -v /path/to/video/analyser:/app mpai-video-analyser /bin/bash
docker run -it --rm -v /path/to/video/analyser:/app mpai-video-analyzer -v /path/to/your/data:/data /bin/bash
```
where `/path/to/video/analyser` is the path to the *Video Analyser* folder.
......
......@@ -125,10 +125,13 @@ namespace utility {
*
*/
struct Threshold {
float percentual;
int angle;
int scale;
int pos;
/**
*
*/
float percentual; /**< The minimum percentage of different pixels for considering the current frame under the ROI as a potential Irregularity */
int angle; /**< The angle votes threshold for the detection of the object */
int scale; /**< The scale votes threshold for the detection of the object */
int pos; /**< The position votes threshold for the detection of the object */
};
/**
......@@ -143,14 +146,23 @@ enum Object {
/**
* @struct SceneObject
* @brief Struct containing the information about a scene object.
*
* @brief A scene object is an object that can be detected in a scene, such as a tape or a capstan.
*
*/
struct SceneObject {
int minDist;
Threshold threshold;
int minDist; /**< The minimum distance between the centers of the detected objects for the detection of the reading head */
Threshold threshold; /**< the threshold values used to detect the object */
SceneObject(int minDist, Threshold threshold);
~SceneObject() = default;
/**
* @fn static SceneObject from_file(fs::path path, Object obj)
* @brief Create a SceneObject from a given file.
*
* @param path The path of the file containing the object.
* @note The file must be a JSON file.
* @param obj The object to detect.
* @return SceneObject The SceneObject created from the file.
*/
static SceneObject from_file(fs::path path, Object obj);
};
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment