DocumentationDynamic Media Image Serving and Rendering API

rgn rgn

Last update: Tue Aug 22 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Region-of-interest. Specifies a rectangular region-of-interest (ROI) in the composite image, expressed in pixels.

rgn= coord, size

coord
Pixel offset from the top-left corner of the composite image to the top-left of the ROI (int, int).
size
Size of the ROI in pixels (int, int).
NOTE
rgn= only defines an ROI without cropping the image. When wid= and/or hei= larger than size are applied as well, additional data from the composite image may be visible in the final reply image.

Properties section-53edb35f4e364d7ca13fd0886e8b0c86

View attribute. Applies regardless of the current layer setting.

Any areas of the ROI extending outside the composite image are padded with bgc=.

rgn= is applied before final scaling and fitting with scl=, wid=, hei=, fit=, rect=, or align=.

Default section-6a3df8f670084def900ffef9dab7e94a

Entire composite image ( rgn=0,0,width,height).

See also section-07883760f25c4d17aedbee36b7883891

crop= , extend=, wid=, hei=, scl=, align=, fit=, rect=

recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49