Transformers.js 文件

utils/image

您正在檢視的是需要從原始碼安裝。如果您希望進行常規的 npm 安裝,請檢視最新的穩定版本 (v3.0.0)。
Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

utils/image

用於影像處理的輔助模組。

這些函式和類僅供內部使用,這意味著終端使用者無需訪問此處。


utils/image.RawImage

型別utils/image 的靜態類


新 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> - 影像物件。

引數量型別描述
BlobBlob

要從中讀取影像的 Blob。


RawImage.fromTensor(tensor)

從張量建立新影像的輔助方法

型別RawImage 的靜態方法

引數量型別
張量張量

utils/image.load_image

從 URL、路徑等載入影像的輔助函式。

型別utils/image 的靜態常量


utils/image~CONTENT_TYPE_MAP

副檔名到 MIME 型別的對映。

型別utils/image 的內部常量


< > 在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.