Commit 1f3164f8 authored by zhangwenwei's avatar zhangwenwei
Browse files

Update docs

parent 75d96044
...@@ -10,6 +10,7 @@ class Box3DMode(IntEnum): ...@@ -10,6 +10,7 @@ class Box3DMode(IntEnum):
Coordinates in LiDAR: Coordinates in LiDAR:
.. code-block:: none .. code-block:: none
up z x front up z x front
^ ^ ^ ^
| / | /
...@@ -20,6 +21,7 @@ class Box3DMode(IntEnum): ...@@ -20,6 +21,7 @@ class Box3DMode(IntEnum):
Coordinates in camera: Coordinates in camera:
.. code-block:: none .. code-block:: none
x right x right
/ /
/ /
...@@ -33,6 +35,7 @@ class Box3DMode(IntEnum): ...@@ -33,6 +35,7 @@ class Box3DMode(IntEnum):
Coordinates in Depth mode: Coordinates in Depth mode:
.. code-block:: none .. code-block:: none
up z x right up z x right
^ ^ ^ ^
| / | /
...@@ -57,7 +60,8 @@ class Box3DMode(IntEnum): ...@@ -57,7 +60,8 @@ class Box3DMode(IntEnum):
dst (BoxMode): the target Box mode dst (BoxMode): the target Box mode
Returns: Returns:
The converted box of the same type. (tuple | list | np.ndarray | torch.Tensor):
The converted box of the same type.
""" """
if src == dst: if src == dst:
return box return box
......
...@@ -10,6 +10,7 @@ class CAMInstance3DBoxes(BaseInstance3DBoxes): ...@@ -10,6 +10,7 @@ class CAMInstance3DBoxes(BaseInstance3DBoxes):
Coordinates in camera: Coordinates in camera:
.. code-block:: none .. code-block:: none
x right x right
/ /
/ /
...@@ -18,6 +19,7 @@ class CAMInstance3DBoxes(BaseInstance3DBoxes): ...@@ -18,6 +19,7 @@ class CAMInstance3DBoxes(BaseInstance3DBoxes):
| |
v v
down y down y
The relative coordinate of bottom center in a CAM box is [0.5, 1.0, 0.5], The relative coordinate of bottom center in a CAM box is [0.5, 1.0, 0.5],
and the yaw is around the y axis, thus the rotation axis=1. and the yaw is around the y axis, thus the rotation axis=1.
...@@ -48,6 +50,7 @@ class CAMInstance3DBoxes(BaseInstance3DBoxes): ...@@ -48,6 +50,7 @@ class CAMInstance3DBoxes(BaseInstance3DBoxes):
(x0y0z0, x0y0z1, x0y1z1, x0y1z0, x1y0z0, x1y0z1, x1y1z0, x1y1z1) (x0y0z0, x0y0z1, x0y1z1, x0y1z0, x1y0z0, x1y0z1, x1y1z0, x1y1z1)
.. code-block:: none .. code-block:: none
front z front z
/ /
/ /
......
...@@ -10,6 +10,7 @@ class LiDARInstance3DBoxes(BaseInstance3DBoxes): ...@@ -10,6 +10,7 @@ class LiDARInstance3DBoxes(BaseInstance3DBoxes):
Coordinates in LiDAR: Coordinates in LiDAR:
.. code-block:: none .. code-block:: none
up z x front up z x front
^ ^ ^ ^
| / | /
...@@ -45,6 +46,7 @@ class LiDARInstance3DBoxes(BaseInstance3DBoxes): ...@@ -45,6 +46,7 @@ class LiDARInstance3DBoxes(BaseInstance3DBoxes):
(x0y0z0, x0y0z1, x0y1z1, x0y1z0, x1y0z0, x1y0z1, x1y1z0, x1y1z1) (x0y0z0, x0y0z1, x0y1z1, x0y1z0, x1y0z0, x1y0z1, x1y1z0, x1y1z1)
.. code-block:: none .. code-block:: none
up z up z
front x ^ front x ^
/ | / |
...@@ -57,6 +59,7 @@ class LiDARInstance3DBoxes(BaseInstance3DBoxes): ...@@ -57,6 +59,7 @@ class LiDARInstance3DBoxes(BaseInstance3DBoxes):
| / oriign | / | / oriign | /
left y<-------- + ----------- + (x0, y1, z0) left y<-------- + ----------- + (x0, y1, z0)
(x0, y0, z0) (x0, y0, z0)
Returns: Returns:
torch.Tensor: corners of each box with size (N, 8, 3) torch.Tensor: corners of each box with size (N, 8, 3)
""" """
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment