---
name: "enhanceCalibrationForImage"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.4.1" }
  - { name: "@ray-js/ray", version: "1.7.37" }
platform:
  - "iOS"
  - "Android"
async: true
title: "enhanceCalibrationForImage - 图像畸变校正"
---

## enhanceCalibrationForImage

> [VERSION] AIKit >= 1.4.1 | @ray-js/ray >= 1.7.37

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

图像畸变矫正处理

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `trace_id` | `string` | 是 | - | `2.1.0` | 链路id |
| `device_id` | `string` | 是 | - | `2.1.0` | 设备id |
| `scene_type` | `string` | 是 | - | `2.1.0` | 业务类型 |
| `inputImagePath` | `string` | 是 | - | `1.4.1` | 图片输入路径 |
| `outputImagePath` | `string` | 是 | - | `1.4.1` | 图片输出路径 |
| `interpolationType` | `1 \| 2 \| 3 \| 4 \| 5` | 否 | `1` | `1.4.1` | 插值类型 |
| `ratio` | `number` | 是 | - | `1.4.1` | 比例 |
| `fCx` | `number` | 是 | - | `1.4.1` | 相机内参 Cx |
| `fCy` | `number` | 是 | - | `1.4.1` | 相机内参 Cy |
| `fFx` | `number` | 是 | - | `1.4.1` | 相机内参 Fx |
| `fFy` | `number` | 是 | - | `1.4.1` | 相机内参 Fy |
| `fK1` | `number` | 是 | - | `1.4.1` | 相机径向畸变系数 K1 |
| `fK2` | `number` | 是 | - | `1.4.1` | 相机径向畸变系数 K2 |
| `fK3` | `number` | 是 | - | `1.4.1` | 相机径向畸变系数 K3 |
| `fP1` | `number` | 是 | - | `1.4.1` | 相机切向畸变系数 P1 |
| `fP2` | `number` | 是 | - | `1.4.1` | 相机切向畸变系数 P2 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `outputImagePath` | `string` | `1.4.1` | 图片地址 |
| `enhanceSuccess` | `boolean` | `1.4.1` | 是否处理成功 |
| `enhanceFaileReason` | `string` | `1.4.1` | 处理失败原因 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 合法值

##### `interpolationType` 合法值

| 值 | 说明 |
| --- | --- |
| `1` | 默认,BILINEAR |
| `2` | BILINEAR |
| `3` | BICUBIC |
| `4` | LANZCOS |
| `5` | EDGE |


### 示例代码

#### 基础调用

```tsx
import { ai } from '@ray-js/ray'

const { enhanceCalibrationForImage } = ai;

enhanceCalibrationForImage({
  trace_id: 'example',
  device_id: 'device_001',
  scene_type: 'example',
  inputImagePath: 'example',
  outputImagePath: 'example',
  ratio: 0,
  fCx: 0,
  fCy: 0,
  fFx: 0,
  fFy: 0,
  fK1: 0,
  fK2: 0,
  fK3: 0,
  fP1: 0,
  fP2: 0,
  success: (result) => {
    console.log('enhanceCalibrationForImage success', result);
  },
  fail: (error) => {
    console.log('enhanceCalibrationForImage fail', error.errorMsg);
  },
});
```