setScaleFactor: Set scale factors

setScaleFactorR Documentation

Set scale factors

Description

Sets scale factor values.

Usage

setScaleFactor(object, ...)

## S4 method for signature 'SPATA2'
setScaleFactor(object, fct_name, value)

## S4 method for signature 'SpatialData'
setScaleFactor(object, fct_name, value)

## S4 method for signature 'HistoImage'
setScaleFactor(object, fct_name, value)

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.

fct_name

Character value. Name of the scale factor.

value

Value to set.

Details

For S4 methods other than for HistoImage: Sets scale factors for the reference image. Corresponding scale factors for additionally registered images (if there are any) are computed.

If there are no images registered, the scale factor is set in the corresponding list slot of @scale_factors of the SpatialData object.

Value

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


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