画像API準拠, バージョン2.1.0
このドキュメントのステータス
本バージョン: 2.1.0-草案
最新安定版: 2.1.0
目次
1. はじめに
これはIIIF画像API仕様の関連ドキュメントです。これは、APIに対する様々な準拠レベルに対応するサポート済みパラメータの集合を定義しています。
2. 準拠
3つのレベルの準拠を定義しています。レベル0は、サービスがIIIF画像API仕様に準拠していると見なすために実装しなければならない(must)パラメータと機能の最小限の集合です。レベル1は、実装すべきパラメータと機能の推奨される(recommended)集合です。下記のしかるべき項で言及されているとおり、サーバーが、すべてのサポート済みパラメータと機能のすべての組み合わせをサポートできるわけではないことに注意してください。
下記の表の「
」はサポートが必須(required)であることを示し、「
」はサポートがオプション(optional)であることを示します。
3. 画像パラメータ
3.1 領域(Region)
| 構文 | 機能名 | レベル0 | レベル1 | レベル2 |
|---|---|---|---|---|
full |
|
|
|
|
| x,y,w,h | regionByPx |
|
|
|
| pct:x,y,w,h | regionByPct |
|
|
|
square |
regionSquare |
|
|
|
サポートされない可能性があるサイズと領域の組み合わせに関してはサイズの注も参照してください。
3.2 サイズ(Size)
| 構文 | 機能名 | レベル0 | レベル1 | レベル2 |
|---|---|---|---|---|
full |
|
|
|
|
max |
|
|
|
|
| w, | sizeByW |
|
|
|
| ,h | sizeByH |
|
|
|
| pct:n | sizeByPct |
|
|
|
| !w,h | sizeByConfinedWh |
|
|
|
| w,h | sizeByDistortedWh |
|
|
|
| w,h | sizeByWh |
|
|
|
sizeAboveFull |
|
|
|
どのレベルの準拠においても、画像情報の応答にsizesプロパティーを含んでいる画像サービスは、記述されているサイズに対するリクエストをサポートしなければならず、画像情報の応答にtilesプロパティーを含んでいるサービスは、タイルに付与されているwidth、height、scaleFactorsの値で暗示しているサイズに対するリクエストをサポートしなければなりません。
サーバーが、画像に利用できるサイズの限界をmaxWidth、maxHeightおよび／またはmaxAreaというオプションのプロファイル記述プロパティーで表現できることに注意してください。指定されている上限までの画像サイズに対して、上記のサイズ・パラメータの形式をサポートしていれば、サーバーは準拠しています。クライアントは、/full/full/のような領域とサイズのパラメータの組み合わせがサポートされていると想定すべきではありません。
fullの非推奨に関する注意も参照してください。
3.3 回転(Rotation)
| 構文 | 機能名 | レベル0 | レベル1 | レベル2 |
|---|---|---|---|---|
0 |
|
|
|
|
90,180,270 |
rotationBy90s |
|
|
|
| 任意の値 | rotationArbitrary |
|
|
|
| !n | mirroring |
|
|
|
3.4 品質(Quality)
| 構文 | レベル0 | レベル1 | レベル2 |
|---|---|---|---|
default |
|
|
|
color |
|
|
(該当する場合) |
gray |
|
|
(該当する場合) |
bitonal |
|
|
|
3.5 フォーマット(Format)
| 構文 | レベル0 | レベル1 | レベル2 |
|---|---|---|---|
jpg |
|
|
|
png |
|
|
|
tif |
|
|
|
gif |
|
|
|
pdf |
|
|
|
jp2 |
|
|
|
webp |
|
|
|
4. HTTP機能
| HTTP機能 | 機能名 | レベル0 | レベル1 | レベル2 |
|---|---|---|---|---|
| base URI redirects(基底URIリダイレクト) | baseUriRedirect |
|
|
|
| CORS | cors |
|
|
|
| json-ld media type(JSON-LDメディアタイプ) | jsonldMediaType |
|
|
|
| profile link header(プロファイル・リンク・ヘッダ) | profileLinkHeader |
|
|
|
| canonical link header(正規リンク・ヘッダ) | canonicalLinkHeader |
|
|
|
5. 準拠の表示
サーバーは、画像に対するIIIF応答に次のヘッダーを含めることにより、準拠を示すことができます(may)。
Link: <http://iiif.io/api/image/2/level1.json>;rel="profile"準拠レベルのURIは、次の通りです。
| レベル | URI |
|---|---|
| 0 | http://iiif.io/api/image/2/level0.json |
| 1 | http://iiif.io/api/image/2/level1.json |
| 2 | http://iiif.io/api/image/2/level2.json |
5.1 レベル0準拠
レベル0準拠の画像サーバーは、画像情報の応答のtilesにscaleFactorsおよび／またはwidthとheightの値を指定できます(may)。レベル0準拠では、サービスは、画像情報の応答で宣言されている倍率を用いて計算したサイズの画像を提供する必要があるだけです。値が指定されている場合は、下記の特別な意味で解釈すべきです。
scaleFactors- 指定されている倍率のみがサポートされます。tiles内のwidthとheight- クライアントは、指定されている大きさの出力タイルと一致する領域のみをリクエストすべきです。
レベル0準拠画像サーバーは、full領域に利用できるサイズに対する具体的なwidthとheightの値を示すためにsizesを指定することもできます(may)。
クライアントがこれらのパラメータに当てはまらないサイズと領域の組み合わせをリクエストした場合は、画像サーバーはエラーで要求を拒否できます(may)。