Learn R Programming

⚠️There's a newer version (0.13.1) of this package.Take me there.

photobiology

Package ‘photobiology’ defines a system of classes for storing spectral data and accompanying metadata. For each of these classes specialised summary methods, maths operators and functions are provided. In addition, classes for storing collections of objects of the classes for individual spectra are defined as well as ‘apply’ functions. Extraction and replacement operators are also implemented. Functions for calculation of the position of the sun, times of sunrise and sunset, day length and night length are also provided.

The package supports storage and manipulation of data for radiation quantities and for optical properties of objects.

This package is the core of a suite of R packages for photobiological calculations described at the r4photobiology web site.

Examples

The first example shows you how to estimate solar irradiance in W/m2 under a filter. We use a measured solar spectrum and a measured filter transmission spectrum.

library(photobiology)
e_irrad(sun.spct * yellow_gel.spct)
#>    Total 
#> 146.5044 
#> attr(,"time.unit")
#> [1] "second"
#> attr(,"radiation.unit")
#> [1] "energy irradiance total"

The second example shows some simple astronomical calculations for the sun.

geocode <- data.frame(lon = 0, lat = 55)
date <- lubridate::today(tzone = "UTC")
sunrise_time(date, tz = "UTC", geocode = geocode)
#> [1] "2019-06-08 03:23:05 UTC"
day_length(date, tz = "UTC", geocode = geocode)
#> [1] 17.19741

Installation

Installation of the most recent stable version from CRAN:

install.packages("photobiology")

Installation of the current unstable version from Bitbucket:

# install.packages("devtools")
devtools::install_bitbucket("aphalo/photobiology")

Documentation

