# apply_depth_colormap

Python API: `depthai_nodes.node.apply_depth_colormap`

## Classes

### ApplyDepthColormap

一个主机节点，它使用基于百分位数归一化来减少闪烁，将颜色映射应用于深度图。

适用于 RAW 2D dai.ImgFrame 输出，例如 stereo.depth 和 stereo.disparity 帧。百分位数归一化通常对 stereo.depth 更为有利，因为视差通常具有固定的输出范围。

计算百分位数时会忽略无效深度值 (<= 0)，并在输出中将其渲染为黑色。

输入：

 * `frame : dai.ImgFrame`：包含要着色的 2D 数组的输入消息。

输出：

 * `output : dai.ImgFrame`：着色输出帧（3 通道 BGR）。

参数

 * `colormapValue`：OpenCV 颜色映射枚举（例如 cv2.COLORMAP_JET）或自定义的 OpenCV 兼容颜色映射 LUT。默认为 cv2.COLORMAP_JET。
 * `pLow`：下限归一化百分位数，范围为 [0, 100)。默认为 2.0。
 * `pHigh`：上限归一化百分位数，范围为 (0, 100]。默认为 98.0。

#### 方法

##### init

```python
def __init__(colormapValue: int | np.ndarray = cv2.COLORMAP_JET, pLow: float = 2.0, pHigh: float = 98.0):
```

初始化图像处理节点。

参数

 * `colormapValue` (`int | np.ndarray`)：OpenCV 颜色映射枚举（例如 cv2.COLORMAP_JET）或自定义的 OpenCV 兼容颜色映射 LUT。默认为 cv2.COLORMAP_JET。
 * `pLow` (`float`)：下限归一化百分位数，范围为 [0, 100)。默认为 2.0。
 * `pHigh` (`float`)：上限归一化百分位数，范围为 (0, 100]。默认为 98.0。

##### build

```python
def build(frame: dai.Node.Output) -> ApplyDepthColormap:
```

将输入深度流连接到节点。

参数

 * `frame` (`dai.Node.Output`)：生成 RAW 深度 dai.ImgFrame 的上游输出。

返回

 * `ApplyDepthColormap`：配置好的节点实例。

##### process

```python
def process(frame: dai.Buffer):
```

对有效深度样本进行着色，并输出带有源元数据的图像。

参数

 * `frame` (`dai.Buffer`)：RAW 深度或视差 ImgFrame。非正像素变为黑色。没有可用归一化范围的帧会生成全黑图像。

引发

 * `TypeError`：如果输入不是具有 RAW 格式的 ImgFrame。

##### setColormap

```python
def setColormap(colormapValue: int | np.ndarray):
```

设置应用于深度图像的颜色映射。

参数

 * `colormapValue` (`int | np.ndarray`)：OpenCV 颜色映射枚举值或自定义的 OpenCV 兼容 LUT。

引发

 * `ValueError`：如果自定义颜色映射不是形状为 `(256, 1, 3)` 的 uint8 数组。

##### setPercentileRange

```python
def setPercentileRange(low: float, high: float):
```

设置用于归一化的百分位数裁剪范围。

参数

 * `low` (`float`)：范围 [0, 100) 中的下限百分位数。
 * `high` (`float`)：范围 (0, 100] 中的上限百分位数。

引发

 * `ValueError`：如果边界不满足 `0 <= low < high <= 100`。
