> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sdk-testing-latest.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# box3d()

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/sdk/data_types/object_3d.py#L122" />

## <kbd>function</kbd> box3d

```python theme={null}
*,
center: 'npt.ArrayLike',
size: 'npt.ArrayLike',
orientation: 'npt.ArrayLike',
color: 'RGBColor',
label: 'str | None' = None,
score: 'numeric | None' = None
```

## Description

A 3D bounding box. The box is specified by its center, size and orientation.

## Args

* `center`: The center point of the box as a length-3 ndarray.
* `size`: The box's X, Y and Z dimensions as a length-3 ndarray.
* `orientation`: The rotation transforming global XYZ coordinates into the box's local XYZ coordinates, given as a length-4 ndarray \[r, x, y, z] corresponding to the non-zero quaternion r + xi + yj + zk.
* `color`: The box's color as an (r, g, b) tuple with `0 <= r,g,b <= 1`.
* `label`: An optional label for the box.
* `score`: An optional score for the box. Typically used to indicate the confidence of a detection.

## Returns

A Box3D object.

## Examples

The following example creates a point cloud with 60 boxes rotating
around the X, Y and Z axes.

```python theme={null}
import wandb

import math
import numpy as np
from scipy.spatial.transform import Rotation


with wandb.init() as run:
    run.log(
        {
            "points": wandb.Object3D.from_point_cloud(
                points=np.random.uniform(-5, 5, size=(100, 3)),
                boxes=[
                    wandb.box3d(
                        center=(0.3 * t - 3, 0, 0),
                        size=(0.1, 0.1, 0.1),
                        orientation=Rotation.from_euler(
                            "xyz", [t * math.pi / 10, 0, 0]
                        ).as_quat(),
                        color=(0.5 + t / 40, 0.5, 0.5),
                        label=f"box {t}",
                        score=0.9,
                    )
                    for t in range(20)
                ]
                + [
                    wandb.box3d(
                        center=(0, 0.3 * t - 3, 0.3),
                        size=(0.1, 0.1, 0.1),
                        orientation=Rotation.from_euler(
                            "xyz", [0, t * math.pi / 10, 0]
                        ).as_quat(),
                        color=(0.5, 0.5 + t / 40, 0.5),
                        label=f"box {t}",
                        score=0.9,
                    )
                    for t in range(20)
                ]
                + [
                    wandb.box3d(
                        center=(0.3, 0.3, 0.3 * t - 3),
                        size=(0.1, 0.1, 0.1),
                        orientation=Rotation.from_euler(
                            "xyz", [0, 0, t * math.pi / 10]
                        ).as_quat(),
                        color=(0.5, 0.5, 0.5 + t / 40),
                        label=f"box {t}",
                        score=0.9,
                    )
                    for t in range(20)
                ],
            ),
        }
    )
```
