.. image:: https://gitlab.com/ternaris/rosbags-image/badges/master/pipeline.svg
:target: https://gitlab.com/ternaris/rosbags-image/-/commits/master
:alt: pipeline status
.. image:: https://gitlab.com/ternaris/rosbags-image/badges/master/coverage.svg
:target: https://gitlab.com/ternaris/rosbags-image/-/commits/master
:alt: coverage report
=============
Rosbags-image
=============
Rosbags-image is the **pure python** library for interacting with image or compressed image messages and it aims to provide the same functionality as cv_bridge. It is part of the larger `Rosbags <https://gitlab.com/ternaris/rosbags>`_ ecosystem.
Rosbags-image does not have any dependencies on the ROS software stacks and can be used on its own or alongside ROS1 or ROS2.
Getting started
===============
Rosbags-image is published on PyPI and does not have any special dependencies. Simply install with pip::
pip install rosbags-image
Convert sensor_msgs/msg/Image message into OpenCV image:
.. code-block:: python
from rosbags.image import message_to_cvimage
# msg is rosbags Image or CompressedImage message instance
msg = ...
# get opencv image without any conversions
img = message_to_cvimage(msg)
# get opencv image and convert to bgr8 color space
img = message_to_cvimage(msg, 'bgr8')
Documentation
=============
Read the `documentation <https://ternaris.gitlab.io/rosbags-image/>`_ for further information.
.. end documentation
Contributing
============
Thank you for considering to contribute to rosbags-image.
To submit issues or create merge requests please follow the instructions provided in the `contribution guide <https://gitlab.com/ternaris/rosbags-image/-/blob/master/CONTRIBUTING.rst>`_.
By contributing to rosbags-image you accept and agree to the terms and conditions laid out in there.
Development
===========
Clone the repository and setup your local checkout::
git clone https://gitlab.com/ternaris/rosbags-image.git
cd rosbags-image
python -m venv venv
. venv/bin/activate
pip install -r requirements-dev.txt
pip install -e .
This creates a new virtual environment with the necessary python dependencies and installs rosbags-image in editable mode. The rosbags-image code base uses pytest as its test runner, run the test suite by simply invoking::
pytest
To build the documentation from its source run sphinx-build::
sphinx-build -a docs public
The entry point to the local documentation build should be available under ``public/index.html``.
Support
=======
Professional support is available from `Ternaris <https://ternaris.com>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "rosbags-image",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.2",
"maintainer_email": "",
"keywords": "conversion,cv_bridge,image,compressedimage,message,msg,opencv,ros,ros2,rosbag,rosbag1,rosbag2,rosbags",
"author": "",
"author_email": "Ternaris <team@ternaris.com>",
"download_url": "https://files.pythonhosted.org/packages/c0/8d/e3038468d7adb4716a8824234ffabfed7379e892379311f2201588c96a1c/rosbags-image-0.9.2.tar.gz",
"platform": null,
"description": ".. image:: https://gitlab.com/ternaris/rosbags-image/badges/master/pipeline.svg\n :target: https://gitlab.com/ternaris/rosbags-image/-/commits/master\n :alt: pipeline status\n\n.. image:: https://gitlab.com/ternaris/rosbags-image/badges/master/coverage.svg\n :target: https://gitlab.com/ternaris/rosbags-image/-/commits/master\n :alt: coverage report\n\n\n=============\nRosbags-image\n=============\n\nRosbags-image is the **pure python** library for interacting with image or compressed image messages and it aims to provide the same functionality as cv_bridge. It is part of the larger `Rosbags <https://gitlab.com/ternaris/rosbags>`_ ecosystem.\n\nRosbags-image does not have any dependencies on the ROS software stacks and can be used on its own or alongside ROS1 or ROS2.\n\n\nGetting started\n===============\n\nRosbags-image is published on PyPI and does not have any special dependencies. Simply install with pip::\n\n pip install rosbags-image\n\n\nConvert sensor_msgs/msg/Image message into OpenCV image:\n\n.. code-block:: python\n\n from rosbags.image import message_to_cvimage\n\n # msg is rosbags Image or CompressedImage message instance\n msg = ...\n\n # get opencv image without any conversions\n img = message_to_cvimage(msg)\n\n # get opencv image and convert to bgr8 color space\n img = message_to_cvimage(msg, 'bgr8')\n\n\nDocumentation\n=============\n\nRead the `documentation <https://ternaris.gitlab.io/rosbags-image/>`_ for further information.\n\n.. end documentation\n\n\nContributing\n============\n\nThank you for considering to contribute to rosbags-image.\n\nTo submit issues or create merge requests please follow the instructions provided in the `contribution guide <https://gitlab.com/ternaris/rosbags-image/-/blob/master/CONTRIBUTING.rst>`_.\n\nBy contributing to rosbags-image you accept and agree to the terms and conditions laid out in there.\n\n\nDevelopment\n===========\n\nClone the repository and setup your local checkout::\n\n git clone https://gitlab.com/ternaris/rosbags-image.git\n\n cd rosbags-image\n python -m venv venv\n . venv/bin/activate\n\n pip install -r requirements-dev.txt\n pip install -e .\n\n\nThis creates a new virtual environment with the necessary python dependencies and installs rosbags-image in editable mode. The rosbags-image code base uses pytest as its test runner, run the test suite by simply invoking::\n\n pytest\n\n\nTo build the documentation from its source run sphinx-build::\n\n sphinx-build -a docs public\n\n\nThe entry point to the local documentation build should be available under ``public/index.html``.\n\n\nSupport\n=======\n\nProfessional support is available from `Ternaris <https://ternaris.com>`_.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Pure Python library to convert ros image message data from and to opencv2.",
"version": "0.9.2",
"project_urls": {
"Changelog": "https://gitlab.com/ternaris/rosbags-image/-/blob/master/CHANGES.rst",
"Documentation": "https://ternaris.gitlab.io/rosbags-image",
"Homepage": "https://gitlab.com/ternaris/rosbags-image",
"Issues": "https://gitlab.com/ternaris/rosbags-image/issues",
"Source": "https://gitlab.com/ternaris/rosbags-image"
},
"split_keywords": [
"conversion",
"cv_bridge",
"image",
"compressedimage",
"message",
"msg",
"opencv",
"ros",
"ros2",
"rosbag",
"rosbag1",
"rosbag2",
"rosbags"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b566b6a081f0f25f8235620ad8857daa4ea74b70e1406c005afbd121e1862107",
"md5": "b2b05b50792481589b8becffc9f38410",
"sha256": "5f159f695b994e70f3b8910c2d4e678157f04b468bcf51c3b86e589553c359d6"
},
"downloads": -1,
"filename": "rosbags_image-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b2b05b50792481589b8becffc9f38410",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.2",
"size": 9214,
"upload_time": "2024-03-01T10:17:36",
"upload_time_iso_8601": "2024-03-01T10:17:36.309606Z",
"url": "https://files.pythonhosted.org/packages/b5/66/b6a081f0f25f8235620ad8857daa4ea74b70e1406c005afbd121e1862107/rosbags_image-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c08de3038468d7adb4716a8824234ffabfed7379e892379311f2201588c96a1c",
"md5": "9b967926bfe5edacd5c43282a7f958dd",
"sha256": "19398ccf1358a52221b6aaace6ed0496466be464ec912c1821eeef7c1398afb8"
},
"downloads": -1,
"filename": "rosbags-image-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "9b967926bfe5edacd5c43282a7f958dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.2",
"size": 47316,
"upload_time": "2024-03-01T10:17:38",
"upload_time_iso_8601": "2024-03-01T10:17:38.116880Z",
"url": "https://files.pythonhosted.org/packages/c0/8d/e3038468d7adb4716a8824234ffabfed7379e892379311f2201588c96a1c/rosbags-image-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 10:17:38",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ternaris",
"gitlab_project": "rosbags-image",
"lcname": "rosbags-image"
}
JSON