getHistoImage: Obtain HistoImage object

In theMILOlab/SPATA2: A Toolbox for Spatial Expression Analysis

Obtain HistoImage object

Description

Extracts the S4-containers of registered images. Note that slot @image might be empty. Use loadImage() in that case.

• getHistoImage(): Extracts object by name. By default, the active HistoImage image is returned.

• getHistoImageRef(): Extracts the reference HistoImage object.

Usage

getHistoImage(object, ...)

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

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

getHistoImageRef(object, ...)

## S4 method for signature 'SPATA2'
getHistoImageRef(object, ...)

## S4 method for signature 'SpatialData'
getHistoImageRef(object, ...)

Arguments

object	An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.
...
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().

theMILOlab/SPATA2 documentation built on June 1, 2025, 9:11 p.m.