rescale: Rescale an sscs object.

Description Usage Arguments Details Value

View source: R/sscs.R

Description

Change the quantization scale for an sscs object.

Usage

1
  rescale(sscs, qscale=NA)

Arguments

sscs

Object of class 'sscs' created by new_sscs(...).

qscale

Quantization scale (numeric value or NA).

Details

Changes the quantization scale of the given sscs object to match the numeric value of qscale. If qscale is NA, a sensible default is computed that guarantees the total system redundancy is less than or equal to 1 and each marginal entropy is greater than or equal to 1. Note that computed redundancies for sscs objects are only comparable when they each use the same quantization scale.

Value

Returns the rescaled sscs S3 object.


crtwomey/sscs documentation built on Dec. 25, 2019, 8:03 a.m.