Learn R Programming

⚠️There's a newer version (0.12.0) 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.

Example

This first basic example shows you how to calculate solar irradiance in W/m2 below 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 basic 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] "2018-04-02 05:28:08 UTC"
day_length(date, tz = "UTC", geocode = geocode)
#> [1] 13.17787

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 (http://docs.r4photobiology.info/photobiology/), including a User Guide.

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

Two articles introduce the basic ideas behind the design of the suite and 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 (http://hdl.handle.net/10138/37558).

Contributing

Pull requests, bug reports, and feature requests are welcome at (http://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-2018 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

649

Version

0.9.20

License

GPL (>= 2)

Maintainer

Pedro Aphalo

Last Published

April 2nd, 2018

Functions in photobiology (0.9.20)

as.calibration_spct

Coerce to a spectrum
Ler_leaf_rflt.spct

Green Arabidopsis leaf spectral reflectance.
as.chroma_spct

Coerce to a spectrum
as.raw_mspct

Coerce to a collection-of-spectra
calc_multipliers

Spectral weights
as.response_mspct

Coerce to a collection-of-spectra
as.response_spct

Coerce to a spectrum
absorptance

Absorptance
calc_source_output

Scaled and/or interpolated light-source spectral output
as.raw_spct

Coerce to a spectrum
as.cps_spct

Coerce to a spectrum
absorptance_spct

Calculate absorptance from spectral absorptance.
as.filter_spct

Coerce to a spectrum
checkTimeUnit

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

Coerce to a collection-of-spectra
as_energy

Convert spectral photon irradiance into spectral energy irradiance
as.generic_mspct

Coerce to a collection-of-spectra
as.source_spct

Coerce to a spectrum
checkSpctVersion

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

Linear energy CIE xyz colour matching function (CMF) 2 deg data
as.cps_mspct

Coerce to a collection-of-spectra
ciexyzCC2.spct

CIE xyz chromaticity coordinates 2 deg data
dim.generic_mspct

Dimensions of an Object
Extract

Extract or replace parts of a spectrum
clip_wl

Clip head and/or tail of a spectrum
clear_photobio.cache

Clear the spectral weights cache
defunct

Defunct functions and methods
ciexyzCMF10.spct

Linear energy CIE xyz colour matching function (CMF) 10 deg data
as.reflector_mspct

Coerce to a collection-of-spectra
class_spct

Query which is the class of an spectrum
as.reflector_spct

Coerce to a spectrum
Extract_mspct

Extract or replace members of a collection of spectra
formatted_range

Compute range and format it
format.solar_time

Encode in a Common Format
as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance
as_quantum

Convert spectral energy irradiance into spectral photon irradiance
as.filter_mspct

Coerce to a collection-of-spectra
clean

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

Get the "instr.settings" attribute
getMspctVersion

Get the "mspct.version" attribute
T2Afr

Convert transmittance into absorptance.
getTimeUnit

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

Coerce to a collection-of-spectra
add_attr2tb

Copy attributes from members of a generic_mspct
as.object_mspct

Coerce to a collection-of-spectra
clean_spct

Clean a spectrum
getWhatMeasured

Get the "what.measured" attribute
ccd.spct

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

Map a spectrum to new wavelength values.
as.generic_spct

Coerce to a spectrum
as.object_spct

Coerce to a spectrum
as_tod

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

Average spectral data.
e2q

Convert energy-based quantities into photon-based quantities.
as.matrix-mspct

Coerce a collection of spectra into a matrix
auto_hinges

Guess whether insertion of hinges is needed or not
e2qmol_multipliers

Calculate energy to quantum (mol) multipliers
e_response

Energy-based photo-response
beesxyzCMF.spct

Honeybee xyz chromaticity colour matching function data
as.solar_date

Convert a solar_time object into solar_date object
check_spct

Check validity of spectral objects
checkMspctVersion

Check that the "mspct.version" attribute is set
as.source_mspct

Coerce to a collection-of-spectra
energy_as_default

Set spectral-data options
check_spectrum

Sanity check a spectrum
ciev2.spct

Linear energy CIE 2008 luminous efficiency function 2 deg data
convertTimeUnit

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

Color of an object
e2quantum_multipliers

Calculate energy to quantum multipliers
fscale

Rescale a spectrum using a summary function
interpolate_spectrum

Calculate spectral values at a different set of wavelengths
ciexyzCC10.spct

CIE xyz chromaticity coordinates (CC) 10 deg data
div-.generic_spct

Arithmetic Operators
clear.spct

Theoretical spectrum of a clear material
fscale_spct

fscale a spectrum
clear_body.spct

Theoretical clear body
is_absorbance_based

Query if a spectrum contains absorbance or transmittance data
isValidInstrSettings

Check the "instr.settings" attribute
black_body.spct

Theoretical black body
c.generic_mspct

Combine collections of spectra
check_w.length

Sanity check of wavelengths (internal function).
convolve_each

Convolve function for collections of spectra
ciev10.spct

Linear energy CIE 2008 luminous efficiency function 10 deg data
copy_attributes

Copy attributes from one R object to another
eq_ratio

Energy:photon ratio
generic_mspct

Collection-of-spectra constructor
julian_day

Solar astronomy using Meeus' algorithm
getAfrType

Get the "Afr.type" attribute
e_irrad

Energy irradiance
e_fluence

Energy fluence
cps2irrad

Conversion from counts per second to physical quantities
day_night

Times for sun positions
green_leaf.spct

Green birch leaf reflectance.
l_insert_hinges

Insert wavelength values into spectral data.
head_tail

Return the First and Last Part of an Object
irradiance

Photon or energy irradiance from spectral energy or photon irradiance.
div_spectra

Divide two spectra, even if the wavelengths values differ
msmsply

Multi-spct transform methods
e_ratio

Energy:energy ratio
spread

Expanse
mspct_classes

Names of multi-spectra classes
energy_irradiance

Calculate (energy) irradiance from spectral irradiance
find_peaks

Find peaks in a spectrum
oper_spectra

Binary operation on two spectra, even if the wavelengths values differ
is.generic_mspct

Query class of spectrum objects
fluence

Fluence
peaks

Peaks or local maxima
getRfrType

Get the "Rfr.type" attribute
get_attributes

Get the metadata attributes
fshift_spct

fshift a spectrum
fshift

Shift the scale of a spectrum using a summary function
getMultipleWl

Get the "multiple.wl" attribute
getNormalized

Get the "normalized" attribute
insert_hinges

Insert wavelength values into spectral data.
energy_ratio

Energy:energy ratio
get_peaks

Get peaks and valleys in a spectrum
getScaled

Get the "scaled" attribute
polyester.spct

Transmittance spectrum of clear polyester film
insert_spct_hinges

Insert new wavelength values into a spectrum
is.solar_time

Query class
is.generic_spct

Query class of spectrum objects
getWhenMeasured

Get the "when.measured" attribute
is.old_spct

Query if an object has old class names
getWhereMeasured

Get the "where.measured" attribute
^.generic_spct

Arithmetic Operators
is_photon_based

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

Query class of spectrum summary objects
interpolate_wl

Map spectra to new wavelength values.
is_scaled

Query whether a generic spectrum has been scaled
irrad

Irradiance
is.waveband

Query if it is a waveband
isValidInstrDesc

Check the "instr.desc" attribute
qe_ratio

Photon:energy ratio
wl_midpoint

Midpoint
f_dispatcher_spct

Math function dispatcher for spectra
filter_cps.mspct

Counts per second from a measurement of a plastic film
wl_min

Wavelength minimum
getBSWFUsed

Get the "bswf.used" attribute
is_tagged

Query if it is an spectrum is tagged
photon_irradiance

Photon irradiance
wl_range

Wavelength range
labels

Find labels from "waveband" object
setInstrDesc

Set the "instr.desc" attribute
log

Logarithms and Exponentials
setInstrSettings

Set the "instr.settings" attribute
setTfrType

Set the "Tfr.type" attribute
join_mspct

Join all spectra in a collection
normalize

Normalize spectral data
normalize_range_arg

Normalize a range argument into a true numeric range
setTimeUnit

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

Energy irradiance for split spectrum regions
getInstrDesc

Get the "instr.desc" attribute
na.omit.source_spct

Handle Missing Values in Objects
normalization

Normalization of an R object
split_irradiance

Energy or photon irradiance for split spectrum regions
photobiology-package

photobiology: Photobiological Calculations
normalized_diff_ind

Calculate a normalized index.
getSpctVersion

Get the "spct.version" attribute
photon_ratio

Photo:photon ratio
getTfrType

Get the "Tfr.type" attribute
integrate_spct

Integrate spectral data.
q2e

Convert photon-based quantities into energy-based quantities
prod_spectra

Multiply two spectra, even if the wavelengths values differ
opaque.spct

Theoretical spectrum of an opaque material
print.summary_generic_spct

Print spectral summary
print.waveband

Print a "waveband" object
rbindspct

Row-bind spectra
reflectance

Reflectance
photodiode.spct

Spectral response of a GaAsP photodiode
rgb_spct

RGB color values
rmDerivedMspct

Remove "generic_mspct" and derived class attributes.
relative_AM

Relative Air Mass (AM)
reflectance_spct

Calculate reflectance from spectral reflectance
rmDerivedSpct

Remove "generic_spct" and derived class attributes.
q_fluence

Photon fluence
integrate_xy

Gives irradiance from spectral irradiance.
round

Rounding of Numbers
setRfrType

Set the "Rfr.type" attribute
q_irrad

Photon irradiance
is_effective

Is an R object "effective"
resp_spct

Calculate response from spectral response
is_normalized

Query whether a generic spectrum has been normalized.
split_photon_irradiance

Photon irradiance for split spectrum regions
setWhereMeasured

Set the "where.measured" attribute
setScaled

Set the "scaled" attribute
wl_max

Wavelength maximum
shared_member_class

Classes common to all collection members.
solar_time

Local solar time
wl_stepsize

Stepsize
smooth_spct

Smooth a spectrum
sum_spectra

Add two spectra
response

Integrated response
merge2object_spct

Merge into object_spct
sun.spct

Solar spectral irradiance (simulated)
s_e_irrad2rgb

Spectral irradiance to rgb color conversion
slash-.generic_spct

Arithmetic Operators
sign

Sign
setAfrType

Set the "Afr.type" attribute
minus-.generic_spct

Arithmetic Operators
subset2mspct

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

Solar angles
setWhatMeasured

Set the "what.measured" attribute
summary

Summary of a spectral object
mod-.generic_spct

Arithmetic Operators
trimInstrSettings

Trim the "instr.settings" attribute
trim_waveband

Trim (or expand) head and/or tail
subt_spectra

Subtract two spectra
trim_wl

Trim head and/or tail of a spectrum
trimInstrDesc

Trim the "instr.desc" attribute
waveband

Waveband constructor method
twilight2angle

twilight argument check and conversion
photons_energy_ratio

Photon:energy ratio
plus-.generic_spct

Arithmetic Operators
tz_time_diff

Time difference between two time zones
transmittance

Transmittance
waveband_ratio

Photon or energy ratio
setWhenMeasured

Set the "when.measured" attribute
transmittance_spct

Calculate transmittance from spectral transmittance.
print

Print a spectral object
wb2rect_spct

Create tagged spectrum from wavebands
split2mspct

Convert a 'wide' or untidy data frame into a collection of spectra
print.solar_time

Print solar time and solar date objects
q_ratio

Photon:photon ratio
wb2spct

Create spectrum from wavebands
q_response

Photon-based photo-response
split_bands

List-of-wavebands constructor
setBSWFUsed

Set the "bswf.used" attribute
untag

Remove tags
upgrade_spct

Upgrade one spectral object
sun.daily.spct

Daily solar spectral irradiance (simulated)
yellow_gel.spct

Transmittance spectrum of yellow theatrical gel.
sun.data

Solar spectral irradiance (simulated)
setGenericSpct

Convert an R object into a spectrum object.
trim_tails

Trim (or expand) head and/or tail
trim_spct

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

Create tagged spectrum from wavebands
wb_trim_as_default

Set computation options
setMultipleWl

Set the "multiple.wl" attribute
setNormalized

Set the "normalized" attribute
source_spct

Spectral-object constructor
spct_classes

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

Insert wavelength values into spectral data.
summary_spct_classes

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

Tag a spectrum
sun.daily.data

Daily solar spectral irradiance (simulated)
times-.generic_spct

Arithmetic Operators
white_led.raw_spct

White led bulb spectrum
valleys

Valleys or local minima
white_led.source_spct

White led bulb spectrum
verbose_as_default

Set error reporting options
upgrade_spectra

Upgrade one or more spectral objects
using_Tfr

Use photobiology options
w_length_range2rgb

Wavelength range to rgb color conversion
water_vp_sat

Water vapour pressure
w_length2rgb

Wavelength to rgb color conversion
white_body.spct

Theoretical white body
white_led.cps_spct

White led bulb spectrum
FEL_spectrum

Incandescent "FEL" lamp emission spectrum
D2.UV654

Data for typical calibration lamps
D2.UV586

Data for typical calibration lamps
D2.UV653

Data for typical calibration lamps
FEL.BN.9101.165

Data for typical calibration lamps
D2_spectrum

Calculate deuterium lamp output spectrum from fitted constants
D65.illuminant.spct

CIE D65 illuminant data
A2T

Convert absorbance into transmittance
Ler_leaf.spct

Green Arabidopsis leaf reflectance and transmittance.
A.illuminant.spct

CIE A illuminant data
T2T

Convert transmittance type.
T2A

Convert transmittance into absorbance.
absorbance

Absorbance
Trig

Trigonometric Functions
Ler_leaf_trns.spct

Green Arabidopsis leaf spectral transmittance.
Ler_leaf_trns_i.spct

Green Arabidopsis leaf spectral transmittance.
absorbance_spct

Calculate absorbance from spectral absorbance.
MathFun

Miscellaneous Mathematical Functions