Skip to main content

High-performance MindAR implementation for real-time image recognition on edge devices. Developed by FANSEE LAB.

Project description

MindAR Python

High-performance MindAR implementation for real-time image recognition on edge devices.

Features

  • MindAR Compatible: Full compatibility with MindAR .mind file format
  • High Performance: Optimized with numba JIT compilation for edge devices
  • Real-time Detection: Efficient feature detection and matching
  • Modern Architecture: Clean configuration-based API with dataclasses
  • Type Safe: Full type hints and proper error handling
  • Production Ready: Comprehensive testing and linting (pylint score 7.5+)

Installation

From PyPI (Recommended)

pip install mindar

From Source

git clone https://github.com/FANSEE-LAB/mind-ar.git
cd mind-ar
pip install -e .

Requirements

  • Python >= 3.9 (required for numba optimization)
  • OpenCV
  • NumPy
  • msgpack (for .mind file format)
  • numba (for performance optimization)

Usage

Basic Detection

import cv2
from mindar import Detector, Matcher, MindARCompiler
from mindar.types import DetectorConfig, MatcherConfig

# Configure detector with new configuration system
detector_config = DetectorConfig(
    method="super_hybrid",
    max_features=1000,
    debug_mode=False
)
detector = Detector(detector_config)

# Configure matcher
matcher_config = MatcherConfig(
    ratio_threshold=0.75,
    min_matches=8,
    debug_mode=False
)
matcher = Matcher(matcher_config)

# Detect features in image
image = cv2.imread("target.jpg", cv2.IMREAD_GRAYSCALE)
result = detector.detect(image)
feature_points = result["feature_points"]

print(f"Detected {len(feature_points)} features")

Compile .mind Files

from mindar.compiler import MindARCompiler

# Initialize compiler with debug mode
compiler = MindARCompiler(debug_mode=True)

# Compile images to .mind file
success = compiler.compile_directory("./images", "./targets.mind")
if success:
    print("✅ Compilation successful")

# Load compiled targets
mind_data = compiler.load_mind_file("./targets.mind")
print(f"Loaded {len(mind_data['dataList'])} targets")

Performance

Optimized for edge devices like Raspberry Pi 4:

  • Detection: ~50ms per frame (640x480)
  • Matching: ~20ms per target
  • Memory: <100MB usage

License

MIT License - Compatible with original MindAR project

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

mindar-0.1.3.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mindar-0.1.3-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file mindar-0.1.3.tar.gz.

File metadata

  • Download URL: mindar-0.1.3.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for mindar-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d230bfa4f94ef080c334cd0b318ef5fa066c3bc3335904c02ebc67662125126d
MD5 c4b3af2115e3a034688e100886afc403
BLAKE2b-256 c88979c30bb17e9697e05cc7ca2e63bcf533049f15bddf6d446dc73b53ff4d0c

See more details on using hashes here.

File details

Details for the file mindar-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: mindar-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for mindar-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6f6ef87f040f2e7e97287c9a84dffed544293c6dee49d633f4b7be8ee5c34d06
MD5 6c8c3a3a7413bc7af3dadbcef8cc2921
BLAKE2b-256 06335918de6524e92c6a85cabe45d58b7affddbe30c6540c3be9290585c1dd04

See more details on using hashes here.

Supported by

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