Maintainer: ichen AT openrobotics DOT org
| Build | Status |
|---|---|
| Test coverage |  |
| Ubuntu Bionic | |
| Homebrew | |
| Windows |
Ignition Sensors, a component of Ignition Robotics, provides numerous sensor models designed to generate realistic data from simulation environments. Ignition Sensors is used in conjunction with Ignition Libraries, and especially relies on the rendering capabilities from Ignition Rendering and physics simulation from Ignition Physics.
Ignition 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.
See the installation tutorial.
Please refer to the examples directory.
API and tutorials can be found at https://ignitionrobotics.org/libs/sensors.
You can also generate the documentation from a clone of this repository by following these steps.
-
You will need Doxygen. On Ubuntu Doxygen can be installed using
sudo apt-get install doxygen -
Clone the repository
git clone https://github.com/ignitionrobotics/ign-sensors -
Configure and build the documentation.
cd ign-sensors; mkdir build; cd build; cmake ../; make doc -
View the documentation by running the following command from the build directory.
firefox doxygen/html/index.html
Follow these steps to run tests and static code analysis in your clone of this repository.
-
Follow the source install instruction.
-
Run tests.
make test -
Static code checker.
make codecheck
Refer to the following table for information about important directories and files in this repository.
├── examples Example programs.
├── include/ignition/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.
Please see CONTRIBUTING.md.
Please see CODE_OF_CONDUCT.md.
This library uses Semantic Versioning. Additionally, this library is part of the Ignition Robotics project which periodically releases a versioned set of compatible and complimentary libraries. See the Ignition Robotics website for version and release information.
This library is licensed under Apache 2.0. See also the LICENSE file.