HTML documentation is available at (https://docs.r4photobiology.info/photobiology/), including a User Guide.

News on updates to the different packages of the ‘r4photobiology’ suite are regularly posted at (https://www.r4photobiology.info/).

Two articles introduce the basic ideas behind the design of the suite and describe its use: Aphalo P. J. (2015) (https://doi.org/10.19232/uv4pb.2015.1.14) and Aphalo P. J. (2016) (https://doi.org/10.19232/uv4pb.2016.1.15).

A book is under preparation, and the draft is currently available at (https://leanpub.com/r4photobiology/).

A handbook written before the suite was developed contains useful information on the quantification and manipulation of ultraviolet and visible radiation: Aphalo, P. J., Albert, A., Björn, L. O., McLeod, A. R., Robson, T. M., & Rosenqvist, E. (Eds.) (2012) Beyond the Visible: A handbook of best practice in plant UV photobiology (1st ed., p. xxx + 174). Helsinki: University of Helsinki, Department of Biosciences, Division of Plant Biology. ISBN 978-952-10-8363-1 (PDF), 978-952-10-8362-4 (paperback). PDF file available from (https://hdl.handle.net/10138/37558).

Contributing

Pull requests, bug reports, and feature requests are welcome at (https://bitbucket.org/aphalo/photobiology).

Citation

If you use this package to produce scientific or commercial publications, please cite according to:

citation("photobiology")
#> 
#> To cite package 'photobiology' in publications, please use:
#> 
#>   Aphalo, Pedro J. (2015) The r4photobiology suite. UV4Plants
#>   Bulletin, 2015:1, 21-29. DOI:10.19232/uv4pb.2015.1.14
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Article{,
#>     author = {Pedro J. Aphalo},
#>     title = {The r4photobiology suite},
#>     journal = {UV4Plants Bulletin},
#>     volume = {2015},
#>     number = {1},
#>     pages = {21-29},
#>     year = {2015},
#>     doi = {10.19232/uv4pb.2015.1.14},
#>   }

License

© 2012-2019 Pedro J. Aphalo (pedro.aphalo@helsinki.fi). Released under the GPL, version 2 or greater. This software carries no warranty of any kind.

Copy Link

Version

Install

install.packages('photobiology')

Monthly Downloads

450

Version

0.9.28

License

GPL (>= 2)

Maintainer

Pedro Aphalo

Last Published

June 8th, 2019

Functions in photobiology (0.9.28)

as.calibration_spct

Coerce to a spectrum
D65.illuminant.spct

CIE D65 illuminant data
D2_spectrum

Calculate deuterium lamp output spectrum from fitted constants
D2.UV654

Data for typical calibration lamps
FEL.BN.9101.165

Data for typical calibration lamps
as.chroma_mspct

Coerce to a collection-of-spectra
T2Afr

Convert transmittance into absorptance.
T2A

Convert transmittance into absorbance.
absorptance

Absorptance
absorptance_spct

Calculate absorptance from spectral absorptance.
as.filter_spct

Coerce to a spectrum
as.chroma_spct

Coerce to a spectrum
as.generic_mspct

Coerce to a collection-of-spectra
as.cps_mspct

Coerce to a collection-of-spectra
FEL_spectrum

Incandescent "FEL" lamp emission spectrum
Ler_leaf.spct

Green Arabidopsis leaf reflectance and transmittance.
as.response_mspct

Coerce to a collection-of-spectra
as.response_spct

Coerce to a spectrum
as.filter_mspct

Coerce to a collection-of-spectra
as.raw_mspct

Coerce to a collection-of-spectra
MathFun

Miscellaneous Mathematical Functions
as.cps_spct

Coerce to a spectrum
as.raw_spct

Coerce to a spectrum
Ler_leaf_trns_i.spct

Green Arabidopsis leaf spectral transmittance.
calc_source_output

Scaled and/or interpolated light-source spectral output
calc_multipliers

Spectral weights
as.object_mspct

Coerce to a collection-of-spectra
black_body.spct

Theoretical black body
clear.spct

Theoretical spectrum of a clear material
ciexyzCMF10.spct

Linear energy CIE xyz colour matching function (CMF) 10 deg data
ciexyzCC2.spct

CIE xyz chromaticity coordinates 2 deg data
find_wls

Find wavelength values in a spectrum
clear_body.spct

Theoretical clear body
fluence

Fluence
as.object_spct

Coerce to a spectrum
as_energy

Convert spectral photon irradiance into spectral energy irradiance
ciexyzCMF2.spct

Linear energy CIE xyz colour matching function (CMF) 2 deg data
as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance
as.source_spct

Coerce to a spectrum
as_quantum

Convert spectral energy irradiance into spectral photon irradiance
c

Combine collections of spectra
getWhenMeasured

Get the "when.measured" attribute
getWhereMeasured

Get the "where.measured" attribute
fshift_spct

fshift a spectrum
fshift

Shift the scale of a spectrum using a summary function
clean

Clean (=replace) off-range values in a spectrum
checkSpctVersion

Check that the "spct.version" attribute is set
irradiance

Photon or energy irradiance from spectral energy or photon irradiance.
is.generic_mspct

Query class of spectrum objects
checkTimeUnit

Check the "time.unit" attribute of an existing source_spct object
merge2object_spct

Merge into object_spct
l_insert_hinges

Insert wavelength values into spectral data.
calendar_change

Solar astronomy using Meeus' algorithm
wl_max

Wavelength maximum
D2.UV586

Data for typical calibration lamps
normalization

Normalization of an R object
check_spct

Check validity of spectral objects
class_spct

Query which is the class of an spectrum
e2qmol_multipliers

Calculate energy to quantum (mol) multipliers
e2q

Convert energy-based quantities into photon-based quantities.
D2.UV653

Data for typical calibration lamps
Ler_leaf_rflt.spct

Green Arabidopsis leaf spectral reflectance.
clean_spct

Clean a spectrum
e_irrad

Energy irradiance
cps2irrad

Conversion from counts per second to physical quantities
e_ratio

Energy:energy ratio
day_night

Times for sun positions
check_spectrum

Sanity check a spectrum
normalize

Normalize spectral data
color_of

Color of an object
Ler_leaf_trns.spct

Green Arabidopsis leaf spectral transmittance.
Extract

Extract or replace parts of a spectrum
Extract_mspct

Extract or replace members of a collection of spectra
getScaled

Get the "scaled" attribute
interpolate_spectrum

Calculate spectral values at a different set of wavelengths
filter_cps.mspct

Counts per second from a measurement of a plastic film
interpolate_spct

Map a spectrum to new wavelength values.
getRfrType

Get the "Rfr.type" attribute
f_dispatcher_spct

Math function dispatcher for spectra
print.solar_time

Print solar time and solar date objects
convertTimeUnit

Convert the "time.unit" attribute of an existing source_spct object
is_photon_based

Query if a spectrum contains photon- or energy-based data.
is_scaled

Query whether a generic spectrum has been scaled
print.summary_generic_spct

Print spectral summary
q2e

Convert photon-based quantities into energy-based quantities
q_fluence

Photon fluence
as.generic_spct

Coerce to a spectrum
as.matrix-mspct

Coerce a collection of spectra into a matrix
mod-.generic_spct

Arithmetic Operators
defunct

Defunct functions and methods
round

Rounding of Numbers
T2T

Convert transmittance type.
as_tod

Convert date to time-of-day in hours, minutes or seconds
Trig

Trigonometric Functions
s_mean_se

Mean and standard error from collection of spectra
rowwise

rowwise functions for collections of spectra
auto_hinges

Guess whether insertion of hinges is needed or not
ccd.spct

Spectral response of a back-thinned CCD image sensor.
fscale_spct

fscale a spectrum
fscale

Rescale a spectrum using a summary function
setIdFactor

Set the "idfactor" attribute
setHowMeasured

Set the "how.measured" attribute
s_median

Median of a collection of spectra
checkMspctVersion

Check that the "mspct.version" attribute is set
ciev2.spct

Linear energy CIE 2008 luminous efficiency function 2 deg data
add_attr2tb

Copy attributes from members of a generic_mspct
as.reflector_mspct

Coerce to a collection-of-spectra
as.calibration_mspct

Coerce to a collection-of-spectra
setWhatMeasured

Set the "what.measured" attribute
generic_mspct

Collection-of-spectra constructor
getAfrType

Get the "Afr.type" attribute
getWhatMeasured

Get the "what.measured" attribute
getTimeUnit

Get the "time.unit" attribute of an existing source_spct object
setWhenMeasured

Set the "when.measured" attribute
split_energy_irradiance

Energy irradiance for split spectrum regions
green_leaf.spct

Green birch leaf reflectance.
as.solar_date

Convert a solar_time object into solar_date object
as.reflector_spct

Coerce to a spectrum
head_tail

Return the First and Last Part of an Object
as.source_mspct

Coerce to a collection-of-spectra
split_irradiance

Energy or photon irradiance for split spectrum regions
subset2mspct

Convert 'long' or tidy spectral data into a collection of spectra
trim_tails

Trim (or expand) head and/or tail
Subset

Subsetting spectra
waveband_ratio

Photon or energy ratio
wb2rect_spct

Create tagged spectrum from wavebands
trim_waveband

Trim (or expand) head and/or tail
white_body.spct

Theoretical white body
dim.generic_mspct

Dimensions of an Object
wb_trim_as_default

Set computation options
msmsply

Multi-spct transform methods
isValidInstrDesc

Check the "instr.desc" attribute
ciexyzCC10.spct

CIE xyz chromaticity coordinates (CC) 10 deg data
na.omit

Handle Missing Values in Objects
is.waveband

Query if it is a waveband
convolve_each

Convolve function for collections of spectra
mspct_classes

Names of multi-spectra classes
energy_irradiance

Calculate (energy) irradiance from spectral irradiance
is_tagged

Query if it is an spectrum is tagged
average_spct

Average spectral data.
eq_ratio

Energy:photon ratio
copy_attributes

Copy attributes
e2quantum_multipliers

Calculate energy to quantum multipliers
e_fluence

Energy fluence
spread

Expanse
getInstrDesc

Get the "instr.desc" attribute
getIdFactor

Get the "idfactor" attribute
join_mspct

Join all spectra in a collection
energy_ratio

Energy:energy ratio
^.generic_spct

Arithmetic Operators
getMultipleWl

Get the "multiple.wl" attribute
div-.generic_spct

Arithmetic Operators
beesxyzCMF.spct

Honeybee xyz chromaticity colour matching function data
ciev10.spct

Linear energy CIE 2008 luminous efficiency function 10 deg data
clear_photobio.cache

Clear the spectral weights cache
check_w.length

Sanity check of wavelengths (internal function).
clip_wl

Clip head and/or tail of a spectrum
merge_attributes

Merge and copy attributes
wl_midpoint

Midpoint
div_spectra

Divide two spectra, even if the wavelengths values differ
print

Print a spectral object
format.solar_time

Encode in a Common Format
find_peaks

Find peaks in a spectrum
findMultipleWl

Find repeated w.length values
energy_as_default

Set spectral-data options
e_response

Energy-based photo-response
q_irrad

Photon irradiance
formatted_range

Compute range and format it
q_ratio

Photon:photon ratio
getInstrSettings

Get the "instr.settings" attribute
normalize_range_arg

Normalize a range argument into a true numeric range
print.waveband

Print a "waveband" object
prod_spectra

Multiply two spectra, even if the wavelengths values differ
response

Integrated response
normalized_diff_ind

Calculate a normalized index.
s_sd

Standard Deviation of a collection of spectra
insert_hinges

Insert wavelength values into spectral data.
insert_spct_hinges

Insert new wavelength values into a spectrum
getNormalized

Get the "normalized" attribute
getBSWFUsed

Get the "bswf.used" attribute
is.solar_time

Query class
is.summary_generic_spct

Query class of spectrum summary objects
wl_min

Wavelength minimum
is_effective

Is an R object "effective"
is_normalized

Query whether a generic spectrum has been normalized.
getHowMeasured

Get the "how.measured" attribute
minus-.generic_spct

Arithmetic Operators
s_prod

Product from collection of spectra
rgb_spct

RGB color values
getMspctVersion

Get the "mspct.version" attribute
s_range

Range of a collection of spectra
integrate_xy

Gives irradiance from spectral irradiance.
interpolate_wl

Map spectra to new wavelength values.
irrad

Irradiance
integrate_spct

Integrate spectral data.
s_se

Standard Error of a collection of spectra
getTfrType

Get the "Tfr.type" attribute
getSpctVersion

Get the "spct.version" attribute
isValidInstrSettings

Check the "instr.settings" attribute
peaks

Peaks or local maxima
setMultipleWl

Set the "multiple.wl" attribute
get_attributes

Get the metadata attributes
solar_time

Local solar time
setGenericSpct

Convert an R object into a spectrum object.
sun.spct

Solar spectral irradiance (simulated)
smooth_spct

Smooth a spectrum
setBSWFUsed

Set the "bswf.used" attribute
sun.data

Solar spectral irradiance (simulated)
photobiology-package

photobiology: Photobiological Calculations
is.generic_spct

Query class of spectrum objects
get_peaks

Get peaks and valleys in a spectrum
is.old_spct

Query if an object has old class names
photons_energy_ratio

Photon:energy ratio
photon_ratio

Photo:photon ratio
plus-.generic_spct

Arithmetic Operators
oper_spectra

Binary operation on two spectra, even if the wavelengths values differ
opaque.spct

Theoretical spectrum of an opaque material
polyester.spct

Transmittance spectrum of clear polyester film
se

Standard error of the mean
rmDerivedSpct

Remove "generic_spct" and derived class attributes.
rmDerivedMspct

Remove "generic_mspct" and derived class attributes.
is_absorbance_based

Query if a spectrum contains absorbance or transmittance data
q_response

Photon-based photo-response
transmittance

Transmittance
qe_ratio

Photon:energy ratio
reflectance_spct

Calculate reflectance from spectral reflectance
s_sum

Sum from collection of spectra
reflectance

Reflectance
log

Logarithms and Exponentials
labels

Find labels from "waveband" object
setRfrType

Set the "Rfr.type" attribute
s_var

Variance of a collection of spectra
setAfrType

Set the "Afr.type" attribute
setTimeUnit

Set the "time.unit" attribute of an existing source_spct object
setTfrType

Set the "Tfr.type" attribute
photodiode.spct

Spectral response of a GaAsP photodiode
setNormalized

Set the "normalized" attribute
sign

Sign
slash-.generic_spct

Arithmetic Operators
summary_spct_classes

Function that returns a vector containing the names of spectral summary classes.
summary

Summary of a spectral object
split_bands

List-of-wavebands constructor
setScaled

Set the "scaled" attribute
split2mspct

Convert a 'wide' or untidy data frame into a collection of spectra
sun_angles

Solar angles
times-.generic_spct

Arithmetic Operators
photon_irradiance

Photon irradiance
tag

Tag a spectrum
using_Tfr

Use photobiology options
wl_range

Wavelength range
upgrade_spct

Upgrade one spectral object
upgrade_spectra

Upgrade one or more spectral objects
spct_classes

Function that returns a vector containing the names of spectra classes.
source_spct

Spectral-object constructor
rbindspct

Row-bind spectra
relative_AM

Relative Air Mass (AM)
v_insert_hinges

Insert spectral data values at new wavelength values.
yellow_gel.spct

Transmittance spectrum of yellow theatrical gel.
resp_spct

Calculate response from spectral response
valleys

Valleys or local minima
s_e_irrad2rgb

Spectral irradiance to rgb color conversion
s_mean

Mean from collection of spectra
v_replace_hinges

Overwrite spectral data values at existing wavelength values.
sum_spectra

Add two spectra
subt_spectra

Subtract two spectra
sun.daily.data

Daily solar spectral irradiance (simulated)
sun.daily.spct

Daily solar spectral irradiance (simulated)
setInstrSettings

Set the "instr.settings" attribute
setInstrDesc

Set the "instr.desc" attribute
verbose_as_default

Set error reporting options
wls_at_target

Find wavelengths values corresponding to a target spectral value
white_led.source_spct

White led bulb spectrum
setWhereMeasured

Set the "where.measured" attribute
shared_member_class

Classes common to all collection members.
split_photon_irradiance

Photon irradiance for split spectrum regions
transmittance_spct

Calculate transmittance from spectral transmittance.
tz_time_diff

Time difference between two time zones
trimInstrDesc

Trim the "instr.desc" attribute
water_vp_sat

Water vapour pressure
validate_geocode

Validate a geocode
wb2spct

Create spectrum from wavebands
untag

Remove tags
waveband

Waveband constructor method
wl_stepsize

Stepsize
white_led.raw_spct

White led bulb spectrum
white_led.cps_spct

White led bulb spectrum
wb2tagged_spct

Create tagged spectrum from wavebands
trim_wl

Trim head and/or tail of a spectrum
trimInstrSettings

Trim the "instr.settings" attribute
trim_spct

Trim (or expand) head and/or tail of a spectrum
twilight2angle

twilight argument check and conversion
w_length2rgb

Wavelength to rgb color conversion
w_length_range2rgb

Wavelength range to rgb color conversion
A.illuminant.spct

CIE A illuminant data
A2T

Convert absorbance into transmittance
absorbance

Absorbance
absorbance_spct

Calculate absorbance from spectral absorbance.