Summarize spectral irradiance or fluence

Compute irradiance or fluence by waveband and energy or photon ratios between wavebands of interest to plants' and human visual responses to light.

Usage

irrad_summary_table(
  mspct,
  unit.out = getOption("photobiology.radiation.unit", default = "energy"),
  scale.factor = ifelse(unit.out == "photon", 1e+06, 1),
  attr2tb = "when.measured",
  summary.type = "plant",
  digits = 3L
)

Arguments

mspct

A source_mspct, or a source_spct object containing spectral irradiance for one or more sources.

unit.out

character One of "photon" or "energy".

scale.factor

numeric A multiplicative factor used to rescale data.

attr2tb

character Vector with one or more of "when.measured", "what.measured", "where.measured", "how.measured" and "comment".

summary.type

character One of "plant", "PAR" or "VIS".

digits

integer The number of significant digits in the output.

Value

A tibble with one row per spectrum and one column per summary quantity and attribute and a column with the names of the spectra.

Details

This function packages different functions from pacakge 'photobiology' and returns a typical set of summaries for different purposes.

See also

See the documentation for functions irrad, q_ratio, e_ratio, add_attr2tb, spct_CRI, spct_CCT and signif which are called to build the summary table.

Examples

irrad_summary_table(sun.spct)
#> # A tibble: 1 × 14
#>   spct.idx  E_UVB.ISO E_UVA2.CIE E_UVA1.CIE E_Blue.Sellaro E_Green.Sellaro
#>   <fct>         <dbl>      <dbl>      <dbl>          <dbl>           <dbl>
#> 1 spct.name     0.645       5.98         22           49.6            49.3
#> # ℹ 8 more variables: E_Red.Smith20 <dbl>, E_FarRed.Smith20 <dbl>, E_PAR <dbl>,
#> #   `UVB:PAR[e:e]` <dbl>, `UVA:PAR[e:e]` <dbl>, `blue:green[e:e]` <dbl>,
#> #   `red:far-red[e:e]` <dbl>, when.measured <dttm>
irrad_summary_table(sun.spct, attr2tb = c("what.measured", "where.measured"))
#> # A tibble: 1 × 15
#>   spct.idx  E_UVB.ISO E_UVA2.CIE E_UVA1.CIE E_Blue.Sellaro E_Green.Sellaro
#>   <fct>         <dbl>      <dbl>      <dbl>          <dbl>           <dbl>
#> 1 spct.name     0.645       5.98         22           49.6            49.3
#> # ℹ 9 more variables: E_Red.Smith20 <dbl>, E_FarRed.Smith20 <dbl>, E_PAR <dbl>,
#> #   `UVB:PAR[e:e]` <dbl>, `UVA:PAR[e:e]` <dbl>, `blue:green[e:e]` <dbl>,
#> #   `red:far-red[e:e]` <dbl>, what.measured <chr>, where.measured <named list>
irrad_summary_table(sun.spct, summary.type = "plant", unit.out = "photon")
#> # A tibble: 1 × 14
#>   spct.idx  Q_UVB.ISO Q_UVA2.CIE Q_UVA1.CIE Q_Blue.Sellaro Q_Green.Sellaro
#>   <fct>         <dbl>      <dbl>      <dbl>          <dbl>           <dbl>
#> 1 spct.name      1.68       16.5       68.4            189             220
#> # ℹ 8 more variables: Q_Red.Smith20 <dbl>, Q_FarRed.Smith20 <dbl>, Q_PAR <dbl>,
#> #   `UVB:PAR[q:q]` <dbl>, `UVA:PAR[q:q]` <dbl>, `blue:green[q:q]` <dbl>,
#> #   `red:far-red[q:q]` <dbl>, when.measured <dttm>
irrad_summary_table(sun.spct, summary.type = "PAR", unit.out = "photon")
#> # A tibble: 1 × 10
#>   spct.idx  Q_UVB.CIE Q_UVA2.CIE Q_UVA1.CIE Q_PAR `UVB:PAR[q:q]` `UVA:PAR[q:q]`
#>   <fct>         <dbl>      <dbl>      <dbl> <dbl>          <dbl>          <dbl>
#> 1 spct.name      1.68       16.5       68.4   894        0.00187         0.0949
#> # ℹ 3 more variables: `blue:green[q:q]` <dbl>, `red:far-red[q:q]` <dbl>,
#> #   when.measured <dttm>
# temporary kludge until fixed in photobiologyInOut
# irrad_summary_table(sun.spct, summary.type = "VIS", unit.out = "energy")