Skip to content
Snippets Groups Projects
Commit 04dc3562 authored by Quentin Bolsee's avatar Quentin Bolsee
Browse files

guide

parent 83de3c9c
No related branches found
No related tags found
No related merge requests found
# Aruco Frame
## Installation
Steps:
- Clone or download this project, and place the folder somewhere
- Install python>3.8 ([link](https://www.python.org/downloads/))
- Add python to your system's path ([guide](https://realpython.com/add-python-to-path/))
- Open a terminal and navigate to the project's folder
- Install dependencies:
```
python -m pip install -r requirements.txt
```
- Test:
```
python aruco-frame.py -i example/raspi.jpg
```
## Usage
### Process an image:
```
python aruco-frame.py -i <FILENAME_IN>
```
If the output path is not specified with a `-o <FILENAME_OUT>` argument, the result is saved as `<FILENAME_IN>_<DPI>_DPI.png`.
## User manual
```
usage: aruco-frame.py [-h] [-i INPUT] [-o OUTPUT] [-d DPI] [-s] [-c CONFIG] [-v]
Usage: python aruco-frame.py [options]
Extracts the image from an image containing an aruco frame
options:
-h, --help show this help message and exit
-i INPUT, --input INPUT
Input filename.
-o OUTPUT, --output OUTPUT
Output filename (default: <filename_in>_extracted.png).
Output filename (default: <filename_in>_<DPI>_DPI.png).
-d DPI, --dpi DPI Manual output DPI (default: auto).
-s, --show Show debug image.
-c CONFIG, --config CONFIG
......
......@@ -13,7 +13,7 @@ import solve_lens
def parse_arguments():
usage_text = (
"Usage: python aruco-frame.py [options]"
"Extracts the image from an image containing an aruco frame"
)
parser = argparse.ArgumentParser(description=usage_text)
parser.add_argument("-i", "--input", type=str,
......
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment