photobiology (version 0.9.6)

q_ratio: Photon:photon ratio

Description

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

Usage

q_ratio(spct, w.band.num, w.band.denom, wb.trim, use.cached.mult, use.hinges,
  ...)

## S3 method for class 'default':
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",
  default = NULL), ...)

## 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",
  default = NULL), ..., 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)

• default: Default for generic function
• source_spct: Method forsource_spctobjects
• source_mspct: Calculates photon:photon from asource_mspctobject.

See Also

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

Examples

q_ratio(sun.spct, new_waveband(400,500), new_waveband(400,700))