Anatomography map API configuration

Common configuration category

バージョン、ツリーなどのリクエスト全体に共通のconfiguration parameter群を設定します。

Configuration parameter

"Common" categoryには以下のパラメータが存在します。

Configuration category デフォルト値 説明 指定可能な値
"Common":{ パラメータの連想配列
"Model": "bp3d" キット（3Dモデル）名 "bp3d"
"Version": (リクエスト時の最新版) 3Dデータのバージョン。未指定の場合には最新版が自動選択されます。 "2.0"|"3.0"|"4.0"|"4.1"
"AnatomogramVersion": "20110318" パラメータ記載文法のバージョン "20110318"
"ScalarMaximum": 65535 Choropleth Mapの最大値 ScalarMinimumより大きい任意の整数
"ScalarMinimum": -65535 Choropleth Mapの最小値 ScalarMaximumより小さい任意の整数
"ColorbarFlag": false Choropleth Mapのカラーチャートバーの表示有無 true|false
"ScalarColorFlag": false フラグをtrueにしたパーツをChoropleth Map表示 true|false
"TreeName": "isa" パーツデータ組合せに利用するFMAツリーを指定します "isa"|"partof"
"DateTime": (none) configuration作成時のタイムスタンプ "YYYYMMDDhhmmss"
"CoordinateSystemName": "bp3d" 3Dモデル空間名 "bp3d"
"CopyrightType": "" DBCLSのコピーライトを画像中に描画するサイズ（未指定の場合には描画しません） ""|"large"|"medium"|"small"
"PinDescriptionDrawFlag": false 画像へのピン説明の描画有無 true|false
"PinIndicationLineDrawFlag": 0 ピンとピン説明の間に描画する線の設定（1:ピン先端、2：ピン終端、0：線無し） 0|1|2
}

パラメータの使用例

バージョンを指定する（"Version"パラメータ）

"Common"カテゴリの"Version"パラメータが未指定の場合には、自動的にリクエスト時の最新バージョンが選択されます。
そのため、バージョンを指定せずにmap APIを利用している場合、新たなバージョンが公開された時点で、得られる情報が変わってしまう場合があります。
この問題を防ぐためには、明示的にバージョンを指定して、map APIのconfiguration parameterを構築する必要があります。

・バージョンを指定しない場合


・バージョンを指定した場合（"Version"パラメータを明示的"4.1"に指定）

Choropleth Mapを作成する（"ScalarColorFlag"、"ScalarMaximum"、"ScalarMinimum"、"ColorbarFlag"パラメータ）

"Common"カテゴリの"ScalarColorFlag"パラメータをtrueに指定すると、各パーツに設定された"PartScalar"の値に応じたChoropleth Mapで描画することができるようになります。
Choropleth Map表示をするには、"Part"カテゴリの"PartScalar"および"ScalarColorFlag"パラメータも同時に設定する必要があります。
例えば、下記のようなデータがある場合、

Parts Name Value
Stomach 10000
Pancreas 42000
Gallbladder 481
Right kidney -1589
Left kidney -20000

全てのパーツをChoropleth Map表示する場合には、"Part"カテゴリのJSONは下記のような構成になります。
"Part":[
{"PartName":"Stomach","PartScalar":10000,"ScalarColorFlag":true},
{"PartName":"Pancreas","PartScalar":42000,"ScalarColorFlag":true},
{"PartName":"Gallbladder","PartScalar":481,"ScalarColorFlag":true},
{"PartName":"Right kidney","PartScalar":-1589,"ScalarColorFlag":true},
{"PartName":"Left kidney","PartScalar":-20000,"ScalarColorFlag":true}
]

このパラメータを"Common"カテゴリの"ScalarColorFlag"をtrueにしたmap API URLに埋め込みます。
※"PartName"はFMA Preferred Nameを指定する必要があります。ここでは説明上"PartName"パラメータを利用していますが、あらかじめFMA IDに置き換えて"PartID"と指定することで、確実な対応付けを行うことが推奨されます。
Choropleth Mapは直感的な色温度を利用していますが、明示的にカラーチャートを表示したい場合には、"ColorbarFlag"をtrueにすることで画像中にカラーチャートを埋め込むことができます。

Choropleth Mapの上限値、下限値を未指定の場合、-65535～65535の範囲に設定されます。負数をとらない、上限値がもっと小さい、といったデータをChoropleth Map表示する場合には、データの特性に合わせて、明示的に上限値、下限値の設定を追加して下さい。範囲を超える値は、上限値もしくは下限値の色と同じになります。
上記のconfigurationに対して、下限値0、上限値50000に設定する記述を追加すると下記にようになります。

Treeを指定する（"TreeName"パラメータ）

"Common"カテゴリの"TreeName"パラメータにより、BodyParts3Dが持つ三次元構造モデルデータの組合せを変更することができます。
未指定時にはFMAの"IS-A"ツリーを優先的に利用して構築したモデルが描画されます（"IS-A"ツリーで描画できないものは"PART-OF"ツリーで補完しています）。
"IS-A"ツリーにも"PART-OF"ツリーにも含まれている概念で、構造が異なるパーツが一部存在しているため、"PART-OF"ツリーを優先的に利用して構築したモデルを描画する場合には、明示的にツリーの種類を指定する必要があります。
例えば、バージョン4.1の"FMA7198"(Pancreas)は"IS-A"ツリーでは子要素となるモデルを持たず、"PART-OF"ツリーでは子要素となるモデルを持っています。以下に"TreeName"を"isa"に指定した場合と"partof"に指定ｓちあ"FMA7198"のURLを示します。（内部構造が見やすいように"PartOpacity"の値を0.4に指定しています）

・IS-Aツリー優先


・PART-OFツリー優先
※同一リクエストにおいて"isa"と"partof"の両方を利用することはできません。