Skip to content

Commit 78e212a

Browse files
committed
Update docs for breaking method change
1 parent b45a2fb commit 78e212a

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

docs/source/how-to/save_camera_output.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ directory.
2121
Saving using Replicator Basic Writer
2222
------------------------------------
2323

24+
.. note::
25+
The BasicWriter is part of the Omniverse Replicator ecosystem and is specific to the default
26+
Isaac RTX renderer backend. Other renderer backends may require different save workflows.
27+
2428
To save camera outputs, we use the basic write class from Omniverse Replicator. This class allows us to save the
2529
images in a numpy format. For more information on the basic writer, please check the
2630
`documentation <https://docs.omniverse.nvidia.com/extensions/latest/ext_replicator/writer_examples.html>`_.

source/isaaclab/docs/CHANGELOG.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ Changed
1919
``camera.data.info[data_type]``.
2020
- **TiledCamera users (old):** access pattern ``camera.data.info[data_type]`` is unchanged.
2121

22+
* **Breaking:** :meth:`~isaaclab.renderers.BaseRenderer.write_output` has been replaced by
23+
:meth:`~isaaclab.renderers.BaseRenderer.read_output`. The new method receives the full
24+
:class:`~isaaclab.sensors.camera.CameraData` instance and iterates output types internally.
25+
Custom renderer implementations must replace ``write_output(render_data, output_name, output_data)``
26+
with ``read_output(render_data, camera_data)``.
27+
2228
Deprecated
2329
^^^^^^^^^^
2430

source/isaaclab/isaaclab/sensors/camera/camera_data.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,6 @@ class CameraData:
5353
The format of the data is available in the `Replicator Documentation`_. For semantic-based data,
5454
this corresponds to the ``"data"`` key in the output of the sensor.
5555
56-
Key iteration order is not guaranteed to match the order of entries in the camera configuration's
57-
``data_types`` list; index by name or iterate ``data_types`` and look up each key explicitly.
58-
5956
.. _Replicator Documentation: https://docs.omniverse.nvidia.com/prod_extensions/prod_extensions/ext_replicator/annotators_details.html#annotator-output
6057
"""
6158

0 commit comments

Comments
 (0)