unloadImage: Unload image slot content

In kueckelj/SPATA2: A Toolbox for Spatial Expression Analysis

Unload image slot content

Description

Removes the image from slot @image of a HistoImage. Useful for efficient data storing.

Not to be confused with removeImage()!

Usage

unloadImage(object, ...)

## S4 method for signature 'SPATA2'
unloadImage(object, img_name = activeImage(object), verbose = NULL, ...)

## S4 method for signature 'SpatialData'
unloadImage(object, img_name, verbose = TRUE, ...)

## S4 method for signature 'HistoImage'
unloadImage(object, verbose = TRUE, ...)

unloadImages(object, ...)

## S4 method for signature 'SPATA2'
unloadImages(object, active = FALSE, verbose = TRUE)

## S4 method for signature 'SpatialData'
unloadImages(object, active = FALSE, verbose = TRUE)

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 to unload.
verbose	Logical. If TRUE, informative messages regarding the computational progress will be printed. (Warning messages will always be printed.)
active.	Logical value. If FALSE, the default, the image from the active HistoImage is not unloaded.

Value

The updated input object, containing the added, removed or computed results.

See Also

loadImage(),loadImages(), getImageDir()

kueckelj/SPATA2 documentation built on Feb. 27, 2025, 1:45 p.m.