mjlab/docs/source/api/sensor.rst
Upstream Snapshot 32a241c28f
Some checks failed
nightly / Test against latest dependencies (py3.10) (push) Has been cancelled
nightly / Test against latest dependencies (py3.13) (push) Has been cancelled
tests / tests (3.13, locked) (push) Has been cancelled
tests / tests (3.13, unlocked) (push) Has been cancelled
tests / pyright (3.10) (push) Has been cancelled
tests / lint-format (push) Has been cancelled
tests / tests (3.10, locked) (push) Has been cancelled
tests / tests (3.11, locked) (push) Has been cancelled
tests / tests (3.12, locked) (push) Has been cancelled
tests / pyright (3.11) (push) Has been cancelled
tests / pyright (3.12) (push) Has been cancelled
tests / pyright (3.13) (push) Has been cancelled
tests / ty-check (3.10) (push) Has been cancelled
tests / ty-check (3.11) (push) Has been cancelled
tests / ty-check (3.12) (push) Has been cancelled
tests / ty-check (3.13) (push) Has been cancelled
tests / stubs (push) Has been cancelled
tests / smoke-test (push) Has been cancelled
Docker / check_paths (push) Has been cancelled
docs / build (push) Has been cancelled
Docker / build (push) Has been cancelled
Import upstream snapshot c19f713c415a699a79d71cd96aa13c3104a05047
Upstream: https://github.com/michaelgillett/mjlab
Upstream-Commit: c19f713c415a699a79d71cd96aa13c3104a05047
Upstream-Branch: main
2026-08-28 15:42:17 +08:00

127 lines
2.0 KiB
ReStructuredText

mjlab.sensor
============
.. automodule:: mjlab.sensor
.. rubric:: Classes
.. hlist::
:columns: 3
- :class:`Sensor`
- :class:`SensorCfg`
- :class:`SensorContext`
- :class:`BuiltinSensor`
- :class:`BuiltinSensorCfg`
- :class:`ObjRef`
- :class:`ContactSensor`
- :class:`ContactSensorCfg`
- :class:`ContactData`
- :class:`ContactMatch`
- :class:`RayCastSensor`
- :class:`RayCastSensorCfg`
- :class:`RayCastData`
- :class:`GridPatternCfg`
- :class:`PinholeCameraPatternCfg`
- :class:`CameraSensor`
- :class:`CameraSensorCfg`
- :class:`CameraSensorData`
Base
----
.. autoclass:: Sensor
:members:
:show-inheritance:
.. autoclass:: SensorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: SensorContext
:members:
Builtin Sensor
--------------
.. autoclass:: BuiltinSensor
:members:
:show-inheritance:
.. autoclass:: BuiltinSensorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: ObjRef
:members:
:exclude-members: __init__
:undoc-members:
Contact Sensor
--------------
.. autoclass:: ContactSensor
:members:
:show-inheritance:
.. autoclass:: ContactSensorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: ContactData
:members:
.. autoclass:: ContactMatch
:members:
:exclude-members: __init__
:undoc-members:
Ray Cast Sensor
---------------
.. autoclass:: RayCastSensor
:members:
:show-inheritance:
.. autoclass:: RayCastSensorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: RayCastData
:members:
.. autoclass:: GridPatternCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: PinholeCameraPatternCfg
:members:
:exclude-members: __init__
:undoc-members:
Camera Sensor
-------------
.. autoclass:: CameraSensor
:members:
:show-inheritance:
.. autoclass:: CameraSensorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: CameraSensorData
:members: