Learn R Programming

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

photobiology (version 0.9.5)

Photobiological Calculations

Description

Definitions of classes, methods, operators and functions for use in photobiology and radiation meteorology and climatology. Calculation of effective (weighted) and not-weighted irradiances/doses, fluence rates, transmittance, reflectance, absorptance, absorbance and diverse ratios and other derived quantities from spectral data. Local maxima and minima. Conversion between energy- and photon-based units. Wavelength interpolation. Astronomical calculations related solar angles and day length. Colours and vision.

Copy Link

Version

Install

install.packages('photobiology')

Monthly Downloads

1,001

Version

0.9.5

License

GPL (>= 3)

Maintainer

Pedro Aphalo

Last Published

February 3rd, 2016

Functions in photobiology (0.9.5)

calc_source_output

Light-source spectral output
e_ratio.source_mspct

Energy:energy ratio
convertTimeUnit

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

Calculate energy to quantum (mol) multipliers
fshift_spct

fshift a spectrum
q_ratio.source_mspct

Photon:photon ratio
energy_ratio

Energy:energy ratio
midpoint.generic_mspct

Central wavelength value
ciev2.spct

Linear energy CIE 2008 luminous efficiency function 2 deg data
range.generic_mspct

Range of wavelength
A.illuminant.spct

CIE A illuminant data
rgb_spct

RGB color values
generic_mspct

Collection-of-spectra constructor
getInstrSettings

Get the "instr.settings" attribute
photons_energy_ratio

Photon:energy ratio
getTimeUnit

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

Transmittance
getWhereMeasured.generic_mspct

Get the "where.measured" attribute
split2mspct

Convert a 'wide' or untidy data frame into a collection of spectra
absorptance.filter_mspct

Absorptance
check_w.length

Sanity check of wavelengths (internal function).
class_spct

Query which is the class of an spectrum
setBSWFUsed

Set the "bswf.used" attribute
sum_spectra

Add two spectra
getSpctVersion

Get the "spct.version" attribute
as.generic_mspct

Collection-of-spectra copy-constructor
setScaled

Set the "scaled" attribute
as.generic_spct

Spectral-object copy constructor
clean

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

Create tagged spectrum from wavebands
clear_body.spct

Theoretical clear body
color.source_mspct

Color
eq_ratio.source_mspct

Energy:photon ratio
absorptance_spct

Calculate absorptance from spectral absorptance.
is_normalized

Query whether a generic spectrum has been normalized.
setGenericSpct

Convert an R object into a spectrum object.
min.waveband

Wavelength minimum
defunct

Defunct functions and methods
average_spct

Average spectral data.
is.summary_generic_spct

Query class of spectrum summary objects
q_fluence.source_mspct

Photon fluence
valleys

Valleys or local minima
photobiology-package

Photobiological Calculations
max.generic_mspct

Maximun wavelength
photon_irradiance

Photon irradiance
getInstrDesc

Get the "instr.desc" attribute
clear_photobio.cache

clear the spectral weights cache
is_effective.summary_generic_spct

Is an R object "effective"
getScaled

Get the "scaled" attribute
absorbance_spct

Calculate absorbance from spectral absorbance.
is_scaled

Query whether a generic spectrum has been scaled
div_spectra

Divide two spectra, even if the wavelengths values differ
black_body.spct

Theoretical black body
mod-.generic_spct

Arithmetic Operators
q_response.response_mspct

Photon-based photo-response
checkTimeUnit

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

Logarithms and Exponentials
e_response.response_mspct

Energy-based photo-response
sun.data

Solar spectral irradiance (simulated)
e2quantum_multipliers

Calculate energy to quantum multipliers
round

Rounding of Numbers
absorbance.filter_mspct

Absorbance
reflectance.reflector_mspct

Reflectance
split_energy_irradiance

Energy irradiance for split spectrum regions
integrate_xy

Gives irradiance from spectral irradiance.
fluence.source_mspct

Fluence
irradiance

Photon (quantum) irradiance from spectral (energy) irradiance.
ciexyzCC10.spct

CIE xyz chromaticity coordinates (CC) 10 deg data
fscale_spct

fscale a spectrum
setRfrType

Set the "Rfr.type" attribute
get_peaks

Get peaks and valleys in a spectrum
is.old_spct

Query if an object has old class names
plus-.generic_spct

Arithmetic Operators
integrate_spct

Integrate spectral data.
getMspctVersion

Get the "mspct.version" attribute
Trig

Trigonometric Functions
c.generic_mspct

Combine collections of spectra
labels.generic_spct

Find labels from spectral object
interpolate_spectrum

Calculate spectral values at a different set of wavelengths
rmDerivedMspct

Remove "generic_mspct" and derived class attributes.
print.waveband

Print a "waveband" object
qe_ratio.source_mspct

Photon:energy ratio
ciexyzCC2.spct

CIE xyz chromaticity coordinates 2 deg data
ciexyzCMF2.spct

Linear energy CIE xyz colour matching function (CMF) 2 deg data
^.generic_spct

Arithmetic Operators
checkSpctVersion

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

Set the "multiple.wl" attribute
sign

Sign
ciexyzCMF10.spct

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

Theoretical spectrum of a clear clear material
sun.daily.spct

Daily solar spectral irradiance (simulated)
convolve_each

Convolve function for collections of spectra
tag

Tag a spectrum
setWhereMeasured.generic_mspct

Set the "where.measured" attribute
is_tagged

Query if it is an spectrum is tagged
as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance
merge.generic_spct

Merge two generic_spct objects
setInstrDesc

Set the "instr.desc" attribute
rmDerivedSpct

Remove "generic_spct" and derived class attributes.
minus-.generic_spct

Arithmetic Operators
response.response_mspct

