Skip to content

Commit

Permalink
better docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
rookiepeng committed Dec 16, 2024
1 parent 8d8e1f1 commit eb9ea91
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion gen_docs/coordinate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Coordinate Systems
- **yaw** (deg): rotation along the z-axis. Positive yaw rotates the object from the positive x-axis to the positive y-axis
- **pitch** (deg): rotation along the y-axis. Positive pitch rotates the object from the positive x-axis to the positive z-axis
- **roll** (deg): rotation along the x-axis. Positive roll rotates the object from the positive y-axis to the positive z-axis
- **origin** (m): ``[x, y, z]``, the rotation centor of the object. Radar's origin is always at ``[0, 0, 0]``
- **origin** (m): ``[x, y, z]``, the motion (rotation and translation) centor of the object. Radar's origin is always at ``[0, 0, 0]``

.. image:: https://raw.githubusercontent.com/radarsimx/radarsimpy/master/assets/yaw_pitch_roll.svg
:width: 400
Expand Down
2 changes: 1 addition & 1 deletion src/radarsimpy/simulator_lidar.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ cpdef sim_lidar(lidar, targets, frame_time=0):
- **model** (*str*):
File path to the target model (3D object) in the scene.
- **origin** (*numpy.ndarray*):
The origin position of the target model in meters (m), specified as [x, y, z].
The origin position (rotation and translation center) of the target model in meters (m), specified as [x, y, z].
Default: ``[0, 0, 0]``.
- **location** (*numpy.ndarray*):
The 3D location of the target in meters (m), specified as [x, y, z].
Expand Down
2 changes: 1 addition & 1 deletion src/radarsimpy/simulator_radar.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ cpdef sim_radar(radar, targets, frame_time=0, density=1, level=None, log_path=No
A target represented as a 3D model. Each target is defined as a dictionary with the following keys:
- **model** (*str*): Path to the target model file.
- **origin** (*numpy.ndarray*): Origin position of the target model [x, y, z] in meters. Default: ``[0, 0, 0]``.
- **origin** (*numpy.ndarray*): Origin position (rotation and translation center) of the target model [x, y, z] in meters. Default: ``[0, 0, 0]``.
- **location** (*numpy.ndarray*): Location of the target in meters [x, y, z]. Default: ``[0, 0, 0]``.
- **speed** (*numpy.ndarray*): Target velocity in meters per second [vx, vy, vz]. Default: ``[0, 0, 0]``.
- **rotation** (*numpy.ndarray*): Target orientation in degrees [yaw, pitch, roll]. Default: ``[0, 0, 0]``.
Expand Down
2 changes: 1 addition & 1 deletion src/radarsimpy/simulator_rcs.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ cpdef sim_rcs(targets,
- **model** (*str*):
File path to the 3D target model.
- **origin** (*numpy.ndarray*):
The origin position of the target model in meters (m), specified as [x, y, z].
The origin position (rotation and translation center) of the target model in meters (m), specified as [x, y, z].
Default: ``[0, 0, 0]``.
- **location** (*numpy.ndarray*):
The 3D location of the target in meters (m), specified as [x, y, z].
Expand Down

0 comments on commit eb9ea91

Please sign in to comment.