# img_frame_overlay

Python API: `depthai_nodes.node.img_frame_overlay`

## 类

### ImgFrameOverlay

将两个图像流混合成一个帧。

参数

 * `alpha`: 背景权重，介于 0 和 1 之间。默认值 0.5 使背景和前景具有相同的权重。
 * `preserveBackground`: 在前景为零的地方保留背景像素。

#### 方法

##### init

```python
def __init__(alpha: float = 0.5, preserveBackground: bool = False):
```

初始化图像处理节点。

参数

 * `alpha` (`float`): 背景权重，介于 0 和 1 之间。默认值 0.5 使背景和前景具有相同的权重。
 * `preserveBackground` (`bool`): 在前景为零的地方保留背景像素。

##### build

```python
def build(frame1: dai.Node.Output, frame2: dai.Node.Output, alpha: float | None = None, preserveBackground: bool | None = None) -> ImgFrameOverlay:
```

连接输入流并可选地更新叠加设置。

参数

 * `frame1` (`dai.Node.Output`): 产生背景帧的上游输出。
 * `frame2` (`dai.Node.Output`): 产生前景帧的上游输出。
 * `alpha` (`float | None`): 背景帧的可选混合权重。
 * `preserveBackground` (`bool | None`): 可选覆盖，用于确定零值前景像素是否保留背景帧。

返回

 * `ImgFrameOverlay`: 配置好的节点实例。

##### process

```python
def process(frame1: dai.Buffer, frame2: dai.Buffer):
```

混合同步的背景和前景帧并发出结果。

参数

 * `frame1` (`dai.Buffer`): 背景图像帧。
 * `frame2` (`dai.Buffer`): 前景图像帧，在混合前调整为背景尺寸。

##### setAlpha

```python
def setAlpha(alpha: float):
```

设置叠加过程中使用的背景贡献。

参数

 * `alpha` (`float`): 混合输出中背景帧的权重。

##### setPreserveBackground

```python
def setPreserveBackground(preserveBackground: bool):
```

设置零值前景像素是否保留背景。

参数

 * `preserveBackground` (`bool`): 如果为 True，前景帧中的零区域在输出图像中将被忽略。

#### 属性

##### out

混合 `dai.ImgFrame` 消息的输出流。
