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/28 12:07] angelos |
nonapi [2022/07/28 13:00] (current) yves [Macro] |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| 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 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 ==== |
| **/tile** Renders a square tile of a slide | **/tile** Renders a square tile 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 or a valid collection config JSON| | |pathOrUid|The path or unique identifier of the image to render or a valid collection config JSON| | ||
| Line 20: | Line 20: | ||
| |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| | ||
| - | |brightness|Optional brightness value to apply as post processing| | + | |brightness|//Optional// brightness value to apply as post processing| |
| - | |contrast|Optional contrast value to apply as post processing| | + | |contrast|//Optional// contrast value to apply as post processing| |
| **Returns** A file stream that contains the rendered region | **Returns** A file stream that contains the rendered region | ||
| - | === Region === | + | ==== Region ==== |
| - | **/region** Renders a region of the specified WSI | + | **/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| | ||
| |layer|The index of the layer to render| | |layer|The index of the layer to render| | ||
| - | |channels|The channels to render| | + | |channels|Comma separated channel indexes to render| |
| |x|The x coordinate of the image to render| | |x|The x coordinate of the image to render| | ||
| |y|The y coordinate of the image to render| | |y|The y coordinate of the image to render| | ||
| Line 38: | Line 38: | ||
| |scale|The factor to scale the rendered region by| | |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.| | |channelClipping|Min and max limits to clip and scale pixel values. Two values required per channel.| | ||
| - | |gamma|Gamma values for each channgel. One value required per channel | | + | |gamma|Gamma values for each channel. One value required per channel | |
| - | |drawScaleBar|Draw an accurate scale bar?| | + | |drawScaleBar|Draw an accurate scale bar| |
| - | |downloadInsteadOfDisplay|download Instead Of Display| | + | |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| | + | |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| | + | |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| | + | |quality|//Optional// quality parameter used only for the jpeg format| |
| - | |annotationsLayerType|A comma seperated list of extra annotations layer to render| | + | |annotationsLayerType|A comma separated list of extra annotations layer to render| |
| |rotation|Rotation angle in degrees| | |rotation|Rotation angle in degrees| | ||
| - | |flipHorizontal|Whether to flip region horizontaly| | + | |flipHorizontal|Whether to flip region horizontally| |
| - | |flipVertical|Whether to flip the region verticaly| | + | |flipVertical|Whether to flip the region vertically| |
| - | |dpi|Optional dpi to resolution for the exported image| | + | |dpi|//Optional// dpi to resolution for the exported image| |
| - | |postGamma|Optional gamma value to apply as post processing| | + | |postGamma|//Optional// gamma value to apply as post processing| |
| - | |brightness|Optional brightness value to apply as post processing| | + | |brightness|//Optional// brightness value to apply as post processing| |
| - | |contrast|Optional constast value to apply as post processing| | + | |contrast|//Optional// contrast value to apply as post processing| |
| **Returns** A file stream that contains the rendered region | **Returns** A file stream that contains the rendered region | ||
| - | === Thumbnail === | + | ==== Thumbnail ==== |
| - | **/thumbnail** Renders the associated thumbnail of a WSI | + | **/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| | ||
| Line 64: | Line 64: | ||
| **Returns** An image | **Returns** An image | ||
| - | === Macro === | + | ==== Macro ==== |
| - | **/macro** Renders the associated macro of a WSI | + | **/macro** Renders the associated macro 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|The orientation of the macro(0 = auto; 1 = vertical; 2 = horizontal)| | + | |orientation|The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)| |
| |w|Expected output width of the macro| | |w|Expected output width of the macro| | ||
| |h|Expected output height of the macro| | |h|Expected output height of the macro| | ||
| **Returns** An image | **Returns** An image | ||
| - | === Barcode === | + | ==== Barcode ==== |
| - | **/barcode** Renders the associated barcode of a WSI | + | **/barcode** Renders the associated 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|The orientation of the barcode(0 = auto; 1 = vertical; 2 = horizontal)| | + | |orientation|The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)| |
| |w|Expected output width of the barcode| | |w|Expected output width of the barcode| | ||
| |h|Expected output height of the barcode| | |h|Expected output height of the barcode| | ||
| **Returns** An image | **Returns** An image | ||
nonapi.1658999259.txt.gz · Last modified: 2022/07/28 12:07 by angelos
