energy_ratio: Energy:energy ratio

In photobiology: Photobiological Calculations

Description

Energy irradiance ratio between two wavebands for a radiation spectrum.

Usage

energy_ratio(
  w.length,
  s.irrad,
  w.band.num = NULL,
  w.band.denom = NULL,
  unit.in = "energy",
  check.spectrum = TRUE,
  use.cached.mult = FALSE,
  use.hinges = NULL
)

Arguments

w.length	numeric vector of wavelengths (nm).
s.irrad	numeric vector of spectral (energy) irradiances (W m-2 nm-1).
w.band.num	waveband object used to compute the numerator of the ratio.
w.band.denom	waveband object used to compute the denominator of the ratio.
unit.in	character Allowed values "energy", and "photon", or its alias "quantum".
check.spectrum	logical Flag indicating whether to sanity check input data, default is TRUE.
use.cached.mult	logical Flag indicating whether multiplier values should be cached between calls.
use.hinges	logical Flag indicating whether to insert "hinges" into the spectral data before integration so as to reduce interpolation errors at the boundaries of the wavebands.

Value

a single numeric value giving the unitless ratio.

Note

The default for both w.band parameters is a waveband covering the whole range of w.length.

See Also

Other low-level functions operating on numeric vectors.: as_energy(), as_quantum_mol(), calc_multipliers(), div_spectra(), energy_irradiance(), insert_hinges(), integrate_xy(), interpolate_spectrum(), irradiance(), l_insert_hinges(), oper_spectra(), photon_irradiance(), photon_ratio(), photons_energy_ratio(), prod_spectra(), s_e_irrad2rgb(), split_energy_irradiance(), split_photon_irradiance(), subt_spectra(), sum_spectra(), trim_tails(), v_insert_hinges(), v_replace_hinges()

Examples

with(sun.data,
     energy_ratio(w.length, s.e.irrad, new_waveband(400,500), new_waveband(400,700)))

photobiology documentation built on Aug. 28, 2020, 1:11 a.m.