Transformers.js 文档

utils/image

Transformers.js

您正在查看 main 版本，该版本需要从源代码安装。如果您想要常规 npm 安装，请查看最新的稳定版本 (v3.0.0)。

加入 Hugging Face 社区

并获得增强的文档体验

协作处理模型、数据集和 Spaces

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

切换文档主题

开始使用

utils/image

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

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

utils/image
- 静态
  - .RawImage
    - new 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

Kind: static class of utils/image

.RawImage
- new 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)

new RawImage(data, width, height, channels)

创建一个新的 RawImage 对象。

参数	类型	描述
data	`Uint8ClampedArray` \| `Uint8Array`	像素数据。
width	`number`	图像的宽度。
height	`number`	图像的高度。
channels	`1` \| `2` \| `3` \| `4`	通道数。

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

返回图像的大小（宽度，高度）。

Kind: instance property of RawImage
Returns: * - 图像的大小（宽度，高度）。

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

将图像转换为灰度格式。

Kind: instance method of RawImage
Returns: RawImage - this 以支持链式调用。

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

将图像转换为 RGB 格式。

Kind: instance method of RawImage
Returns: RawImage - this 以支持链式调用。

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

将图像转换为 RGBA 格式。

Kind: instance method of RawImage
Returns: RawImage - this 以支持链式调用。

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

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

Kind: instance method of RawImage
Returns: RawImage - 已蒙版的图像。
抛出:

Error 如果蒙版与图像大小不一致。
Error 如果图像没有 4 个通道。
Error 如果蒙版不是单通道。

参数	类型	描述
mask	`RawImage`	要应用的蒙版。它应具有单通道。

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

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

Kind: instance method of RawImage
Returns: Promise.<RawImage> - this 以支持链式调用。

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

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

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

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

Kind: instance method of RawImage
Returns: Array.<RawImage> - 包含波段的数组。

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

克隆图像

Kind: instance method of RawImage
Returns: RawImage - 克隆的图像

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

用于转换图像以具有特定通道数的辅助方法

Kind: instance method of RawImage
Returns: RawImage - this 以支持链式调用。

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

rawImage.save(path)

将图像保存到给定路径。

Kind: instance method of RawImage

参数	类型	描述
path	`string`	要将图像保存到的路径。

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

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

Kind: static method of RawImage
Returns: * - 图像对象。

Example: 从 URL 读取图像。

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

参数	类型
input	`RawImage` \| `string` \| `URL` \| `Blob` \| `HTMLCanvasElement` \| `OffscreenCanvas`

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

从 canvas 读取图像。

Kind: static method of RawImage
Returns: RawImage - 图像对象。

参数	类型	描述
canvas	`HTMLCanvasElement` \| `OffscreenCanvas`	从中读取图像的 canvas。

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

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

Kind: static method of RawImage
Returns: Promise.<RawImage> - 图像对象。

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

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

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

Kind: static method of RawImage
Returns: Promise.<RawImage> - 图像对象。

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

RawImage.fromTensor(tensor)

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

Kind: static method of RawImage

参数	类型
tensor	`Tensor`

utils/image.load_image

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

Kind: static constant of utils/image

utils/image~CONTENT_TYPE_MAP

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

Kind: inner constant of utils/image

< > 在 GitHub 上更新

←Hub 音频→