User Tools

Site Tools


nonapi

This is an old revision of the document!


Image Endpoints

Tile

/tile: / <summary> / Renders a square region of a specified region.

      /// </summary>
      /// <param name="sessionID">The session id to authenticate with.</param>
      /// <param name="pathOrUid">The path or unique identifier of the image to render or a valid collection config JSON.</param>
      /// <param name="timeframe">The index of the time frame to render.</param>
      /// <param name="layer">The index of the layer to render.</param>
      /// <param name="channels">The channels to render.</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="x">The x index of the tile.</param>
      /// <param name="y">The y index of the tile.</param>
      /// <param name="z">The z index of the tile.</param>
      /// <param name="cache">Optional parameter that tells the renderer whether or not to use the cache to fetch the tile.</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="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>
Region

/region

/ <summary> / Renders a region of the specified image

      /// </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="timeframe">The index of the time frame to render</param>
      /// <param name="layer">The index of the layer to render</param>
      /// <param name="channels">The channels to render</param>
      /// <param name="x">The x coordinate of the image to render</param>
      /// <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

/thumbnail

/ <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>
nonapi.1658937680.txt.gz · Last modified: 2022/07/27 19:01 by antreas