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.

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)
#>  E_Total 
#> 146.5044 
#> attr(,"time.unit")
#> [1] "second"
#> attr(,"radiation.unit")
#> [1] "total energy irradiance"

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] "2020-04-27 04:27:13 UTC"
day_length(date, tz = "UTC", geocode = geocode)
#> [1] 15.01167

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 three User Guides.

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-2020 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.10.4

License

GPL (>= 2)

Maintainer

Pedro Aphalo

Last Published

June 7th, 2020

Functions in photobiology (0.10.4)

as.calibration_spct

Coerce to a spectrum
as.chroma_mspct

Coerce to a collection-of-spectra
as.cps_mspct

Coerce to a collection-of-spectra
Ler_leaf_rflt.spct

Green Arabidopsis leaf spectral reflectance.
as.chroma_spct

Coerce to a spectrum
as.filter_spct

Coerce to a spectrum
as.generic_mspct

Coerce to a collection-of-spectra
as.solar_date

Convert a solar_time object into solar_date object
Ler_leaf.spct

Green Arabidopsis leaf reflectance and transmittance.
as.source_mspct

Coerce to a collection-of-spectra
as.response_mspct

Coerce to a collection-of-spectra
as.matrix-mspct

Coerce a collection of spectra into a matrix
absorptance

Absorptance
as.generic_spct

Coerce to a spectrum
Ler_leaf_trns_i.spct

Green Arabidopsis leaf spectral transmittance.
absorbance_spct

Calculate absorbance from spectral absorbance.
A2T

Convert absorbance into transmittance
as.response_spct

Coerce to a spectrum
Ler_leaf_trns.spct

Green Arabidopsis leaf spectral transmittance.
as.reflector_mspct

Coerce to a collection-of-spectra
add_attr2tb

Copy attributes from members of a generic_mspct
T2Afr

Convert transmittance into absorptance.
T2A

Convert transmittance into absorbance.
absorptance_spct

Calculate absorptance from spectral absorptance.
as.reflector_spct

Coerce to a spectrum
Trig

Trigonometric Functions
Rfr_from_n

Reflectance at a planar boundary
MathFun

Miscellaneous Mathematical Functions
average_spct

Average spectral data.
as_tod

Convert datetime to time-of-day
absorbance

Absorbance
beesxyzCMF.spct

Honeybee xyz chromaticity colour matching function data
check_w.length

Sanity check of wavelengths (internal function).
any2T

Convert filter quantities.
as.calibration_mspct

Coerce to a collection-of-spectra
ciexyzCMF2.spct

Linear energy CIE xyz colour matching function (CMF) 2 deg data
ciev10.spct

Linear energy CIE 2008 luminous efficiency function 10 deg data
auto_hinges

Guess whether insertion of hinges is needed or not
as.object_mspct

Coerce to a collection-of-spectra
as.raw_mspct

Coerce to a collection-of-spectra
calc_multipliers

Spectral weights
calc_source_output

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

Coerce to a collection-of-spectra
as.source_spct

Coerce to a spectrum
as.cps_spct

Coerce to a spectrum
as.raw_spct

Coerce to a spectrum
as.object_spct

Coerce to a spectrum
ccd.spct

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

Convert spectral photon irradiance into spectral energy irradiance
class_spct

Query which is the class of a spectrum
clip_wl

Clip head and/or tail of a spectrum
check_spectrum

Sanity check a spectrum
check_spct

Check validity of spectral objects
clear_photobio.cache

Clear the spectral weights cache
ciev2.spct

Linear energy CIE 2008 luminous efficiency function 2 deg data
ciexyzCC2.spct

CIE xyz chromaticity coordinates 2 deg data
checkMspctVersion

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

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

Theoretical spectrum of a clear material
cone_fundamentals10.spct

Ten-degree cone fundaamentals
ciexyzCC10.spct

CIE xyz chromaticity coordinates (CC) 10 deg data
clear_body.spct

Theoretical clear body
convertThickness

Convert the "thickness" attribute of an existing filter_spct object.
color_of

Color of an object
compare_spct

Coarse-grained comparison of two spectra
as_quantum

Convert spectral energy irradiance into spectral photon irradiance
as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance
black_body.spct

Theoretical black body
convertTimeUnit

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

Copy attributes
convolve_each

Convolve function for collections of spectra
e_irrad

Energy irradiance
c

Combine collections of spectra
e_ratio

Energy:energy ratio
defunct

Defunct functions and methods
e2q

Convert energy-based quantities into photon-based quantities.
Extract

Extract or replace parts of a spectrum
spread

Expanse
e2qmol_multipliers

Calculate energy to quantum (mol) multipliers
convertTfrType

Convert the "Tfr.type" attribute
e2quantum_multipliers

Calculate energy to quantum multipliers
despike

Remove spikes from spectrum
find_wls

Find wavelength values in a spectrum
checkSpctVersion

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

Energy-based photo-response
checkTimeUnit

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

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

Clean a spectrum
enable_check_spct

Enable or disable checks
find_peaks

Find peaks in a spectrum
cps2irrad

Conversion from counts per second to physical quantities
day_night

Times for sun positions
find_spikes

Find spikes
generic_mspct

Collection-of-spectra constructor
div-.generic_spct

Arithmetic Operators
getBSWFUsed

Get the "bswf.used" attribute
e_fluence

Energy fluence
fit_peaks

Refine position and value of extremes by fitting
getMultipleWl

Get the "multiple.wl" attribute
getNormalized

Get the "normalized" attribute
diffraction_single_slit

Diffraction
div_spectra

Divide two spectra, even if the wavelengths values differ
energy_ratio

Energy:energy ratio
fluence

Fluence
getWhereMeasured

Get the "where.measured" attribute
getWhenMeasured

Get the "when.measured" attribute
format.solar_time

Encode in a Common Format
get_attributes

Get the metadata attributes
getHowMeasured

Get the "how.measured" attribute
getFilterProperties

Get the "filter.properties" attribute
get_peaks

Get peaks and valleys in a spectrum
energy_irradiance

Calculate (energy) irradiance from spectral irradiance
energy_as_default

Set spectral-data options
dim.generic_mspct

Dimensions of an Object
interpolate_spct

Map a spectrum to new wavelength values.
eq_ratio

Energy:photon ratio
interpolate_spectrum

Calculate spectral values at a different set of wavelengths
is.generic_spct

Query class of spectrum objects
labels

Find labels from "waveband" object
log

Logarithms and Exponentials
getInstrSettings

Get the "instr.settings" attribute
getMspctVersion

Get the "mspct.version" attribute
is.old_spct

Query if an object has old class names
fshift_spct

fshift a spectrum
fshift

Shift the scale of a spectrum using a summary function
getSpctVersion

Get the "spct.version" attribute
Extract_mspct

Extract or replace members of a collection of spectra
oper_spectra

Binary operation on two spectra, even if the wavelengths values differ
getIdFactor

Get the "idfactor" attribute
findMultipleWl

Find repeated w.length values
filter_cps.mspct

Counts per second from a measurement of a plastic film
integrate_spct

Integrate spectral data.
is_tagged

Query if a spectrum is tagged
opaque.spct

Theoretical spectrum of an opaque material
getInstrDesc

Get the "instr.desc" attribute
join_mspct

Join all spectra in a collection
f_dispatcher_spct

Math function dispatcher for spectra
calendar_change

Solar astronomy using Meeus' algorithm
getTimeUnit

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

Insert wavelength values into spectral data.
getTfrType

Get the "Tfr.type" attribute
insert_hinges

Insert wavelength values into spectral data.
insert_spct_hinges

Insert new wavelength values into a spectrum
photon_irradiance

Photon irradiance
photodiode.spct

Spectral response of a GaAsP photodiode
plus-.generic_spct

Arithmetic Operators
getWhatMeasured

Get the "what.measured" attribute
reflectance_spct

Calculate reflectance from spectral reflectance
head_tail

Return the First and Last Part of an Object
green_leaf.spct

Green birch leaf reflectance.
integrate_xy

Gives irradiance from spectral irradiance.
format.tod_time

Encode in a Common Format
formatted_range

Compute range and format it
is.generic_mspct

Query class of spectrum objects
irradiance

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

Query if it is a waveband
isValidInstrDesc

Check the "instr.desc" attribute
is_effective

Is an R object "effective"
fscale

Rescale a spectrum using a summary function
q_response

Photon-based photo-response
polyester.spct

Transmittance spectrum of clear polyester film
wl_max

Wavelength maximum
merge2object_spct

Merge into object_spct
is.solar_time

Query class
prod_spectra

Multiply two spectra, even if the wavelengths values differ
is_normalized

Query whether a generic spectrum has been normalized.
q_ratio

Photon:photon ratio
mspct_classes

Names of multi-spectra classes
normalization

Normalization of an R object
q2e

Convert photon-based quantities into energy-based quantities
na.omit

Handle Missing Values in Objects
setTimeUnit

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

fscale a spectrum
relative_AM

Relative Air Mass (AM)
setBSWFUsed

Set the "bswf.used" attribute
s_prod

Product from collection of spectra
setNormalized

Set the "normalized" attribute
normalize

Normalize spectral data
^.generic_spct

Arithmetic Operators
qe_ratio

Photon:energy ratio
wl_range

Wavelength range
s_mean

Mean from collection of spectra
print

Print a spectral object
split2mspct

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

Set the "where.measured" attribute
s_sd

Standard Deviation of a collection of spectra
getRfrType

Get the "Rfr.type" attribute
reflectance

Reflectance
print.tod_time

Print time-of-day objects
print.waveband

Print a "waveband" object
s_e_irrad2rgb

Spectral irradiance to rgb color conversion
setFilterProperties

Set the "filter.properties" attribute
setWhatMeasured

Set the "what.measured" attribute
s_range

Range of a collection of spectra
setWhenMeasured

Set the "when.measured" attribute
rbindspct

Row-bind spectra
v_insert_hinges

Insert spectral data values at new wavelength values.
is.summary_generic_spct

Query class of spectrum summary objects
s_se

Standard Error of a collection of spectra
split_irradiance

Energy or photon irradiance for split spectrum regions
setInstrDesc

Set the "instr.desc" attribute
sun_angles

Solar angles
q_fluence

Photon fluence
getScaled

Get the "scaled" attribute
setHowMeasured

Set the "how.measured" attribute
setGenericSpct

Convert an R object into a spectrum object.
source_spct

Spectral-object constructor
setScaled

Set the "scaled" attribute
setRfrType

Set the "Rfr.type" attribute
trimInstrDesc

Trim the "instr.desc" attribute
trim_spct

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

Set the "Tfr.type" attribute
spct_attr2tb

Copy attributes into a tibble
isValidInstrSettings

Check the "instr.settings" attribute
split_bands

List-of-wavebands constructor
upgrade_spectra

Upgrade one or more spectral objects
q_irrad

Photon irradiance
interpolate_wl

Map spectra to new wavelength values.
irrad

Irradiance
is_photon_based

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

Query whether a generic spectrum has been scaled
round

Rounding of Numbers
smooth_spct

Smooth a spectrum
rowwise

rowwise functions for collections of spectra
is_absorbance_based

Query if a spectrum contains absorbance or transmittance data
water_vp_sat

Water vapour pressure
slash-.generic_spct

Arithmetic Operators
wl_min

Wavelength minimum
white_body.spct

Theoretical white body
v_replace_hinges

Overwrite spectral data values at existing wavelength values.
summary_spct_classes

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

Summary of a spectral object
setIdFactor

Set the "idfactor" attribute
twilight2angle

twilight argument check and conversion
split_photon_irradiance

