Imgix APIsレンダリング API背景背景除去の透過しきい値

背景除去の透過しきい値

bg-remove-transparency-threshold

bg-remove-transparency-threshold パラメータは、ソース画像に既に存在する透過度の量に基づいて、背景除去処理を適用するかどうかを制御します。

画像の透過度が指定されたしきい値を上回る場合、背景除去はスキップされます。透過度がしきい値以下または等しい場合は、背景除去が適用されます。

このパラメータは、透過度のしきい値を表す 0.0 から 1.0 の間の float 値を受け取ります。例:

  • 0.0: 透過がまったくない画像のみ、背景が削除されます。1ピクセルでも透過がある場合、背景の削除はスキップされます
  • 0.2 (デフォルト): 画像の 20% 以上 が透過している場合は背景除去をスキップ
  • 1.0: 画像の透過度に関係なく、背景除去を決してスキップしない

初回レンダリング時のみ適用

このパラメータは、画像の最初のレンダリング時にのみ適用されます。同じ画像に対する後続のリクエストでは、透過しきい値は再評価されません。

透過しきい値を再評価するには、パージツール を使用してキャッシュから画像をパージしてください。

61% の透過度 を持つサンプル画像を参照してください:

透過度 > 60%:背景除去をスキップ
sandbox-demo
透過度 ≤ 70%:背景除去を適用
sandbox-demo

トラブルシューティング

画像の透過度は、fm=json パラメータを使用することで確認できます。これにより TransparentPercentage プロパティが表示されます:

GET https://assets.imgix.net/docs/digital-art-03-transparency.png?fm=json
{
  ...
  "TransparentPercentage": 0.609987,
  ...
}

透過しきい値に基づいて背景除去がスキップされた場合、その旨を示すヘッダーがレスポンスに返されます:

curl -I https://assets.imgix.net/docs/digital-art-03-60.png?bg-remove=true&bg-remove-transparency-threshold=.6

HTTP/2 200
x-imgix-bg-remove-failure-reason: Transparency threshold exceeded

使用方法

このパラメータは、既に背景が除去されている画像に対して不要な処理を避けるために使用されます。追加の背景除去は、望ましくない結果を引き起こす可能性があります。