Check availability of specific scale factors

Tests if specifics scale factors are set or not.

containsScaleFactor(object, ...)

# S4 method for class 'SPATA2'
containsScaleFactor(
  object,
  fct_name,
  img_name = activeImage(object),
  error = FALSE
)

# S4 method for class 'SpatialData'
containsScaleFactor(
  object,
  fct_name,
  img_name = activeImage(object),
  error = FALSE
)

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. The name of the scale factor of interest. E.g. 'pixel' or 'coords'.

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

error

Logical. If TRUE and the input is invalid the function throws an error.

Value

Logical value.