Photon irradiance for split spectrum regions
wl_stepsize

Stepsize
transmittance

Transmittance
sinc

sinc
merge_attributes

Merge and copy attributes
solar_time

Local solar time
w_length_range2rgb

Wavelength range to rgb color conversion
split_energy_irradiance

Energy irradiance for split spectrum regions
minus-.generic_spct

Arithmetic Operators
waveband

Waveband constructor method
sun.data

Solar spectral irradiance (simulated)
wl_midpoint

Midpoint
upgrade_spct

Upgrade one spectral object
tag

Tag a spectrum
trim_tails

Trim (or expand) head and/or tail
trimInstrSettings

Trim the "instr.settings" attribute
using_Tfr

Use photobiology options
sun.spct

Solar spectral irradiance (simulated)
trim_wl

Trim head and/or tail of a spectrum
mod-.generic_spct

Arithmetic Operators
wb_trim_as_default

Set computation options
msmsply

Multi-spct transform methods
transmittance_spct

Calculate transmittance from spectral transmittance.
validate_geocode

Validate a geocode
peaks

Peaks or local maxima
normalized_diff_ind

Calculate a normalized index.
photobiology-package

photobiology: Photobiological Calculations
w_length2rgb

Wavelength to rgb color conversion
trim_waveband

Trim (or expand) head and/or tail
wls_at_target

Find wavelengths values corresponding to a target spectral value
valleys

Valleys or local minima
verbose_as_default

Set error reporting options
normalize_range_arg

Normalize a range argument into a true numeric range
tz_time_diff

Time difference between two time zones
yellow_gel.spct

Transmittance spectrum of yellow theatrical gel.
print.solar_time

Print solar time and solar date objects
replace_bad_pixs

Replace bad pixels in a spectrum
print.summary_generic_spct

Print spectral summary
resp_spct

Calculate response from spectral response
s_median

Median of a collection of spectra
s_mean_se

Mean and standard error from collection of spectra
s_sum

Sum from collection of spectra
setMultipleWl

Set the "multiple.wl" attribute
sun.daily.data

Daily solar spectral irradiance (simulated)
photon_ratio

Photo:photon ratio
subt_spectra

Subtract two spectra
response

Integrated response
photons_energy_ratio

Photon:energy ratio
rmDerivedMspct

Remove "generic_mspct" and derived class attributes.
white_led.raw_spct

White led bulb spectrum
s_var

Variance of a collection of spectra
sign

Sign
rgb_spct

RGB color values
shared_member_class

Classes common to all collection members.
rmDerivedSpct

Remove "generic_spct" and derived class attributes.
subset2mspct

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

Set the "instr.settings" attribute
sun.daily.spct

Daily solar spectral irradiance (simulated)
Subset

Subsetting spectra
se

Standard error of the mean
select_spct_attributes

Merge user supplied attribute names with default ones
spikes

Spikes
spct_classes

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

Precomputed rgb colors
thin_wl

Thin the density of wavelength values
white_led.source_spct

White led bulb spectrum
wb2spct

Create spectrum from wavebands
uncollect

Extract all members from a collection
times-.generic_spct

Arithmetic Operators
waveband_ratio

Photon or energy ratio
wb2rect_spct

Create tagged spectrum from wavebands
untag

Remove tags
sum_spectra

Add two spectra
white_led.cps_spct

White led bulb spectrum
wb2tagged_spct

Create tagged spectrum from wavebands
D65.illuminant.spct

CIE D65 illuminant data
D2_spectrum

Calculate deuterium lamp output spectrum from fitted constants
FEL_spectrum

Incandescent "FEL" lamp emission spectrum
Afr2T

Convert transmittance into absorptance.
A.illuminant.spct

CIE A illuminant data
D2.UV654

Data for typical calibration lamps
FEL.BN.9101.165

Data for typical calibration lamps
D2.UV653

Data for typical calibration lamps
D2.UV586

Data for typical calibration lamps