selectROI-methods {Cardinal} | R Documentation

## Select regions-of-interest of an imaging dataset

### Description

Manually select regions-of-interest or pixels on an imaging dataset. The `selectROI` method uses the built-in `locator` function. The method has the same form as the `image` method for plotting imaging datasets.

The results are returned as logical vectors indicating which pixels have been selected. These logical vectors can be combined into factors using the `makeFactor` function.

### Usage

    ## S4 method for signature 'SparseImagingExperiment'
    selectROI(object, ..., mode = c("region", "pixels"))

    ## S4 method for signature 'SImageSet'
    selectROI(object, formula = ~ x * y,
        mode = c("region", "pixels"),
        ...,
        main,
        subset = TRUE,
        lattice = FALSE)

    makeFactor(..., ordered = FALSE)

### Arguments

`object` | An imaging dataset.
`formula` | Passed to `image`.
`mode` | What kind of selection to perform: 'region' to select a region-of-interest, or 'pixels' to select individual pixels.
`...` | Addtional arguments to be passed to `image` for `selectROI`, or name-value pairs of logical vectors to be combined by `makeFactor`.
`ordered` | Should the resulting factor be ordered or not?
`main` | Passed to `image`.
`subset` | Passed to `image`.
`lattice` | Must be false.

### Value

A `logical` vector of length equal to the number of pixels for `selectROI`.

A `factor` of the same length as the passed `logical` vectors for `makeFactor`.

### Author(s)

Kylie A. Bemis

### See Also

`image`

[Package Cardinal version 2.10.0 Index]