Comparison {hyperSpec}

Comparison of hyperSpec objects

Description

The comparison operators >, <, >=, <=, ==, and != for hyperSpec objects.

Usage

## S4 method for signature 'hyperSpec,hyperSpec'
Compare(e1, e2)

## S4 method for signature 'hyperSpec,numeric'
Compare(e1, e2)

## S4 method for signature 'hyperSpec,matrix'
Compare(e1, e2)

## S4 method for signature 'numeric,hyperSpec'
Compare(e1, e2)

## S4 method for signature 'matrix,hyperSpec'
Compare(e1, e2)

## S4 method for signature 'hyperSpec,hyperSpec'
all.equal(
  target,
  current,
  ...,
  check.attributes = FALSE,
  check.names = FALSE,
  check.column.order = FALSE,
  check.label = FALSE,
  tolerance = hy.getOption("tolerance"),
  wl.tolerance = hy.getOption("wl.tolerance")
)

Arguments

e1, e2

Either two hyperSpec objects or one hyperSpec object and matrix of same size as hyperSpec[[]] or a scalar (numeric of length 1).

As hyperSpec objects must have numeric spectra matrices, the resulting matrix of the comparison is returned directly.

target, current

two hyperSpec objects that are tested for equality

...

handed to all.equal when testing the slots of the hyperSpec objects

check.attributes, check.names

see all.equal

check.column.order

If two objects have the same data, but the order of the columns (determined by the names) differs, should they be regarded as different?

check.label

Should the slot label be checked?
If the labels differ only in the order of their entries, they are conidered equal.

tolerance, wl.tolerance

tolerances for checking wavelengths and data, respectively

Details

all.equal checks the equality of two hyperSpec objects.

The comparison operators >, <, >=, <=, ==, and != work on the spectra matrix of the hyperSpec object. They have their usual meaning (see Comparison). The operators work also with one hyperSpec object and a numeric (scalar) object or a matrices of the same size as the spectra matrix of the hyperSpec object.

With numeric vectors sweep might be more appropriate.

If you want to calculate on the data.frame hyperSpec@data, you have to do this directly on hyperSpec@data.

Value

a logical matrix for the comparison operators.

all.equal returns either TRUE, or a character vector describing the differences. In conditions, the result must therefore be tested with isTRUE.

Author(s)

C. Beleites

See Also

sweep-methods for calculations involving a vector and the spectral matrix.

S4groupGeneric for group generic methods.

Comparison for the base comparison functions.

Arith for arithmetic operators, Math for mathematical group generic functions (groups Math and Math2) working on hyperSpec objects.

all.equal and isTRUE

Examples

flu [,,445 ~ 450] > 300

all (flu == flu[[]])