Integrated response
e2q

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

Insert new wavelength values into a spectrum
oper_spectra

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

Photo:photon ratio
A2T

Convert absorbance into transmittance
split_irradiance

Energy or photon irradiance for split spectrum regions
e_irrad.source_mspct

Energy irradiance
T2A

Convert transmittance into absorbance.
source_spct

Spectral-object constructor
is_absorbance_based

Query if a spectrum contains absorbance or transmittance data
untag

Remove tags
print.generic_spct

Print a spectral object
altitude

function to be numerically minimized
w_length2rgb

Wavelength to rgb color conversion
white_body.spct

Theoretical white body
upgrade_spct

Upgrade one spectral object
split_photon_irradiance

Photon irradiance for split spectrum regions
shared_member_class

Classes common to all collection members.
energy_irradiance

Calculate (energy) irradiance from spectral irradiance
sun.spct

Solar spectral irradiance (simulated)
e_fluence.source_mspct

Energy fluence
as_quantum

Convert spectral energy irradiance into spectral photon irradiance
time2seconds

time argument check and conversion
summary.generic_spct

Summary of a spectral object
calc_multipliers

Spectral weights
range.waveband

Wavelength range
trim_tails

Trim (or expand) head and/or tail
subset2mspct

Convert 'long' or tidy spectral data into a collection of spectra
irrad.source_mspct

Irradiance
peaks

Peaks or local maxima
w_length_range2rgb

Wavelength range to rgb color conversion
reflectance_spct

Calculate reflectance from spectral reflectance
fshift

Shift the scale of a spectrum using a summary function
min.generic_mspct

Minimum wavelength
setInstrSettings

Set the "instr.settings" attribute
div-.generic_spct

Arithmetic Operators
date2tod

Convert date to time-of-day in hours
normalize

Normalize spectral data
normalization

Normalization of an R object
day_night

Times for sun positions
twilight2angle

twilight argument check and conversion
Extract_mspct

Extract or replace members of a collection of spectra
prod_spectra

Multiply two spectra, even if the wavelengths values differ
date2seconds

date argument check and conversion
getMultipleWl

Get the "multiple.wl" attribute
stepsize.generic_mspct

Stepsize
sun_angles

Solar angles
is.waveband

Query if it is a waveband
yellow_gel.spct

Transmittance spectrum of yellow theatrical gel.
photodiode.spct

Spectral response of a GaAsP photodiode
waveband

Waveband constructor method
wb2spct

Create spectrum from wavebands
setWhenMeasured.generic_mspct

Set the "when.measured" attribute
dim.generic_mspct

Dimensions of an Object
getBSWFUsed

Get the "bswf.used" attribute
getNormalized

Get the "normalized" attribute
sun.daily.data

Daily solar spectral irradiance (simulated)
getWhenMeasured.generic_mspct

Get the "when.measured" attribute
slash-.generic_spct

Arithmetic Operators
trim_wl

Trim head and/or tail of a spectrum
max.waveband

Wavelength maximum
mspct_classes

Names of multi-spectra classes
msmsply

Multi-spct transform methods
trim_waveband

Trim (or expand) head and/or tail
waveband_ratio

Photon or energy ratio
subt_spectra

Subtract two spectra
getTfrType

Get the "Tfr.type" attribute
setTimeUnit

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

Convert photon-based quantities into energy-based quantities
q_irrad.source_mspct

Photon irradiance
spread.generic_mspct

Length of object in wavelength units
s_e_irrad2rgb

Spectrum to rgb color conversion
D2_spectrum

Calculate deuterim lamp output spectrum from fitted constants
trim_spct

Trim (or expand) head and/or tail
resp_spct

Calculate response from spectral response
upgrade_spectra

Upgrade one or more spectral objects
summary_spct_classes

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

Row-bind spectra
insert_hinges

Insert wavelength values into spectral data.
spct_classes

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

Smooth a spectrum
normalized_diff_ind

Calculate a normalized index.
times-.generic_spct

Arithmetic Operators
clip_wl

Clip head and/or tail of a spectrum
D65.illuminant.spct

CIE D65 illuminant data
beesxyzCMF.spct

Honeybee xyz chromaticity colour matching function data
FEL_spectrum

Incandescent "FEL" lamp emission spectrum
ccd.spct

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

Sanity check of a spectrum.
ciev10.spct

Linear energy CIE 2008 luminous efficiency function 10 deg data
Extract

Extract or replace parts of a spectrum
is.generic_spct

Query class of spectrum objects
interpolate_wl

Map spectra to new wavelength values.
labels.waveband

Find labels from "waveband" object
opaque.spct

Theoretical spectrum of an opaque material
normalize_range_arg

Normalize a range argument into a true numeric range
getRfrType

Get the "Rfr.type" attribute
print.summary_generic_spct

Print spectral summary
is_photon_based

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

Miscellaneous Mathematical Functions
checkMspctVersion

Check that the "mspct.version" attribute is set
check_spct

Check validity of spectral objects
color

Color of an object
fscale

Rescale a spectrum using a summary function
f_dispatcher_spct

Math function dispatcher for spectra
find_peaks

Find peaks in a spectrum
as_energy

Convert spectral photon irradiance into spectral energy irradiance
is.generic_mspct

Query class of spectrum objects
print.generic_mspct

Print a spectral collection object
setNormalized

Set the "normalized" attribute
transmittance_spct

Calculate transmittance from spectral transmittance.
setTfrType

Set the "Tfr.type" attribute
wb2tagged_spct

Create tagged spectrum from wavebands
split_bands

List-of-wavebands constructor
polyester.spct

Transmittance spectrum of clear polyester film
interpolate_spct

Map a spectrum to new wavelength values.