nonapi
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
nonapi [2022/07/27 19:01] antreas |
nonapi [2022/07/28 13:00] (current) yves [Macro] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== Image Endpoints ===== | ===== Image Endpoints ===== | ||
| - | == Tile == | + | 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. |
| - | /tile: | + | ==== Tile ==== |
| - | /// <summary> | + | **/tile** Renders a square tile of a slide |
| - | /// Renders a square region of a specified region. | + | ^Parameter ^Description^ |
| - | /// </summary> | + | |sessionID|The session id to authenticate with| |
| - | /// <param name="sessionID">The session id to authenticate with.</param> | + | |pathOrUid|The path or unique identifier of the image to render or a valid collection config JSON| |
| - | /// <param name="pathOrUid">The path or unique identifier of the image to render or a valid collection config JSON.</param> | + | |timeframe|The index of the time frame to render| |
| - | /// <param name="timeframe">The index of the time frame to render.</param> | + | |layer|The index of the layer to render| |
| - | /// <param name="layer">The index of the layer to render.</param> | + | |channels|Comma separated channel indexes to render| |
| - | /// <param name="channels">The channels to render.</param> | + | |channelClipping|Min and max limits to clip and scale pixel values. Two values required per channel| |
| - | /// <param name="channelClipping">Min and max limits to clip and scale pixel values. Two values required per channel.</param> | + | |gamma|Gamma values for each channel. One value required per channel| |
| - | /// <param name="gamma">Gamma values for each channgel. One value required per channel </param> | + | |x|The x index of the tile| |
| - | /// <param name="x">The x index of the tile.</param> | + | |y|The y index of the tile| |
| - | /// <param name="y">The y index of the tile.</param> | + | |z|The z index of the tile| |
| - | /// <param name="z">The z index of the tile.</param> | + | |cache|//Optional// parameter that tells the renderer whether or not to use the cache to fetch the tile| |
| - | /// <param name="cache">Optional parameter that tells the renderer whether or not to use the cache to fetch the tile.</param> | + | |format|//Optional// resulting image format. Valid values are JPG, JPEG and PNG| |
| - | /// <param name="format">Optional parameter representing the resulting image format. Valid values are JPG, JPEG and PNG.</param> | + | |quality|//Optional// quality parameter used only for the jpeg format| |
| - | /// <param name="quality">Optional quality parameter used only for the jpeg format.</param> | + | |postGamma|//Optional// gamma value to apply as post processing| |
| - | /// <param name="postGamma">Optional gamma value to apply as post processing</param> | + | |brightness|//Optional// brightness value to apply as post processing| |
| - | /// <param name="brightness">Optional brightness value to apply as post processing</param> | + | |contrast|//Optional// contrast value to apply as post processing| |
| - | /// <param name="contrast">Optional constast value to apply as post processing</param> | + | **Returns** A file stream that contains the rendered region |
| - | /// <returns>A file stream that contains the rendered region.</returns> | + | |
| - | == Region == | + | ==== Region ==== |
| - | /region | + | **/region** Renders a region of a slide |
| + | ^Parameter ^Description^ | ||
| + | |sessionID|The session id to authenticate with| | ||
| + | |pathOrUid|The path or unique identifier of the image to render| | ||
| + | |timeframe|The index of the time frame to render| | ||
| + | |layer|The index of the layer to render| | ||
| + | |channels|Comma separated channel indexes to render| | ||
| + | |x|The x coordinate of the image to render| | ||
| + | |y|The y coordinate of the image to render| | ||
| + | |width|The width of the region to render| | ||
| + | |height|The height of the region to render| | ||
| + | |scale|The factor to scale the rendered region by| | ||
| + | |channelClipping|Min and max limits to clip and scale pixel values. Two values required per channel.| | ||
| + | |gamma|Gamma values for each channel. One value required per channel | | ||
| + | |drawScaleBar|Draw an accurate scale bar| | ||
| + | |downloadInsteadOfDisplay|Whether or not to download the image or display it in the browser| | ||
| + | |drawFilename|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| | ||
| + | |quality|//Optional// quality parameter used only for the jpeg format| | ||
| + | |annotationsLayerType|A comma separated list of extra annotations layer to render| | ||
| + | |rotation|Rotation angle in degrees| | ||
| + | |flipHorizontal|Whether to flip region horizontally| | ||
| + | |flipVertical|Whether to flip the region vertically| | ||
| + | |dpi|//Optional// dpi to resolution for the exported image| | ||
| + | |postGamma|//Optional// gamma value to apply as post processing| | ||
| + | |brightness|//Optional// brightness value to apply as post processing| | ||
| + | |contrast|//Optional// contrast value to apply as post processing| | ||
| + | **Returns** A file stream that contains the rendered region | ||
| - | /// <summary> | + | ==== Thumbnail ==== |
| - | /// Renders a region of the specified image | + | **/thumbnail** Renders the associated thumbnail of slide |
| - | /// </summary> | + | ^Parameter ^Description^ |
| - | /// <param name="sessionID">The session id to authenticate with</param> | + | |sessionID|The session id to authenticate with| |
| - | /// <param name="pathOrUid">The path or unique identifier of the image to render</param> | + | |pathOrUid|The path or unique identifier of the image to render| |
| - | /// <param name="timeframe">The index of the time frame to render</param> | + | |orientation|The orientation of the thumbnail (0 = auto; 1 = vertical; 2 = horizontal)| |
| - | /// <param name="layer">The index of the layer to render</param> | + | |w|Expected output width of the thumbnail| |
| - | /// <param name="channels">The channels to render</param> | + | |h|Expected output height of the thumbnail| |
| - | /// <param name="x">The x coordinate of the image to render</param> | + | **Returns** An image |
| - | /// <param name="y">The y coordinate of the image to render</param> | + | |
| - | /// <param name="width">The width of the region to render</param> | + | |
| - | /// <param name="height">The height of the region to render</param> | + | |
| - | /// <param name="scale">The factor to scale the rendered region by</param> | + | |
| - | /// <param name="channelClipping">Min and max limits to clip and scale pixel values. Two values required per channel.</param> | + | |
| - | /// <param name="gamma">Gamma values for each channgel. One value required per channel </param> | + | |
| - | /// <param name="drawScaleBar">Draw an accurate scale bar?</param> | + | |
| - | /// <param name="downloadInsteadOfDisplay">download Instead Of Display</param> | + | |
| - | /// <param name="drawFilename">0 do not draw , 1 draw filename on top, 2 draw on bottom</param> | + | |
| - | /// <param name="format">Optional parameter representing the resulting image format. Valid values are JPG, JPEG and PNG</param> | + | |
| - | /// <param name="quality">Optional quality parameter used only for the jpeg format</param> | + | |
| - | /// <param name="annotationsLayerType">A comma seperated list of extra annotations layer to render</param> | + | |
| - | /// <param name="rotation">Rotation angle in degrees</param> | + | |
| - | /// <param name="flipHorizontal">Whether to flip region horizontaly</param> | + | |
| - | /// <param name="flipVertical">Whether to flip the region verticaly</param> | + | |
| - | /// <param name="dpi">Optional dpi to resolution for the exported image</param> | + | |
| - | /// <param name="postGamma">Optional gamma value to apply as post processing</param> | + | |
| - | /// <param name="brightness">Optional brightness value to apply as post processing</param> | + | |
| - | /// <param name="contrast">Optional constast value to apply as post processing</param> | + | |
| - | /// <returns>A file stream that contains the rendered region</returns> | + | |
| - | == Thumbnail == | + | ==== Macro ==== |
| - | /thumbnail | + | **/macro** Renders the associated macro of a slide |
| - | + | ||
| - | /// <summary> | + | |
| - | /// Renders the associated Thumbnail of a WSI | + | |
| - | /// </summary> | + | |
| - | /// <param name="sessionID">The session id to authenticate with</param> | + | |
| - | /// <param name="pathOrUid">The path or unique identifier of the image to render</param> | + | |
| - | /// <param name="orientation">The orientation of the thumbnail (0 = auto; 1 = vertical; 2 = horizontal)</param> | + | |
| - | /// <param name="w">Expected output width of the thumbnail</param> | + | |
| - | /// <param name="h">Expected output height of the thumbnail</param> | + | |
| - | /// <returns>An image</returns> | + | |
| - | + | ||
| - | == Macro == | + | |
| - | /macro | + | |
| - | + | ||
| - | /// <summary> | + | |
| - | /// Renders the associated macro of a WSI | + | |
| - | /// </summary> | + | |
| - | /// <param name="sessionID">The session id to authenticate with</param> | + | |
| - | /// <param name="pathOrUid">The path or unique identifier of the image to render</param> | + | |
| - | /// <param name="orientation">The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)</param> | + | |
| - | /// <param name="w">Expected output width of the thumbnail</param> | + | |
| - | /// <param name="h">Expected output height of the thumbnail</param> | + | |
| - | /// <returns>An image</returns> | + | |
| - | + | ||
| - | == Barcode == | + | |
| - | /barcode | + | |
| - | /// <summary> | + | |
| - | /// Renders the associated barcode of a WSI | + | |
| - | /// </summary> | + | |
| - | /// <param name="sessionID">The session id to authenticate with</param> | + | |
| - | /// <param name="pathOrUid">The path or unique identifier of the image to render</param> | + | |
| - | /// <param name="rotation">Desired rotation in increments of 90 degrees (default = 0 means no rotation)</param> | + | |
| - | /// <param name="w">Expected output width of the thumbnail</param> | + | |
| - | /// <param name="h">Expected output height of the thumbnail</param> | + | |
| - | /// <returns>An image</returns> | + | |
| + | ^Parameter ^Description^ | ||
| + | |sessionID|The session id to authenticate with| | ||
| + | |pathOrUid|The path or unique identifier of the image to render| | ||
| + | |orientation|The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)| | ||
| + | |w|Expected output width of the macro| | ||
| + | |h|Expected output height of the macro| | ||
| + | **Returns** An image | ||
| + | ==== Barcode ==== | ||
| + | **/barcode** Renders the associated barcode of a slide | ||
| + | ^Parameter ^Description^ | ||
| + | |sessionID|The session id to authenticate with| | ||
| + | |pathOrUid|The path or unique identifier of the image to render| | ||
| + | |orientation|The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)| | ||
| + | |w|Expected output width of the barcode| | ||
| + | |h|Expected output height of the barcode| | ||
| + | **Returns** An image | ||
nonapi.1658937680.txt.gz · Last modified: 2022/07/27 19:01 by antreas
