输入元数据

metadata

metadata([callback]) ⇒ Promise.<Object> | Sharp

快速访问（未缓存的）图片元数据，无需解码任何压缩像素数据。

🌐 Fast access to (uncached) image metadata without decoding any compressed pixel data.

这是从输入图片的头部读取的。它没有考虑要应用到输出图片的任何操作，比如调整大小或旋转。

🌐 This is read from the header of the input image. It does not take into consideration any operations to be applied to the output image, such as resize or rotate.

响应中的尺寸将遵循构造函数参数的page和pages属性。

🌐 Dimensions in the response will respect the page and pages properties of the constructor parameters.

当没有提供 callback 时，会返回 Promise。

🌐 A Promise is returned when callback is not provided.

format：用于解析图片的解码器名称，例如 jpeg、png、webp、gif、svg、heif、tiff
mediaType：媒体类型（MIME 类型），例如 image/jpeg、image/png、image/svg+xml、image/avif
size：图片的总大小（以字节为单位），仅适用于流和缓冲区输入
width：宽度像素数（不考虑 EXIF 方向，请参见下面的示例）
height：高像素数（不考虑 EXIF 方向，请参见下面的示例）
space：颜色空间解释名称，例如 srgb、rgb、cmyk、lab、b-w …
channels：波段数量，例如 sRGB 的 3，CMYK 的 4
depth：像素深度格式名称，例如 uchar、char、ushort、float […]（https://www.libvips.org/API/current/enum.BandFormat.html）
density：每英寸像素数 (DPI)（如果有）
chromaSubsampling：包含 JPEG 色度子采样的字符串，RGB 用 4:2:0 或 4:4:4，CMYK 用 4:2:0:4 或 4:4:4:4
isProgressive：指示图片是否使用逐行扫描隔行扫描的布尔值
isPalette：布尔值，表示图片是否基于调色板（GIF、PNG）。
bitsPerSample：每个通道（GIF、PNG、HEIF）每个样本的位数。
pages：图片中包含的页面/帧数，支持 TIFF、HEIF、PDF、动画 GIF 和动画 WebP
pageHeight：多页图片中每页高的像素数。
loop：动画图片循环次数，零表示连续循环。
delay：动画图片中每个页面之间的延迟（以毫秒为单位），以整数数组形式提供。
pagePrimary：HEIF 图片中主页的编号
levels：以对象数组形式提供的多级图片中每个级别的详细信息，需要编译为支持 OpenSlide 的 libvips
subifds：OME-TIFF 图片中的子图片文件目录的数量
background：如果存在，则为 PNG (bKGD) 和 GIF 图片的默认背景颜色
compression：用于压缩 HEIF 文件的编码器，av1（AVIF）或 hevc（HEIC）
resolutionUnit：分辨率（密度）的单位，如果有的话，可以是 inch 或 cm
hasProfile：指示是否存在嵌入式 ICC 配置文件的布尔值
hasAlpha：指示 alpha 透明度通道是否存在的布尔值
orientation：EXIF Orientation 标头的数值（如果存在）
exif：包含原始 EXIF 数据的缓冲区（如果存在）
icc：如果有的话，包含原始 ICC 配置文件数据的缓冲区
iptc：包含原始 IPTC 数据的缓冲区（如果存在）
xmp：包含原始 XMP 数据的缓冲区（如果存在）
xmpAsString：包含 XMP 数据的字符串（如果是有效的 UTF-8 编码）。
tifftagPhotoshop：包含原始 TIFFTAG_PHOTOSHOP 数据的缓冲区（如果存在）
formatMagick：包含通过 *magick 加载的图片格式的字符串
comments：表示 PNG 文本块的关键字/文本对数组（如果存在）。
gainMap.image：HDR 增益图（如果有的话），以压缩的 JPEG 图片形式。

参数	类型	描述
[callback]	`function`	使用参数 `(err, metadata)` 调用

示例

const metadata = await sharp(input).metadata();

Example

const image = sharp(inputJpg);
image
  .metadata()
  .then(function(metadata) {
    return image
      .resize(Math.round(metadata.width / 2))
      .webp()
      .toBuffer();
  })
  .then(function(data) {
    // data contains a WebP image half the width and height of the original JPEG
  });

Example

// Get dimensions taking EXIF Orientation into account.
const { autoOrient } = await sharp(input).metadata();
const { width, height } = autoOrient;

stats

stats([callback]) ⇒ Promise.<Object>

可以访问图片中每个通道的像素衍生统计信息。当未提供 callback 时，会返回一个 Promise。

🌐 Access to pixel-derived image statistics for every channel in the image. A Promise is returned when callback is not provided.

channels：图片中每个通道的通道统计数组。每个通道统计包含
- min（通道中的最小值）
- max（通道中的最大值）
- sum（某个通道中所有数值的总和）
- squaresSum（通道中值的平方和）
- mean（某个通道中数值的平均值）
- stdev（一个通道中数值的标准差）
- minX（最小值所在像素的 x 坐标）
- minY（最小值所在像素的 y 坐标）
- maxX（最大值所在像素的 x 坐标）
- maxY（最大值所在像素的 y 坐标）
isOpaque：这张图片是完全不透明的吗？如果图片没有 alpha 通道或者每个像素都是完全不透明的，它将是 true。
entropy：基于直方图的灰度熵估计，丢弃 alpha 通道（如果有）。
sharpness：基于拉普拉斯卷积的标准差估计灰度锐度，丢弃 alpha 通道（如果有）。
dominant：包含基于 4096-bin 3D 直方图的最主要 sRGB 颜色的对象。

注意：统计数据来源于原始输入图片。对图片进行的任何操作都必须先写入缓冲区，才能在结果上运行 stats（参见第三个例子）。

参数	类型	描述
[callback]	`function`	使用参数 `(err, stats)` 调用

示例

const image = sharp(inputJpg);
image
  .stats()
  .then(function(stats) {
     // stats contains the channel-wise statistics array and the isOpaque value
  });

Example

const { entropy, sharpness, dominant } = await sharp(input).stats();
const { r, g, b } = dominant;

Example

const image = sharp(input);
// store intermediate result
const part = await image.extract(region).toBuffer();
// create new instance to obtain statistics of extracted region
const stats = await sharp(part).stats();