文档

图片裁剪建议

更新时间:

图片裁剪建议功能可以根据指定比例返回图片的裁剪建议框和裁剪方案的美学分数。如果指定了多个裁剪比例,该接口会按照不同的裁剪比例分别给出图片的裁剪建议。本文介绍如何使用图片裁剪建议功能。

使用场景

  • 社交媒体与个人用途:适配各类社交平台标准,个性化头像和背景制作。

  • 印刷与广告:广告设计,宣传材料制作,以及打印媒体的尺寸调整。

  • 安全与认证:身份证明文件照片裁剪,如驾照、护照照片规格适配。

说明

图片裁剪建议功能只返回裁剪框信息,不对源地址中存储的图片进行裁剪。

前提条件

使用方法

调用DetectImageCropping - 通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域接口获取目标图片比例下视觉效果较好的裁剪框区域。

图片裁剪信息

  • IMM项目名称:test-project

  • 待裁剪图片的存储地址:oss://test-bucket/test-object.jpg

  • 裁剪比例:1:116:9auto(自动设置)

  • 图片示例:

    test-object

请求示例

{
    "ProjectName": "test-project",
    "SourceURI": "oss://test-bucket/test-object.jpg",
    "AspectRatios": "[\"1:1\",\"16:9\",\"auto\"]"
}

返回示例

{
  "RequestId": "AFD39290-659F-5474-AFF5-5640CB140405",
  "Croppings": [
    {
      "AspectRatio": "1:1",
      "Confidence": 0.481,
      "Boundary": {
        "Left": 14,
        "Top": 39,
        "Height": 200,
        "Width": 200
      }
    },
    {
      "AspectRatio": "16:9",
      "Confidence": 0.748,
      "Boundary": {
        "Left": 24,
        "Top": 39,
        "Height": 200,
        "Width": 355
      }
    },
    {
      "AspectRatio": "auto",
      "Confidence": 0.844,
      "Boundary": {
        "Left": 18,
        "Top": 13,
        "Height": 250,
        "Width": 366
      }
    }
  ]
}

裁剪建议说明

根据返回示例,图片的裁剪建议如下表所示。

裁剪比例

具体参数

1:1

  • 图片高度:200 px

  • 图片宽度:200 px

  • 裁剪起点横坐标(默认左上角为原点):14 px

  • 裁剪起点纵坐标(默认左上角为原点):39 px

16:9

  • 图片高度:200 px

  • 图片宽度:355 px

  • 裁剪起点横坐标(默认左上角为原点):24 px

  • 裁剪起点纵坐标(默认左上角为原点):39 px

auto(自动设置)

  • 图片高度:250 px

  • 图片宽度:366 px

  • 裁剪起点横坐标(默认左上角为原点):18 px

  • 裁剪起点纵坐标(默认左上角为原点):13 px

重要
  • 如果指定起点的横纵坐标大于原图,将会返回BadRequest错误,错误信息为Advance cut's position is out of image.

  • 如果从起点开始指定的宽度和高度超过了原图,将会直接裁剪到原图边界为止。

示例代码

以Python SDK为例,图片裁剪建议的完整示例代码如下。

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
import os
from typing import List

from alibabacloud_imm20200930.client import Client as imm20200930Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_imm20200930 import models as imm_20200930_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client(
        access_key_id: str,
        access_key_secret: str,
    ) -> imm20200930Client:
        """
        使用AccessKey ID&AccessKey Secret初始化账号Client。
        @param access_key_id:
        @param access_key_secret:
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config(
            access_key_id=access_key_id,
            access_key_secret=access_key_secret
        )
        # 填写访问的IMM域名。
        config.endpoint = f'imm.cn-beijing.aliyuncs.com'
        return imm20200930Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        # 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
        # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
        # 本示例通过从环境变量中读取AccessKey,来实现API访问的身份验证。如何配置环境变量,请参见https://help.aliyun.com/document_detail/2361894.html。
        imm_access_key_id = os.getenv("AccessKeyId")
        imm_access_key_secret = os.getenv("AccessKeySecret")
        # 初始化客户端。
        client = Sample.create_client(imm_access_key_id, imm_access_key_secret)
        detect_image_cropping_request = imm_20200930_models.DetectImageCroppingRequest(
            project_name='test-project',
            source_uri='oss://test-bucket/test-object.jpg',
            aspect_ratios='["1:1","16:9","auto"]'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印API的返回值。
            client.detect_image_cropping_with_options(detect_image_cropping_request, runtime)
        except Exception as error:
            # 如有需要,请打印错误信息。
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        # 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
        # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
        # 本示例通过从环境变量中读取AccessKey,来实现API访问的身份验证。如何配置环境变量,请参见https://help.aliyun.com/document_detail/2361894.html。
        imm_access_key_id = os.getenv("AccessKeyId")
        imm_access_key_secret = os.getenv("AccessKeySecret")
        # 初始化客户端。
        client = Sample.create_client(imm_access_key_id, imm_access_key_secret)
        detect_image_cropping_request = imm_20200930_models.DetectImageCroppingRequest(
            project_name='test-project',
            source_uri='oss://test-bucket/test-object.jpg',
            aspect_ratios='["1:1","16:9","auto"]'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印API的返回值。
            await client.detect_image_cropping_with_options_async(detect_image_cropping_request, runtime)
        except Exception as error:
            # 如有需要,请打印错误信息。
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])