Skip to main content

Multi-Modality

Sonar Vision Mapping System

This project aims to recreate the vision mapping system inspired by Batman in "The Dark Knight." The system uses high-frequency sound pulses to create a real-time, three-dimensional map of an environment. It is designed for applications in security, surveillance, and search-and-rescue operations.

Features

  • Emit ultrasonic chirp signals
  • Record echoes and process the response
  • Calculate distances to objects based on echo timings
  • Construct and visualize a 3D point cloud of the environment

Requirements

  • Python 3.6+
  • numpy
  • sounddevice
  • scipy
  • matplotlib

Install

$ pip install svms

Usage

from svms.main import SonarVisionMappingSystem

# Example usage
sonar_system = SonarVisionMappingSystem()
sonar_system.run()

This script will emit ultrasonic pulses, record the echoes, and visualize the 3D point cloud of the environment.

Code Overview

SonarVisionMappingSystem Class

The main functionality is encapsulated in the SonarVisionMappingSystem class. Here's a breakdown of the key methods:

  • __init__(self, fs=44100, duration=0.5, f0=20000, f1=20000, num_directions=36, elevation_angles=9): Initializes the system with sampling frequency, duration, and frequency range for the chirp signal, along with the number of directions and elevation angles for mapping.

  • generate_chirp_signal(self): Generates a chirp signal.

  • record_response(self): Emits the chirp signal and records the response.

  • process_signal(self, response): Processes the recorded response to find echoes and calculate distances.

  • collect_data(self): Collects responses and distances for multiple directions and elevation angles.

  • plot_3d_mapping(self): Plots the 3D point cloud of the environment.

  • run(self): Runs the complete process of data collection and 3D mapping.

Example Usage

sonar_system = SonarVisionMappingSystem()
sonar_system.run()

Safety Considerations

The system uses ultrasonic frequencies (20 kHz), which are generally considered safe. However, ensure that the intensity of the emitted pulses is within safe limits, and avoid prolonged exposure to ultrasonic waves.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Metadata

Release files for svms 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for svms 0.0.2
File Size Uploaded
svms-0.0.2.tar.gz 4.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for svms 0.0.2
File Interpreter ABI Platform
svms-0.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 9.5 kB

Release files / svms-0.0.2.tar.gz

Download URL svms-0.0.2.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
6835348f8f62d3e02938e139855d95c9317f7e753169f08c86d76ac20742e818
BLAKE2b-256 checksum
How to use checksums
b328ea6989960f8fcac2feaa2db3006360326529ca3e67f8ee70c555bd2d7080
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.3 Darwin/23.3.0

Release files / svms-0.0.2-py3-none-any.whl

Download URL svms-0.0.2-py3-none-any.whl
Size 4.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0f5e42af9453e7270697ba7ff0452c44981c37bbfd3aaecbb7c84f00ca6dfe79
BLAKE2b-256 checksum
How to use checksums
c9fc4d0c09a1494ec82d6f1e9e057270872a662063060d5a0652874bb45ce980
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.3 Darwin/23.3.0

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page