/gz-sensors

Provides numerous sensor models designed to generate realistic data from simulation environments.

Primary LanguageC++Apache License 2.0Apache-2.0

Gazebo Sensors : Sensor models for simulation

Maintainer: ichen AT openrobotics DOT org

GitHub open issues GitHub open pull requests Discourse topics Hex.pm

Build Status
Test coverage codecov
Ubuntu Focal Build Status
Homebrew Build Status
Windows Build Status

Gazebo Sensors, a component of Gazebo, provides numerous sensor models designed to generate realistic data from simulation environments. Gazebo Sensors is used in conjunction with Gazebo Libraries, and especially relies on the rendering capabilities from Gazebo Rendering and physics simulation from Gazebo Physics.

Table of Contents

Features

Install

Usage

Folder Structure

Code of Conduct

Contributing

Versioning

License

Features

Gazebo Sensors provides a set of sensors models that can be configured at run time to mimic specific real-world sensors. A noise model is also provided that can be used to introduce Gaussian or custom noise models into sensor streams.

Install

See the installation tutorial.

Usage

Please refer to the examples directory.

Folder Structure

Refer to the following table for information about important directories and files in this repository.

├── examples                  Example programs.
├── include/gz/sensors        Header files that will be installed.
├── src                       Source files and unit tests.
├── test
│    ├── integration          Integration tests.
│    ├── performance          Performance tests.
│    └── regression           Regression tests.
├── tutorials                 Tutorials, written in markdown.
├── Changelog.md              Changelog.
├── CMakeLists.txt            CMake build script.
└── README.md                 This readme.

Contributing

Please see the contribution guide.

Code of Conduct

Please see CODE_OF_CONDUCT.md.

Versioning

This library uses Semantic Versioning. Additionally, this library is part of the Gazebo project which periodically releases a versioned set of compatible and complimentary libraries. See the Gazebo website for version and release information.

License

This library is licensed under Apache 2.0. See also the LICENSE file.