Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unified changelog, add missing image, deduplicate tutorials #938

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions camera_calibration/doc/changes.rst

This file was deleted.

1 change: 0 additions & 1 deletion camera_calibration/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,3 @@ To run the command-line utility to check the calibration of a stereo camera:
tutorial_mono
tutorial_stereo
api
changes
18 changes: 0 additions & 18 deletions depth_image_proc/doc/changes.rst

This file was deleted.

1 change: 0 additions & 1 deletion depth_image_proc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ For an example of ``depth_image_proc`` in practice, examine the contents of
self
components
tutorials
changes
image_proc <generated/index>

Indices and tables
Expand Down
20 changes: 1 addition & 19 deletions depth_image_proc/doc/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,22 +56,4 @@ parameter is used:

Remapping camera_info Topics
----------------------------
When a ``camera_info`` topic is needed, an image_transport camera subscriber
is typically used. ROS 2 convention for naming ``camera_info`` topics is:

* camera/image - an image in namespace ``camera``.
* camera/camera_info - the associated camera info

So if a node subscribes to a topic called ``image``, and the user remaps this
to ``my_camera/image``, then the associated camera info will be automatically
remapped to ``mycamera/camera_info``.

Most ROS 2 camera drivers will follow the convention, but occasionally they do
not. In this case, you will have to manually remap the camera_info - but due
to the way that ROS 2 remapping works you have to use the fully resolved
camera info topic. An example:

* ``image`` is remapped to ``my_camera/image``.
* The fully resolved name for the camera info is now ``my_camera/camera_info``.
* If your camera driver actually publishes ``another_ns/camera_info``, then
you would have to remap ``my_camera/camera_info`` to ``another_ns/camera_info``.
See `tutorial in image_pipline <https://docs.ros.org/en/rolling/p/image_pipeline/tutorials.html#remapping-camera-info-topics>`_.
40 changes: 40 additions & 0 deletions image_pipeline/doc/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Changelog Notes
===============

While there is an official changelog for each package, this page summarizes
the major changes between distributions

Changes in Jazzy Jalisco
------------------------
There are several major change between ``Iron`` and ``Jazzy``:

* All components now properly support ``image_transport`` paramter,
or ``depth_image_transport`` parameter if the topic is a depth image.
In most places, this consists of simply adding the parameter, or making
the parameter work, however two cases should be noted where the
parameter was renamed:

* image_view::ExtractImages: incorrectly named parameter ``transport``
was renamed to more consistent ``image_transport``.
* imaeg_view::StereoView: incorrectly named parameter ``transport``
was renamed to more consistent ``image_transport``.

* Improvements to QoS support:

* Most components now support QoS overrides via ROS 2 parameters
* The ``use_system_default_qos`` parameter has been removed from
stereo_image_proc::DisparityNode and stereo_image_proc::PointCloudNode
as the QoS overrides are the newer, preferred method.

* All components now properly support remapping the ``camera_info`` topic
for an associated ``image`` topic. For instance, if you remap ``image``
to ``my/image`` then ``my/camera_info`` will be used. Previously you
would have to manually remap the ``camera_info`` topic. See also
:ref:`Remapping camera_info Topics`.
* The input of ``depth_image_proc/point_cloud_xyz_radial`` is renamed
from ``image_raw`` to ``depth/image_raw`` for consistency.
* The inputs of ``depth_image_proc/point_cloud_xyzrgb_radial`` are renamed
from ``depth_registered/image_rect`` to ``depth/image_raw`` and
``rgb/image_rect_color`` to ``rgb/image_raw`` to make clear that the
unrectified camera projection matrix is used, and for consistency with
other radial nodes.
1 change: 1 addition & 0 deletions image_pipeline/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ stereo disparity images, and stereo point clouds. Components include:

self
camera_info
changelog
camera_calibration <../camera_calibration/index.html#http://>
depth_image_proc <../depth_image_proc/index.html#http://>
image_proc <../image_proc/index.html#http://>
Expand Down
12 changes: 0 additions & 12 deletions image_proc/doc/changes.rst

This file was deleted.

1 change: 0 additions & 1 deletion image_proc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ The images above were produced using the tutorial :ref:`Using image_proc Launch
self
components
tutorials
changes
image_proc <generated/index>

Indices and tables
Expand Down
20 changes: 1 addition & 19 deletions image_proc/doc/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,25 +73,7 @@ networks, such as WiFi, it can be helpful to use ``compressed`` format.

Remapping camera_info Topics
----------------------------
When a ``camera_info`` topic is needed, an image_transport camera subscriber
is typically used. ROS 2 convention for naming ``camera_info`` topics is:

* camera/image - an image in namespace ``camera``.
* camera/camera_info - the associated camera info

So if a node subscribes to a topic called ``image``, and the user remaps this
to ``my_camera/image``, then the associated camera info will be automatically
remapped to ``mycamera/camera_info``.

Most ROS 2 camera drivers will follow the convention, but occasionally they do
not. In this case, you will have to manually remap the camera_info - but due
to the way that ROS 2 remapping works you have to use the fully resolved
camera info topic. An example:

* ``image`` is remapped to ``my_camera/image``.
* The fully resolved name for the camera info is now ``my_camera/camera_info``.
* If your camera driver actually publishes ``another_ns/camera_info``, then
you would have to remap ``my_camera/camera_info`` to ``another_ns/camera_info``.
See `tutorial in image_pipline <https://docs.ros.org/en/rolling/p/image_pipeline/tutorials.html#remapping-camera-info-topics>`_.

.. _Using image_proc Launch File:

Expand Down
12 changes: 0 additions & 12 deletions image_publisher/doc/changes.rst

This file was deleted.

3 changes: 1 addition & 2 deletions image_publisher/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ as a ROS 2 image topic.

Simplest example is:

.. code-block: bash
.. code-block:: bash

ros2 run image_publisher image_publisher /opt/ros/rolling/share/rviz/images/splash.png

Expand All @@ -15,7 +15,6 @@ Simplest example is:

self
components
changes
image_publisher <generated/index>

Indices and tables
Expand Down
12 changes: 0 additions & 12 deletions image_rotate/doc/changes.rst

This file was deleted.

Binary file added image_rotate/doc/images/image_rotate.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion image_rotate/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ borders, and does not output a ``camera_info``.

self
components
changes
image_rotate <generated/index>

Indices and tables
Expand Down
12 changes: 0 additions & 12 deletions image_view/doc/changes.rst

This file was deleted.

1 change: 0 additions & 1 deletion image_view/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ parameter.

self
components
changes
image_view <generated/index>

Indices and tables
Expand Down
12 changes: 0 additions & 12 deletions stereo_image_proc/doc/changes.rst

This file was deleted.

1 change: 0 additions & 1 deletion stereo_image_proc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ viewed with ``stereo_view`` from the ``image_view`` package.
components
configuration
tutorials
changes
stereo_image_proc <generated/index>

Indices and tables
Expand Down
Loading