Augmented reality in python made easy
Project description
augmented 🧚
augmented is a cross platform module used to do augmented reality using python
Requirements 🟥
- opencv-contrib-python
- Numpy
- requirements may vary on diffrent operating systems
instalation ⬇️
pip install augmented
Thats it 🌟
How to use ❓
Overlaying images 🖼️
initializing 🏁
import augmented
ar = augmented.ar_overlay(capture:int)#capture = camera number
ar.setup(targetImage: str, overlayImage: str, nfeatures: int, debug: bool=True, confidence: int=25, displayName: str="Augmented by sarang")
-
targetImage = Image to overlay on top of
-
overlayImage =Image to overlay
-
nfeatures = Features to detect on target image the bigger the more accurate and the more resource intensive 1000 recomended
Not required but can tweak the ones below 💻
-
debug = debug mode
-
confidence = How many feature matches to confirm
-
displayname = title name```
Overlaying
ar.start(display=bool)
- display = Enabling display output
Aruco scanning 📱
setup 🖱️
import augmented
arucoar = augmented.arucoar(cap:int=0)
imgAug = {0: 'assets/unnamed.jpg'}
arucoar.setup(imgAug: dict, markerSize: int = 6, totalMarkers: int = 250, debug: bool = True, cam: int = 0, displayName: str = 'Augmented by Sarang')
- imgAug = a dict containing the aruco id as value and the image(location) to display when the value is True
not neccessry but still can tweak 💻
-
Markersize, totalMarkers = aruco code properties
-
debug = to use debug mode
-
cam = camera number
-
displayName = tite of the display window
Scanning and overlaying 🖼️
arucoar.start(display=bool)
- display = wheather to display the output or not
recomended way of using is to put the code inside a loop 🌠
version - 2.1.0Stable
contributions are appreciated and will be credited in the package
Thank you
Happy augmenting
Updated setup.py for modern python versions
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file augmented-2.4.2.tar.gz.
File metadata
- Download URL: augmented-2.4.2.tar.gz
- Upload date:
- Size: 5.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e85d9a360edfbbb4bcc96960bf47c58b84e483bb0282a74f2dbd32e682cd3416
|
|
| MD5 |
4225128af7ce77d56a8d3b1df9a841ab
|
|
| BLAKE2b-256 |
ff84808d08403856aacf9604e1560921bfc6031865e6f0685fdc37104deccb85
|
File details
Details for the file augmented-2.4.2-py3-none-any.whl.
File metadata
- Download URL: augmented-2.4.2-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25afd961550f88d2afd0b61bb7a1b3ceab1d8a7afb26fb25dd2b3920c330a4a1
|
|
| MD5 |
d17a6efbf4555d5f3c24f618657abd13
|
|
| BLAKE2b-256 |
6924e54b19f233cc4831dd3140d0e4d81e00b78dcf8e7e73f84caaeadf1b7374
|