Skip to contents

Photon:energy ratio

Source: R/photons.energy.ratio.r
photons_energy_ratio.Rd

This function gives the photons:energy ratio between for one given waveband of a radiation spectrum.

Usage

photons_energy_ratio(
  w.length,
  s.irrad,
  w.band = NULL,
  unit.in = "energy",
  check.spectrum = TRUE,
  use.cached.mult = FALSE,
  use.hinges = getOption("photobiology.use.hinges", default = NULL)
)

Arguments

w.length

numeric vector of wavelength (nm).

s.irrad

numeric vector of spectral irradiances in [\(W\,m^{-2}\,nm^{-1}\)] or [\(mol\,s^{-1}\,sm^{-2}\,nm^{-1}\)] as indicated by the argument pased to unit.in.

w.band

waveband object.

unit.in

character Allowed values "energy", and "photon", or its alias "quantum".

check.spectrum

logical Flag telling whether to sanity check input data, default is TRUE.

use.cached.mult

logical Flag telling 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 ratio moles-photons per Joule.

Note

The default for the w.band parameter 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(), energy_ratio(), insert_hinges(), integrate_xy(), interpolate_spectrum(), irradiance(), l_insert_hinges(), oper_spectra(), photon_irradiance(), photon_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

# photons:energy ratio
with(sun.data,
     photons_energy_ratio(w.length, s.e.irrad, new_waveband(400,500)))
#> [1] 3.778889e-06
# photons:energy ratio for whole spectrum
with(sun.data, photons_energy_ratio(w.length, s.e.irrad))
#> [1] 4.664578e-06