Transformers.js 文档

utils/image

Transformers.js

您正在查看的是需要从源码安装。如果您希望进行常规的 npm 安装，请查看最新的稳定版本 (v3.0.0)。

加入 Hugging Face 社区

并获得增强的文档体验

在模型、数据集和 Spaces 上进行协作

通过加速推理获得更快的示例

切换文档主题

开始使用

utils/image

用于图像处理的辅助模块。

这些函数和类仅供内部使用，这意味着最终用户无需访问此处。

utils/image
- 静态
  - .RawImage
    - 新 RawImage(data, width, height, channels)
    - 实例
      - .size ⇒ *
      - .grayscale() ⇒ RawImage
      - .rgb() ⇒ RawImage
      - .rgba() ⇒ RawImage
      - .putAlpha(mask) ⇒ RawImage
      - .resize(width, height, options) ⇒ Promise.<RawImage>
      - .split() ⇒ Array.<RawImage>
      - .clone() ⇒ RawImage
      - .convert(numChannels) ⇒ RawImage
      - .save(path)
    - 静态
      - .read(input) ⇒ *
      - .fromCanvas(canvas) ⇒ RawImage
      - .fromURL(url) ⇒ Promise.<RawImage>
      - .fromBlob(blob) ⇒ Promise.<RawImage>
      - .fromTensor(tensor)
  - .load_image
- 内部
  - ~CONTENT_TYPE_MAP

utils/image.RawImage

类型：utils/image 的静态类

.RawImage
- 新 RawImage(data, width, height, channels)
- 实例
  - .size ⇒ *
  - .grayscale() ⇒ RawImage
  - .rgb() ⇒ RawImage
  - .rgba() ⇒ RawImage
  - .putAlpha(mask) ⇒ RawImage
  - .resize(width, height, options) ⇒ Promise.<RawImage>
  - .split() ⇒ Array.<RawImage>
  - .clone() ⇒ RawImage
  - .convert(numChannels) ⇒ RawImage
  - .save(path)
- 静态
  - .read(input) ⇒ *
  - .fromCanvas(canvas) ⇒ RawImage
  - .fromURL(url) ⇒ Promise.<RawImage>
  - .fromBlob(blob) ⇒ Promise.<RawImage>
  - .fromTensor(tensor)

新 RawImage(data, width, height, channels)

创建一个新的 RawImage 对象。

参数量	类型	描述
数据	`Uint8ClampedArray` \| `Uint8Array`	像素数据。
宽度	`数字`	图像的宽度。
高度	`数字`	图像的高度。
通道	`1` \| `2` \| `3` \| `4`	通道数。

rawImage.size ⇒ <code> * </code>

返回图像的尺寸（宽度，高度）。

类型：RawImage 的实例属性
返回：* - 图像的尺寸（宽度，高度）。

rawImage.grayscale() ⇒ <code> RawImage </code>

将图像转换为灰度格式。

类型：RawImage 的实例方法
返回：RawImage - this 以支持链式调用。

rawImage.rgb() ⇒ <code> RawImage </code>

将图像转换为 RGB 格式。

类型：RawImage 的实例方法
返回：RawImage - this 以支持链式调用。

rawImage.rgba() ⇒ <code> RawImage </code>

将图像转换为 RGBA 格式。

类型：RawImage 的实例方法
返回：RawImage - this 以支持链式调用。

rawImage.putAlpha(mask) ⇒ <code> RawImage </code>

将 alpha 蒙版应用于图像。原地操作。

类型：RawImage 的实例方法
返回：RawImage - 被遮罩的图像。
抛出:

如果蒙版与图像大小不同，则会抛出 Error。
如果图像不包含 4 个通道，则会抛出 Error。
如果蒙版不是单通道，则会抛出 Error。

参数量	类型	描述
蒙版	`RawImage`	要应用的蒙版。它应该只有一个通道。

rawImage.resize(width, height, options) ⇒ <code> Promise. < RawImage > </code>

将图像调整为给定尺寸。此方法使用 canvas API 执行调整大小。

类型：RawImage 的实例方法
返回：Promise.<RawImage> - this 以支持链式调用。

参数量	类型	描述
宽度	`数字`	新图像的宽度。`null` 或 `-1` 将保留宽高比。
高度	`数字`	新图像的高度。`null` 或 `-1` 将保留宽高比。
选项	`Object`	用于调整大小的其他选项。
[options.resample]	`0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `string`	要使用的重采样方法。

rawImage.split() ⇒ <code> Array. < RawImage > </code>

将此图像分割为单个波段。此方法从图像返回单个图像波段的数组。例如，分割“RGB”图像将创建三个新图像，每个图像包含原始波段之一（红色、绿色、蓝色）的副本。

灵感来自 PIL 的 Image.split() 函数。

类型：RawImage 的实例方法
返回：Array.<RawImage> - 包含波段的数组。

rawImage.clone() ⇒ <code> RawImage </code>

克隆图像

类型：RawImage 的实例方法
返回：RawImage - 克隆的图像

rawImage.convert(numChannels) ⇒ <code> RawImage </code>

将图像转换为指定通道数的辅助方法

类型：RawImage 的实例方法
返回：RawImage - this 以支持链式调用。

参数量	类型	描述
通道数	`数字`	通道数。必须为 1、3 或 4。

rawImage.save(path)

将图像保存到给定路径。

类型：RawImage 的实例方法

参数量	类型	描述
路径	`字符串`	保存图像的路径。

RawImage.read(input) ⇒ <code> * </code>

用于从各种输入类型读取图像的辅助方法。

类型：RawImage 的静态方法
返回：* - 图像对象。

示例： 从 URL 读取图像。

let image = await RawImage.read('https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/football-match.jpg');
// RawImage

参数量	类型
输入	`RawImage` \| `string` \| `URL` \| `Blob` \| `HTMLCanvasElement` \| `OffscreenCanvas`

RawImage.fromCanvas(canvas) ⇒ <code> RawImage </code>

从画布读取图像。

类型：RawImage 的静态方法
返回：RawImage - 图像对象。

参数量	类型	描述
画布	`HTMLCanvasElement` \| `OffscreenCanvas`	要从中读取图像的画布。

RawImage.fromURL(url) ⇒ <code> Promise. < RawImage > </code>

从 URL 或文件路径读取图像。

类型：RawImage 的静态方法
返回：Promise.<RawImage> - 图像对象。

参数量	类型	描述
网址	`string` \| `URL`	要从中读取图像的 URL 或文件路径。

RawImage.fromBlob(blob) ⇒ <code> Promise. < RawImage > </code>

从 Blob 创建新图像的辅助方法。

类型：RawImage 的静态方法
返回：Promise.<RawImage> - 图像对象。

参数量	类型	描述
Blob	`Blob`	要从中读取图像的 Blob。

RawImage.fromTensor(tensor)

从张量创建新图像的辅助方法

类型：RawImage 的静态方法

参数量	类型
张量	`张量`

utils/image.load_image

从 URL、路径等加载图像的辅助函数。

类型：utils/image 的静态常量

utils/image~CONTENT_TYPE_MAP

文件扩展名到 MIME 类型的映射。

类型：utils/image 的内部常量

< > 在 GitHub 上更新

←Hub Audio→