The flip*() family mirror inverts the current image or coordinates of spatial aspects or everything. See details for more information.

NOTE: flipImage() only flips the image and lets everything else as is. Only use it if you want to flip the image because it is not aligned with the spatial coordinates. If you want to flip the image while maintaining alignment with the spatial aspects in the spata2 object use flipAll()!

flipAll(object, axis, verbose = FALSE)

flipCoordinates(object, axis, verbose = FALSE)

flipCoordsDf(object, axis, verbose = NULL)

flipImage(object, axis, track = FALSE, verbose = FALSE)

flipImageAnnotations(object, axis, verbose = NULL)

flipSpatialTrajectories(object, axis, verbose = NULL)

Arguments

object

An object of class spata2.

axis

Character value. The axis around which the content is flipped. Either 'horizontal', 'h', 'vertical' or 'v'.

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)

track

Logical value. If TRUE, changes regarding the image justification (rotations and flipping) are tracked. Assuming that image versions of different resolution are stored on your device with the same justification as the primarily read image these changes in justification can be automatically applied if the image is exchanged via exchangeImage().

Details

The flip*() functions can be used to flip the complete SPATA2 object or to flip single aspects.

  • flipAll(): Flips the image as well as every single spatial aspect. Always tracks the justification.

  • flipImage(): Flips only the image.

  • flipCoordinates(): Flips the coordinates data.frame, image annotations and spatial trajectories.

  • flipCoordsDf(): Flips the coordinates data.frame.

  • flipImageAnnotations(): Flips image annotations.

  • flipSpatialTrajectories(): Flips spatial trajectories.