Skip to content

Commit 8834e34

Browse files
Merge PR IntelRealSense#2901 from SamerKhshiboun: Update Anchors Links In README.md
2 parents 218e327 + 88818df commit 8834e34

File tree

1 file changed

+28
-61
lines changed

1 file changed

+28
-61
lines changed

README.md

Lines changed: 28 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,27 @@
2323
<hr>
2424

2525
## Table of contents
26-
* [ROS1 and ROS2 legacy](#legacy)
26+
* [ROS1 and ROS2 legacy](#ros1-and-ros2-legacy)
2727
* [Installation](#installation)
2828
* [Usage](#usage)
29-
* [Starting the camera node](#start-camera-node)
30-
* [Camera name and namespace](#camera-name-and-namespace)
29+
* [Starting the camera node](#start-the-camera-node)
30+
* [Camera name and namespace](#camera-name-and-camera-namespace)
3131
* [Parameters](#parameters)
32-
* [ROS2-vs-Optical Coordination Systems](#coordination)
33-
* [TF from coordinate A to coordinate B](#tfs)
34-
* [Extrinsics from sensor A to sensor B](#extrinsics)
35-
* [Topics](#topics)
36-
* [RGBD Topic](#rgbd)
37-
* [Metadata Topic](#metadata)
38-
* [Post-Processing Filters](#filters)
39-
* [Available Services](#services)
40-
* [Efficient intra-process communication](#intra-process)
32+
* [ROS2-vs-Optical Coordination Systems](#ros2robot-vs-opticalcamera-coordination-systems)
33+
* [TF from coordinate A to coordinate B](#tf-from-coordinate-a-to-coordinate-b)
34+
* [Extrinsics from sensor A to sensor B](#extrinsics-from-sensor-a-to-sensor-b)
35+
* [Topics](#published-topics)
36+
* [RGBD Topic](#rgbd-topic)
37+
* [Metadata Topic](#metadata-topic)
38+
* [Post-Processing Filters](#post-processing-filters)
39+
* [Available Services](#available-services)
40+
* [Efficient intra-process communication](#efficient-intra-process-communication)
4141
* [Contributing](CONTRIBUTING.md)
4242
* [License](LICENSE)
4343

4444
<hr>
4545

46-
<h2 id="legacy">
47-
Legacy
48-
</h2>
46+
# ROS1 and ROS2 Legacy
4947

5048
<details>
5149
<summary>
@@ -80,9 +78,7 @@
8078
</details>
8179

8280

83-
<h2 id="installation">
84-
Installation
85-
</h2>
81+
# Installation
8682

8783
<details>
8884
<summary>
@@ -165,13 +161,9 @@
165161

166162
<hr>
167163

168-
<h2 id="usage">
169-
Usage
170-
</h2>
164+
# Usage
171165

172-
<h3 id="start-camera-node">
173-
Start the camera node
174-
</h3>
166+
## Start the camera node
175167

176168
#### with ros2 run:
177169
ros2 run realsense2_camera realsense2_camera_node
@@ -184,9 +176,7 @@
184176

185177
<hr>
186178

187-
<h3 id="camera-name-and-namespace">
188-
Camera Name And Camera Namespace
189-
</h3>
179+
## Camera Name And Camera Namespace
190180

191181
User can set the camera name and camera namespace, to distinguish between cameras and platforms, which helps identifying the right nodes and topics to work with.
192182

@@ -247,13 +237,9 @@ User can set the camera name and camera namespace, to distinguish between camera
247237
/camera/camera/device_info
248238
```
249239

250-
251240
<hr>
252241

253-
254-
<h3 id="parameters">
255-
Parameters
256-
<h3>
242+
## Parameters
257243

258244
### Available Parameters:
259245
- For the entire list of parameters type `ros2 param list`.
@@ -371,9 +357,7 @@ The `/diagnostics` topic includes information regarding the device temperatures
371357

372358
<hr>
373359

374-
<h3 id="coordination">
375-
ROS2(Robot) vs Optical(Camera) Coordination Systems:
376-
</h3>
360+
## ROS2(Robot) vs Optical(Camera) Coordination Systems:
377361

378362
- Point Of View:
379363
- Imagine we are standing behind of the camera, and looking forward.
@@ -389,9 +373,7 @@ The `/diagnostics` topic includes information regarding the device temperatures
389373

390374
<hr>
391375

392-
<h3 id="tfs">
393-
TF from coordinate A to coordinate B:
394-
</h3>
376+
## TF from coordinate A to coordinate B:
395377

396378
- TF msg expresses a transform from coordinate frame "header.frame_id" (source) to the coordinate frame child_frame_id (destination) [Reference](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Transform.html)
397379
- In RealSense cameras, the origin point (0,0,0) is taken from the left IR (infra1) position and named as "camera_link" frame
@@ -403,10 +385,7 @@ The `/diagnostics` topic includes information regarding the device temperatures
403385

404386
<hr>
405387

406-
<h3 id="extrinsics">
407-
Extrinsics from sensor A to sensor B:
408-
</h3>
409-
388+
## Extrinsics from sensor A to sensor B:
410389

411390
- Extrinsic from sensor A to sensor B means the position and orientation of sensor A relative to sensor B.
412391
- Imagine that B is the origin (0,0,0), then the Extrensics(A->B) describes where is sensor A relative to sensor B.
@@ -441,9 +420,7 @@ translation:
441420

442421
<hr>
443422

444-
<h3 id="topics">
445-
Published Topics
446-
</h3>
423+
## Published Topics
447424

448425
The published topics differ according to the device and parameters.
449426
After running the above command with D435i attached, the following list of topics will be available (This is a partial list. For full one type `ros2 topic list`):
@@ -485,9 +462,7 @@ Enabling stream adds matching topics. For instance, enabling the gyro and accel
485462

486463
<hr>
487464

488-
<h3 id="rgbd">
489-
RGBD Topic
490-
</h3>
465+
## RGBD Topic
491466

492467
RGBD new topic, publishing [RGB + Depth] in the same message (see RGBD.msg for reference). For now, works only with depth aligned to color images, as color and depth images are synchronized by frame time tag.
493468

@@ -507,9 +482,7 @@ ros2 launch realsense2_camera rs_launch.py enable_rgbd:=true enable_sync:=true a
507482

508483
<hr>
509484

510-
<h3 id="metadata">
511-
Metadata topic
512-
</h3>
485+
## Metadata topic
513486

514487
The metadata messages store the camera's available metadata in a *json* format. To learn more, a dedicated script for echoing a metadata topic in runtime is attached. For instance, use the following command to echo the camera/depth/metadata topic:
515488
```
@@ -518,10 +491,8 @@ python3 src/realsense-ros/realsense2_camera/scripts/echo_metadada.py /camera/cam
518491

519492
<hr>
520493

521-
<h3 id="filters">
522-
Post-Processing Filters
523-
</h3>
524-
494+
## Post-Processing Filters
495+
525496
The following post processing filters are available:
526497
- ```align_depth```: If enabled, will publish the depth image aligned to the color image on the topic `/camera/camera/aligned_depth_to_color/image_raw`.
527498
- The pointcloud, if created, will be based on the aligned depth image.
@@ -551,17 +522,13 @@ Each of the above filters have it's own parameters, following the naming convent
551522

552523
<hr>
553524

554-
<h3 id="services">
555-
Available services
556-
</h3>
525+
## Available services
557526

558527
- device_info : retrieve information about the device - serial_number, firmware_version etc. Type `ros2 interface show realsense2_camera_msgs/srv/DeviceInfo` for the full list. Call example: `ros2 service call /camera/camera/device_info realsense2_camera_msgs/srv/DeviceInfo`
559528

560529
<hr>
561530

562-
<h3 id="intra-process">
563-
Efficient intra-process communication:
564-
</h3>
531+
## Efficient intra-process communication:
565532

566533
Our ROS2 Wrapper node supports zero-copy communications if loaded in the same process as a subscriber node. This can reduce copy times on image/pointcloud topics, especially with big frame resolutions and high FPS.
567534

0 commit comments

Comments
 (0)