-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,30 @@ | ||
|
||
# Computer Vision Ring Fault Detection Algorithm | ||
A computer vision algorithm for fault detection to determine whether or not a fault exists within a ring using raw image input and no external libraries such as OpenCV. | ||
|
||
# Requirements | ||
The following Python packages are required before using: | ||
* OpenCV: https://pypi.org/project/opencv-python/ | ||
* NumPy: https://pypi.org/project/numpy/ | ||
* matplotlib: https://pypi.org/project/matplotlib/ | ||
|
||
All dependencies can be installed with the following command using `pip` in a shell terminal: | ||
``` | ||
$ pip install opencv-python numpy matplotlib | ||
``` | ||
|
||
# Usage | ||
The application takes images from the input directory, parses them using the detection algorithm and outputs the given results to the command line, and also to an optional output directory that includes the total execution time, fault state, and histogram of the image itself. | ||
|
||
## Image Input | ||
The input images that need to be assessed should be placed in the [`ring_input`](./ring_input) directory, images should be grey-scaled such that the ring itself is black on a plain white background for best results. | ||
|
||
## Starting The Process | ||
The process can be started by executing the main [`detection.py`](./detection.py) program, with optional additional parameters: | ||
``` | ||
$ python detection.py | ||
``` | ||
|
||
__**Options**__ | ||
* `-t` Prevent verbose image output for every image that is processed. | ||
* `-d` Enable a more detailed output for each image that is processed, includes additional data such as ring boundary values. |