nonapi
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
nonapi [2023/08/04 09:32] angelos [Region] |
nonapi [2025/05/09 12:47] (current) angelos [Barcode] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== Image Endpoints ===== | ===== Image Endpoints ===== | ||
| - | The following endpoints are available in PMA.core to view Whole Slide Images and its associated labels, thumbnails and macro images. The following list contains the endpoint URL, a brief description and the available parameters for each one. | + | The following endpoints are available in PMA.core to view Whole Slide Images and their associated labels, thumbnails and macro images. The following list contains the endpoint URL, a brief description and the available parameters for each one. |
| ==== Tile ==== | ==== Tile ==== | ||
| Line 18: | Line 18: | ||
| |**z**|The z index of the tile| | |**z**|The z index of the tile| | ||
| |cache|//Optional// parameter that tells the renderer whether or not to use the cache to fetch the tile| | |cache|//Optional// parameter that tells the renderer whether or not to use the cache to fetch the tile| | ||
| - | |format|//Optional// resulting image format. Valid values are JPG, JPEG and PNG| | + | |format|//Optional// resulting image format. Valid values are JPG, JPEG, PNG, TIFF and DICOM| |
| |quality|//Optional// quality parameter used only for the jpeg format| | |quality|//Optional// quality parameter used only for the jpeg format| | ||
| |postGamma|//Optional// gamma value to apply as post processing| | |postGamma|//Optional// gamma value to apply as post processing| | ||
| Line 30: | Line 30: | ||
| **/region** Renders a region of a slide | **/region** Renders a region of a slide | ||
| ^Parameter ^Description^ | ^Parameter ^Description^ | ||
| - | |**sessionID**|The session id to authenticate with| | + | |**sessionID**|The session ID to authenticate with| |
| |**pathOrUid**|The path or unique identifier of the image to render| | |**pathOrUid**|The path or unique identifier of the image to render| | ||
| |**timeframe**|The index of the time frame to render| | |**timeframe**|The index of the time frame to render| | ||
| Line 46: | Line 46: | ||
| |downloadInsteadOfDisplay|//Optional// Whether or not to download the image or display it in the browser| | |downloadInsteadOfDisplay|//Optional// Whether or not to download the image or display it in the browser| | ||
| |drawFilename|//Optional// 0 do not draw, 1 draw filename on top, 2 draw on bottom| | |drawFilename|//Optional// 0 do not draw, 1 draw filename on top, 2 draw on bottom| | ||
| - | |format|//Optional// parameter representing the resulting image format. Valid values are JPG, JPEG and PNG| | + | |format|//Optional// parameter representing the resulting image format. JPG, JPEG, PNG, TIFF and DICOM| |
| |quality|//Optional// quality parameter used only for the jpeg format| | |quality|//Optional// quality parameter used only for the jpeg format| | ||
| |annotationsLayerType|//Optional// A comma separated list of extra annotations layer to render| | |annotationsLayerType|//Optional// A comma separated list of extra annotations layer to render| | ||
| Line 60: | Line 60: | ||
| **Example** ///region?sessionId=%%sessionId%%&pathOrUid=%%path%%&timeframe=0&layer=0&channels=0&channelClipping=0,0&channelColor=ffffffff&gamma=1&x=0&y=0&width=1000&height=1000&scale=0.1// | **Example** ///region?sessionId=%%sessionId%%&pathOrUid=%%path%%&timeframe=0&layer=0&channels=0&channelClipping=0,0&channelColor=ffffffff&gamma=1&x=0&y=0&width=1000&height=1000&scale=0.1// | ||
| - | In the example request above, the system will render a portion of 1000x1000 pixels of the full resolution image and scale it to 100x100 pixels before it returns it to the client. | + | In the example request above, the system will render a 1000x1000 pixel portion of the full resolution image and scale it to 100x100 pixels before it returns it to the client. |
| ==== Thumbnail ==== | ==== Thumbnail ==== | ||
| **/thumbnail** Renders the associated thumbnail of slide | **/thumbnail** Renders the associated thumbnail of slide | ||
| ^Parameter ^Description^ | ^Parameter ^Description^ | ||
| - | |**sessionID**|The session id to authenticate with| | + | |**sessionID**|The session ID to authenticate with| |
| |**pathOrUid**|The path or unique identifier of the image to render| | |**pathOrUid**|The path or unique identifier of the image to render| | ||
| |orientation|//Optional// The orientation of the thumbnail (0 = auto; 1 = vertical; 2 = horizontal)| | |orientation|//Optional// The orientation of the thumbnail (0 = auto; 1 = vertical; 2 = horizontal)| | ||
| Line 78: | Line 78: | ||
| ^Parameter ^Description^ | ^Parameter ^Description^ | ||
| - | |**sessionID**|The session id to authenticate with| | + | |**sessionID**|The session ID to authenticate with| |
| |**pathOrUid**|The path or unique identifier of the image to render| | |**pathOrUid**|The path or unique identifier of the image to render| | ||
| |orientation|//Optional// The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)| | |orientation|//Optional// The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)| | ||
| Line 90: | Line 90: | ||
| **/barcode** Renders the associated [[barcode|barcode]] of a slide | **/barcode** Renders the associated [[barcode|barcode]] of a slide | ||
| ^Parameter ^Description^ | ^Parameter ^Description^ | ||
| - | |**sessionID**|The session id to authenticate with| | + | |**sessionID**|The session ID to authenticate with| |
| |**pathOrUid**|The path or unique identifier of the image to render| | |**pathOrUid**|The path or unique identifier of the image to render| | ||
| |orientation|//Optional// The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)| | |orientation|//Optional// The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)| | ||
| Line 98: | Line 98: | ||
| **Example** ///barcode?sessionId=%%sessionId%%&pathOrUid=%%path%%// | **Example** ///barcode?sessionId=%%sessionId%%&pathOrUid=%%path%%// | ||
| + | |||
| + | ==== IIIF ==== | ||
| + | PMA.core implements the [[https://iiif.io/api/image/3.0/|Image API 3.0 of the International Image Interoperability Framework]]. | ||
| + | |||
| + | All IIIF requests start at the /iiif endpoint. | ||
nonapi.1691130772.txt.gz · Last modified: 2023/08/04 09:32 by angelos
