Metadata-Version: 2.1
Name: RCJRVision
Version: 1.5
Summary: A fast and simple image processing method to detect H S U victims in rescue maze
Home-page: https://github.com/mhmmdshirazi/RCJRVision
Author: Mohammad Mahdi Shirazi
Author-email: mhmmdshirazi@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown
Requires-Dist: opencv-python (>=4.1.2.0)
Requires-Dist: opencv-python-headless (>=4.2.0)
Requires-Dist: numpy (>=1.9.0)

# RCJRVision (Robocup Junior Rescue Vision)
# Table of Contents
1. [Overview](#Overview)
2. [Instalation](#Installation)
3. [Usage](#Usage)
4. [Dependencies](#Dependencies)


## Overview
RCJRVision is a fast and simple method for **Robocup** Junior rescue maze and Robocup Junior Rescue simulation leagues
to Detect H, S, and U Letters in an image.
This package converts raw image to a solid black and white image, finds contours in the picture, chooses the most proper
contour, and finally check it with pre defined letter contours to find the best match.


## Instalation

## Usage
#### Use with predefined contours
1. Import **RCJRVision**

2. Make an object from HSUVision Class

`my_vision = RCJRVision.HSUVision()`

3. Convert your image to an opencv image

4. Use find_HSU method

`letter, center = my_test_vision.find_HSU(img)`

This method returns two variables:

- letter:

    >Key of the predefined contour dictionary.
    In this case: 'H' or 'S' or 'U'
- center: 

    >A 2 element list that represent the center of discover contour
## Dependencies
Click on the link below to see dependencies and their status:

[![Requirements Status](https://requires.io/github/mhmmdshirazi/RCJRVision/requirements.svg?branch=master)](https://requires.io/github/mhmmdshirazi/RCJRVision/requirements/?branch=master)

