setScaled: Set the "scaled" attribute

View source: R/spct.fscale.r

setScaledR Documentation

Set the "scaled" attribute

Description

Function to write the "scaled" attribute of an existing generic_spct object.

Usage

setScaled(x, ...)

## Default S3 method:
setScaled(x, ...)

## S3 method for class 'generic_spct'
setScaled(x, ..., scaled = FALSE)

## S3 method for class 'summary_generic_spct'
setScaled(x, ..., scaled = FALSE)

## S3 method for class 'generic_mspct'
setScaled(x, ..., scaled = FALSE)

Arguments

x

a generic_spct object.

...

currently ignored.

scaled

logical with FALSE meaning that values are expressed in absolute physical units and TRUE meaning that relative units are used. If NULL the attribute is not modified.

Value

a new object of the same class as x.

a new object of the same class as x.

a new object of the same class as x.

a new object of the same class as x.

Methods (by class)

  • setScaled(default): Default for generic function

  • setScaled(generic_spct): Specialization for generic_spct

  • setScaled(summary_generic_spct): Specialization for summary_generic_spct

  • setScaled(generic_mspct): Specialization for generic_mspct

Note

if x is not a generic_spct object, x is not modified.

See Also

Other rescaling functions: fscale(), fshift(), getNormalized(), getScaled(), is_normalized(), is_scaled(), normalize(), setNormalized()


photobiology documentation built on Oct. 21, 2023, 1:06 a.m.