.. 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": null,
"name": "rosbags-image",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "conversion, cv_bridge, image, compressedimage, message, msg, opencv, ros, ros2, rosbag, rosbag1, rosbag2, rosbags",
"author": null,
"author_email": "Ternaris <team@ternaris.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/f5/69d7e487b9bd4c2bd9226f7ba93e1aa0414beebf972948c97bfb2253c375/rosbags_image-0.10.0.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.10.0",
"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": "3c58abaf47ca9082b37426eb5263bb00e1f17d6d60245daec83ba58b78027876",
"md5": "2cf1fe66570654617652b0bf1b2092e9",
"sha256": "87adc8367aa68638352ed0588dd2f28ca0a55ea62e55c4a780027304712181e4"
},
"downloads": -1,
"filename": "rosbags_image-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2cf1fe66570654617652b0bf1b2092e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9286,
"upload_time": "2024-05-30T16:24:46",
"upload_time_iso_8601": "2024-05-30T16:24:46.211667Z",
"url": "https://files.pythonhosted.org/packages/3c/58/abaf47ca9082b37426eb5263bb00e1f17d6d60245daec83ba58b78027876/rosbags_image-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bf569d7e487b9bd4c2bd9226f7ba93e1aa0414beebf972948c97bfb2253c375",
"md5": "6c7c2feab15a099ed7693f0a83a0d434",
"sha256": "53e7167e9c14574a88a8eac5b1f4df67b463fb59b965f97c95bcad244a94faf6"
},
"downloads": -1,
"filename": "rosbags_image-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "6c7c2feab15a099ed7693f0a83a0d434",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 48209,
"upload_time": "2024-05-30T16:25:27",
"upload_time_iso_8601": "2024-05-30T16:25:27.034448Z",
"url": "https://files.pythonhosted.org/packages/3b/f5/69d7e487b9bd4c2bd9226f7ba93e1aa0414beebf972948c97bfb2253c375/rosbags_image-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-30 16:25:27",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ternaris",
"gitlab_project": "rosbags-image",
"lcname": "rosbags-image"
}
JSON