transform_dist_si_to_pixel | R Documentation |
Transforms European units of length (e.g. '2mm', '400.50um') to pixel values depending on the original size of spatial -omic methods.
transform_dist_si_to_pixel(
input,
object = NULL,
image_dims = NULL,
round = FALSE,
...
)
transform_dist_si_to_pixels(
input,
object = NULL,
image_dims = NULL,
round = FALSE,
as_numeric = TRUE,
...
)
input |
Distance as SI unit of length. See details for more. |
object |
A valid |
round |
Numeric value or |
as_numeric |
Logical value. If |
Several functions in SPATA2
have arguments that take distance input.
To specifically refer to a distance the unit must be specified. There are
three ways to create valid input for these arguments.
1. In pixel:
There are two valid input options to specify the distance in pixel:
numeric: Single numeric values, e.g. arg_input <- c(2, 3.554, 69, 100.67)
. If no unit
is specified the input will be interpreted as pixels.
character: Suffixed with 'px', e.g. arg_input <- c('2px', '3.554px', '69px', '100.67px')
Note: The unit pixel (px) is used for distances as well as for areas. If pixel refers to a distance the pixel side length is meant. If pixel refers to an area the number of pixels is meant.
2. According to the Systeme international d'unites (SI):
Specifying distances in SI units e.g. arg_input <- c('2mm', '4mm')
etc.
requires the input to be a character as the unit must be provided as suffix.
Between the numeric value and the unit must be no empty space! Valid suffixes
can be obtained using the function validUnitsOfLengthSI()
.
3. As vectors of class unit
:
Behind the scenes SPATA2
works with the units
package. Input
is converted into vectors of class units
. Therefore, input can be directly
provided this way: arg_input <- units::set_unit(x = c(2,4), value = 'mm')
Note that pixel is not a valid unit in the units
package. If you want
to specify the input in pixel you have to use input option 1. In pixel.
Transformed input. Vector of the same length as input. Function
transform_dist_si_to_pixel()
always returns a single numeric value. Function
transform_dist_si_to_pixels()
returns a numeric vector by default. If as_numeric
is FALSE
, the output is a string suffixed with px.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.