addScaleBar: Image Scale Bar Incrustation

View source: R/addScaleBar.R

addScaleBarR Documentation

Image Scale Bar Incrustation

Description

Adds scale bar to image

Usage

addScaleBar(
  image,
  size,
  style = c("dash", "line")[1],
  color = "white",
  res = 96,
  xoff = 0,
  yoff = 0
)

Arguments

image

a [0,1] image.

size

positive integer. Scale's bar size in micro-meter. Default is '7'.
This parameter can't be lesser than 6px and higher than image width + scale text.

style

a character string. Scale's bar style, either 'dash' or 'line'. Default is 'dash'.

color

a character string. color of the scale. Default is 'white'.

res

positive integer. Resolution in ppi of 'image'. Default is '96'.

xoff

positive integer. x offset in image to draw scale, starting from bottom left corner.

yoff

positive integer. y offset in image to draw scale, starting from bottom left corner.

Value

an image with scale added to the bottom left corner.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.