# v3d

[[[Source]]](https://github.com/google-research/visu3d/tree/main/visu3d/__init__.py)

```{code-block}
import visu3d as v3d
```

```{eval-rst}
.. automodule:: visu3d
  :no-members:
```

## All symbols


### Module

|  |  |
--- | ---
[v3d](index) | Visu3d API.
[v3d.math](math/index) | Math and geometry API.
[v3d.plotly](plotly/index) | Plotly API.

### Class

|  |  |
--- | ---
[v3d.Camera](Camera) | A camera located in space.
[v3d.CameraSpec](CameraSpec) | Camera intrinsics specification.
[v3d.DataclassArray](DataclassArray) | Wrapper around `dca.DataclassArray` for all v3d objects.
[v3d.PinholeCamera](PinholeCamera) | Simple camera model.
[v3d.Point2d](Point2d) | 2d point cloud.
[v3d.Point3d](Point3d) | 3d point cloud.
[v3d.Ray](Ray) | 6d vector with position and direction.
[v3d.Spec360](Spec360) | Camera spec representing 360 panorama.
[v3d.Transform](Transform) | Affine transformation (Position, rotation and scale of an object).
[v3d.Visualizable](Visualizable) | Interface for elements which are visualizable.
[v3d.plotly.FigConfig](plotly/FigConfig) | Figure configuration options.
[v3d.plotly.TraceConfig](plotly/TraceConfig) | Configuration of a single v3d object.
[v3d.plotly.Visualizable](plotly/Visualizable) | Interface for elements which are visualizable.

### Function

|  |  |
--- | ---
[v3d.auto_plot_figs](auto_plot_figs) | Auto-display `tuple[Visualizable, ...]` as figure.
[v3d.custom_transform](custom_transform) | Custom transformation decorator.
[v3d.make_fig](make_fig) | Returns the figure from the given data.
[v3d.make_traces](make_traces) | Returns the traces from the given data.
[v3d.math.carthesian_to_spherical](math/carthesian_to_spherical) | Convert (x, y, z) to (r, theta, phi).
[v3d.math.euler_to_rot](math/euler_to_rot) | Creates a 3x3 matrix from the euler radian angles.
[v3d.math.interp_img](math/interp_img) | Bilinear interpolation of coordinates from an image.
[v3d.math.interp_points](math/interp_points) | Spline interpolation between x-d Points.
[v3d.math.is_orth](math/is_orth) | Check if the matrix is a valid orthogonal matrix `O(3)`.
[v3d.math.is_rot](math/is_rot) | Checks if a matrix is a valid rotation matrix `SO(3)`.
[v3d.math.rot_to_euler](math/rot_to_euler) | Extract euler angles from a 3x3 rotation matrix.
[v3d.math.rot_x](math/rot_x) | Rotation matrix for rotation around X (in radians).
[v3d.math.rot_y](math/rot_y) | Rotation matrix for rotation around Y (in radians).
[v3d.math.rot_z](math/rot_z) | Rotation matrix for rotation around Z (in radians).
[v3d.math.spherical_to_carthesian](math/spherical_to_carthesian) | Convert (r, theta, phi) to (x, y, z).
[v3d.math.subsample](math/subsample) | Subsample the given DataclassArray.
[v3d.plotly.make_cones_kwargs](plotly/make_cones_kwargs) | Returns the kwargs to plot cones.
[v3d.plotly.make_fig](plotly/make_fig) | Returns the figure from the given data.
[v3d.plotly.make_lines_kwargs](plotly/make_lines_kwargs) | Returns the kwargs to plot lines.
[v3d.plotly.make_lines_traces](plotly/make_lines_traces) | Trace independent lines.
[v3d.plotly.make_points](plotly/make_points) | Display a 2d or 3d point cloud.
[v3d.plotly.make_traces](plotly/make_traces) | Returns the traces from the given data.
[v3d.plotly.make_zero_point](plotly/make_zero_point) | Returns the trace corresponding to the origin (0, 0, 0) point.
[v3d.plotly.subsample](plotly/subsample) | Flatten and subsample the arrays (keeping the last dimension).
[v3d.plotly.to_xyz_dict](plotly/to_xyz_dict) | Convert np.array to xyz dict.

### Attribute

|  |  |
--- | ---
[v3d.DEG2RAD](DEG2RAD) | 
[v3d.RAD2DEG](RAD2DEG) | 
[v3d.fig_config](fig_config) | 
[v3d.math.DEG2RAD](math/DEG2RAD) | 
[v3d.math.RAD2DEG](math/RAD2DEG) | 


```{toctree}
:hidden:

math/index
plotly/index
DataclassArray
DEG2RAD
RAD2DEG
make_fig
make_traces
Visualizable
auto_plot_figs
fig_config
Camera
CameraSpec
PinholeCamera
Spec360
Point3d
Point2d
Ray
custom_transform
Transform
```