q_ratio: Photon:photon ratio

Description Usage Arguments Value Methods (by class) Note See Also Examples

View source: R/spct.ratios.R

Description

This function returns the photon ratio for a given pair of wavebands of a light source spectrum.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
q_ratio(spct, w.band.num, w.band.denom, wb.trim, use.cached.mult, use.hinges,
  ...)

## Default S3 method:
q_ratio(spct, w.band.num, w.band.denom, wb.trim,
  use.cached.mult, use.hinges, ...)

## S3 method for class 'source_spct'
q_ratio(spct, w.band.num = NULL, w.band.denom = NULL,
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.cached.mult = FALSE,
  use.hinges = getOption("photobiology.use.hinges"), ...)

## S3 method for class 'source_mspct'
q_ratio(spct, w.band.num = NULL, w.band.denom = NULL,
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.cached.mult = FALSE,
  use.hinges = getOption("photobiology.use.hinges"), ...,
  idx = !is.null(names(spct)))

Arguments

spct

an object of class "source_spct"

w.band.num

waveband definition created with new_waveband()

w.band.denom

waveband definition created with new_waveband()

wb.trim

logical if TRUE wavebands crossing spectral data boundaries are trimmed, if FALSE, they are discarded

use.cached.mult

logical indicating whether multiplier values should be cached between calls

use.hinges

logical indicating whether to use hinges to reduce interpolation errors

...

other arguments (possibly ignored)

idx

logical whether to add a column with the names of the elements of spct

Value

a single numeric nondimensional value giving a photon ratio between pairs of wavebands, with name attribute set to the name of the wavebands unless a named list of wavebands is supplied in which case the names of the list elements are used, with "(q:q)" appended.

Methods (by class)

Note

Recycling for wavebans takes place when the number of denominator and denominator wavebands differ. The last two parameters control speed optimizations. The defaults should be suitable in mosts cases. If you will use repeatedly the same SWFs on many spectra measured at exactly the same wavelengths you may obtain some speed up by setting use.cached.mult=TRUE. However, be aware that you are responsible for ensuring that the wavelengths are the same in each call, as the only test done is for the length of the w.length vector.

See Also

Other photon and energy ratio functions: e_ratio, energy_ratio, eq_ratio, photon_ratio, photons_energy_ratio, qe_ratio

Examples

1

photobiology documentation built on Aug. 27, 2017, 5:05 p.m.