getBackgroundColor: Obtain background color

getBackgroundColorR Documentation

Obtain background color

Description

Extracts results of identifyBackgroundColor().

Usage

getBackgroundColor(object, ...)

## S4 method for signature 'SPATA2'
getBackgroundColor(object, img_name = NULL, default = "white", ...)

## S4 method for signature 'SpatialData'
getBackgroundColor(object, img_name = NULL, default = "white", ...)

## S4 method for signature 'HistoImage'
getBackgroundColor(object, default = "white")

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().

default

Color to default to if no background color is set.

Value

Character value.


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