本文介紹圖像分析處理(imageprocess)類目下的多器官分割SegmentOAR的語法及示例。
功能描述
多器官分割能力針對放療場景,基于輸入的胸部CT圖像,進行危及器官的識別與分割。
- 您可以進入在線咨詢獲取在線人工幫助。
- 阿里云視覺智能開放平臺視覺AI能力API接入、接口使用或問題咨詢等,請通過釘釘群(23109592)加入阿里云視覺智能開放平臺咨詢群聯系我們。
接入指引
1. 注冊阿里云賬號:打開阿里云官網,在阿里云官網右上角,單擊立即注冊,按照操作提示完成賬號注冊。
2. 開通能力:請確保您已開通圖像分析處理,若未開通服務請立即開通。
3. 創建AccessKey:請確保您已創建AccessKey,如果您使用的是子賬號AccessKey,您需要給子賬號賦予AliyunVIAPIFullAccess權限,具體操作,請參見RAM授權。
4. 在線調試(可選):您可以通過OpenAPI Explorer在線調試能力,查看完整的調用示例代碼及SDK依賴信息,也可以下載完整的工程。
5. 開發接入步驟:
- 在SDK總覽中選擇您要接入使用的SDK語言。
- 在對應語言的SDK文檔中找到AI類目為圖像分析處理(imageprocess)的SDK包進行安裝。
- 參考文檔中提供的示例代碼進行適當修改后調用。
6. 示例代碼:該能力常用語言查詢異步任務結果的示例代碼,請參見查詢異步任務結果示例代碼。
7. 客戶端直接調用:該能力常用的客戶端調用方式包括以下幾種。
輸入限制
- 圖像格式:DICOM、NIFTI。
- 圖像分辨率:不小于512×512像素。
- 如果輸入格式為DICOM,每次請求幀數最少20幀,最多600幀;如果輸入格式為NIFTI,每次請求須有且僅有一例數據。
- URL地址中不能包含中文字符。
調用步驟
該能力為異步能力,需分兩步進行調用。
第一步調用SegmentOAR接口提交任務,請求成功后,得到一個任務ID。
第二步調用GetAsyncJobResult接口查詢結果,根據任務ID查詢任務執行狀態和結果。如果任務還在處理中,可稍等一段時間后再進行查詢。
計費說明
多器官分割能力目前處于公測期,可免費調用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | SegmentOAR | 系統規定參數。取值:SegmentOAR。 |
URLList.N.URL | String | 是 | https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/c001.dcm | 圖像URL地址。推薦使用上海地域的OSS鏈接,對于文件在本地或者非上海地域OSS鏈接的情況,請參見文件URL處理。 說明 URLList.N.URL中的N為該圖像URL在當前List中的順序(從1開始)。當直接使用API請求時,輸入URLList的填充會以URLList.1.URL=url1,URLList.2.URL=url2,......的方式指定參數和參數值,參數對以&連接,其中url1、url2、......等具體值請根據實際情況進行替換;當使用SDK填充URLList時,可直接使用SDK提供的相應的方法。 |
DataFormat | String | 是 | NIFTI | 圖像的格式。目前只支持以下兩種:DICOM、NIFTI。 |
OrgId | String | 是 | 7ff51bfe-e73d-11ea-827d-506b4b3f3cf6 | 數據來源機構代碼。 |
OrgName | String | 是 | 測試組織 | 數據來源機構名稱。 |
Contrast | Boolean | 否 | true | 是否增強CT。
|
MaskList.N | Long | 否 | 1024,2048 | 長整形數組,對應的器官輸出。建議為空。算法默認輸出全部器官的結果。 |
BodyPart | String | 否 | CHEST | 期望輸出的危及器官所在的身體部位。
|
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 57784EDF-7322-1559-89C2-26A08570B26B | 請求ID。 |
Data | Object | 返回的結果數據內容。該數據需要在異步任務執行成功后,通過調用GetAsyncJobResult接口,對其Result字段進行JSON反序列化之后得到。 |
|
ResultURL | String | http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/calc-cacs/2020-09-29/2020-09-29-11%3A07%3A41-D74FE0DF-8F80-41EB-B08B-2E67053587EC.tar.gz?Expires=1601350661&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iB16ms28Y5mzB11ghYUd7upCi4**** | 分割結果下載地址,有效時間5分鐘。 |
Message | String | 該調用為異步調用,任務已提交成功,請以requestId的值作為jobId參數調用同類目下GetAsyncJobResult接口查詢任務執行狀態和結果。 | 提交異步任務后的提示信息。 |
查詢結果
該接口為異步接口,當前并未返回真實的請求結果,您需要通過返回的RequestId調用GetAsyncJobResult接口來獲取該接口的真實請求結果。詳情請參見GetAsyncJobResult。
SDK參考
阿里云視覺AI圖像分析處理類目下的多器官分割能力推薦使用SDK調用,支持多種編程語言,調用時請選擇AI類目為圖像分析處理(imageprocess)的SDK包,文件參數通過SDK調用可支持本地文件及任意URL,具體可參見SDK總覽。
示例代碼
該能力常用語言查詢異步任務結果的示例代碼,請參見查詢異步任務結果示例代碼。
示例
請求示例
http(s)://imageprocess.cn-shanghai.aliyuncs.com/?Action=SegmentOAR //更多關于訪問域名(Endpoint)信息,請參見:http://bestwisewords.com/document_detail/143103.html
&URLList.1.URL=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/c001.dcm
&URLList.2.URL=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/c002.dcm
&DataFormat=NIFTI
&OrgId=7ff51bfe-e73d-11ea-827d-506b4b3f3cf6
&OrgName=測試組織
&Contrast=true
&MaskList=[1024,2048]
&BodyPart=CHEST
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SegmentOARResponse>
<RequestId>57784EDF-7322-1559-89C2-26A08570B26B</RequestId>
<Message>該調用為異步調用,任務已提交成功,請以requestId的值作為jobId參數調用同類目下GetAsyncJobResult接口查詢任務執行狀態和結果。</Message>
</SegmentOARResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "57784EDF-7322-1559-89C2-26A08570B26B",
"Message" : "該調用為異步調用,任務已提交成功,請以requestId的值作為jobId參數調用同類目下GetAsyncJobResult接口查詢任務執行狀態和結果。"
}
返回示例補充說明
//查詢結果:請求示例
http(s)://imageprocess.cn-shanghai.aliyuncs.com/?Action=GetAsyncJobResult
&JobId=E75FE679-0303-4DD1-8252-1143B4FA8A27
&<公共請求參數>
//查詢結果:返回示例
{
"RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
"Data" : {
"Status" : "PROCESS_SUCCESS",
"JobId" : "186AC396-0EEC-46F1-AAA1-BF3585227427",
"Result" : "{\"ResultURL\":\"http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/calc-cacs/2020-09-29/2020-09-29-11%3A07%3A41-D74FE0DF-8F80-41EB-B08B-2E67053587EC.tar.gz?Expires=1601350661&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iB16ms28Y5mzB11ghYUd7upCi4****\"}"
}
}
//Result反序列化
{
"ResultURL" : "http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/calc-cacs/2020-09-29/2020-09-29-11%3A07%3A41-D74FE0DF-8F80-41EB-B08B-2E67053587EC.tar.gz?Expires=1601350661&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iB16ms28Y5mzB11ghYUd7upCi4****"
}
錯誤碼
關于多器官分割的錯誤碼。詳情請參見常見錯誤碼。
安全聲明
- 請確保上傳的圖片或文件來源符合相應的法律法規。
- 通過體驗調試上傳的臨時文件有效期為1小時,在24小時后會被系統自動清理刪除。