Skip to main content

Augmented reality in python made easy

Project description

augmented

Ar python 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

Not required but can tweak the ones below

  • nfeatures = Features to detect on target image the bigger the more accurate and the more resource intensive 1000 recomended

  • 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

First release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

augmented-2.4.1.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

augmented-2.4.1-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file augmented-2.4.1.tar.gz.

File metadata

  • Download URL: augmented-2.4.1.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.6.9

File hashes

Hashes for augmented-2.4.1.tar.gz
Algorithm Hash digest
SHA256 57f9a13a3a0f824ee4b738bdf44055280f1cc36e7903e7df0ce953ba5ae836e6
MD5 adc5c24394eb76272332d73a6b96d9b7
BLAKE2b-256 0994cec2629573c50701a722603fecdc2eddf540d3eec65641f846360cee89cf

See more details on using hashes here.

File details

Details for the file augmented-2.4.1-py3-none-any.whl.

File metadata

  • Download URL: augmented-2.4.1-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.6.9

File hashes

Hashes for augmented-2.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 61cf47c17e3d557c1819ff8d5334deb727ec36e10863cef2b14966f554f31d70
MD5 7da665c9c75cb8e3afdec045c4f28d1a
BLAKE2b-256 d62ea8beacbe98df63e5002f64bffe69e66bbce7e23f16b366606064a7f9a981

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page