Skip to content

Commit

Permalink
Adding missing docstring about just_xy (nutonomy#632)
Browse files Browse the repository at this point in the history
Co-authored-by: Nadir Ghoul <nadir.ghoul@hotmail.com>
  • Loading branch information
gndu91 and Nadir Ghoul authored Aug 10, 2021
1 parent cbca1b8 commit 84eda0e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion python-sdk/nuscenes/prediction/helper.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ def _get_past_or_future_for_agent(self, instance_token: str, sample_token: str,
:param sample_token: Sample token for instance.
:param seconds: How many seconds of data to retrieve.
:param in_agent_frame: Whether to rotate the coordinates so the
heading is aligned with the y-axis.
heading is aligned with the y-axis. Only relevant if just_xy = True.
:param direction: 'next' for future or 'prev' for past.
:return: array of shape [n_timesteps, 2].
"""
Expand Down Expand Up @@ -220,6 +220,7 @@ def get_future_for_agent(self, instance_token: str, sample_token: str,
:param sample_token: Sample token.
:param seconds: How much future data to retrieve.
:param in_agent_frame: If true, locations are rotated to the agent frame.
Only relevant if just_xy = True.
:param just_xy: If true, returns an np.array of x,y locations as opposed to the
entire record.
:return: If just_xy, np.ndarray. Else, List of records.
Expand Down

0 comments on commit 84eda0e

Please sign in to comment.