getCaptureArea: Obtain capture area

getCaptureAreaR Documentation

Obtain capture area

Description

Extracts the frame in which data points are expected.

Usage

getCaptureArea(object, ...)

## S4 method for signature 'SPATA2'
getCaptureArea(object, img_name = activeImage(object), ...)

## S4 method for signature 'SpatialData'
getCaptureArea(object, img_name = activeImage(object), ...)

Arguments

object

An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.

...

Used to absorb deprecated arguments or functions.

img_name

Character value. The name of the image of interest. If NULL, the active image is chosen by default. Either way, must be one of getImageNames().

Value

Data.frame of vertices used to outline the capture area. Column names are x_orig, y_orig, x, y and idx (index of each vertex).

See Also

setCaptureArea()


theMILOlab/SPATA2 documentation built on Feb. 8, 2025, 11:41 p.m.