Learn R Programming

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

photobiology (version 0.9.7)

'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.7

License

GPL (>= 3)

Maintainer

Pedro Aphalo

Last Published

April 6th, 2016

Functions in photobiology (0.9.7)

MathFun

Miscellaneous Mathematical Functions
color

Color of an object
clean

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

Defunct functions and methods
e_irrad

Energy irradiance
f_dispatcher_spct

Math function dispatcher for spectra
dim.generic_mspct

Dimensions of an Object
irrad

Irradiance
check_spct

Check validity of spectral objects
log

Logarithms and Exponentials
fshift

Shift the scale of a spectrum using a summary function
integrate_spct

Integrate spectral data.
l_insert_hinges

Insert wavelength values into spectral data.
merge.generic_spct

Merge two generic_spct objects
photons_energy_ratio

Photon:energy ratio
plus-.generic_spct

Arithmetic Operators
mod-.generic_spct

Arithmetic Operators
print.waveband

Print a "waveband" object
setRfrType

Set the "Rfr.type" attribute
rbindspct

Row-bind spectra
photon_ratio

Photo:photon ratio
setWhatMeasured

Set the "what.measured" attribute
source_spct

Spectral-object constructor
D2_spectrum

Calculate deuterim lamp output spectrum from fitted constants
q_ratio

Photon:photon ratio
transmittance_spct

Calculate transmittance from spectral transmittance.
D65.illuminant.spct

CIE D65 illuminant data
FEL_spectrum

Incandescent "FEL" lamp emission spectrum
sun.daily.data

Daily solar spectral irradiance (simulated)
as.generic_mspct

Collection-of-spectra copy-constructor
filter_cps.mspct

Counts per second from a measurement of a plastic film
checkTimeUnit

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

Convert absorbance into transmittance
A.illuminant.spct

CIE A illuminant data
clean_spct

Clean a spectrum
ciexyzCMF10.spct

Linear energy CIE xyz colour matching function (CMF) 10 deg data
getMultipleWl

Get the "multiple.wl" attribute
trim_wl

Trim head and/or tail of a spectrum
is_absorbance_based

Query if a spectrum contains absorbance or transmittance data
interpolate_wl

Map spectra to new wavelength values.
convertTimeUnit

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

clear the spectral weights cache
as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance
copy_attributes

Copy attributes
cps2irrad

Conversion from counts per second to physical quantities
ccd.spct

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

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

Honeybee xyz chromaticity colour matching function data
is_photon_based

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

Theoretical spectrum of a clear clear material
msmsply

Multi-spct transform methods
Extract_mspct

Extract or replace members of a collection of spectra
normalize

Normalize spectral data
getNormalized

Get the "normalized" attribute
generic_mspct

Collection-of-spectra constructor
find_peaks

Find peaks in a spectrum
as.generic_spct

Spectral-object copy constructor
e2quantum_multipliers

Calculate energy to quantum multipliers
getTimeUnit

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

Get the "scaled" attribute
c.generic_mspct

Combine collections of spectra
tag

Tag a spectrum
setInstrSettings

Set the "instr.settings" attribute
getWhatMeasured

Get the "what.measured" attribute
getRfrType

Get the "Rfr.type" attribute
Extract

Extract or replace parts of a spectrum
photodiode.spct

Spectral response of a GaAsP photodiode
T2A

Convert transmittance into absorbance.
checkMspctVersion

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

Convert spectral energy irradiance into spectral photon irradiance
q2e

Convert photon-based quantities into energy-based quantities
fscale

Rescale a spectrum using a summary function
e2q

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

Remove "generic_spct" and derived class attributes.
ciev2.spct

Linear energy CIE 2008 luminous efficiency function 2 deg data
fscale_spct

fscale a spectrum
spct_classes

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

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

Get the "Tfr.type" attribute
wb2tagged_spct

Create tagged spectrum from wavebands
split_energy_irradiance

Energy irradiance for split spectrum regions
get_peaks

Get peaks and valleys in a spectrum
altitude

function to be numerically minimized
interpolate_spectrum

Calculate spectral values at a different set of wavelengths
mspct_classes

Names of multi-spectra classes
normalization

Normalization of an R object
split_bands

List-of-wavebands constructor
subset2mspct

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

Calculate absorptance from spectral absorptance.
midpoint

Central wavelength value
calc_multipliers

Spectral weights
ciev10.spct

Linear energy CIE 2008 luminous efficiency function 10 deg data
print.summary_generic_spct

Print spectral summary
sum_spectra

Add two spectra
q_response

Photon-based photo-response
prod_spectra

Multiply two spectra, even if the wavelengths values differ
setTfrType

Set the "Tfr.type" attribute
sign

Sign
e_ratio

Energy:energy ratio
eq_ratio

Energy:photon ratio
stepsize

Stepsize
div-.generic_spct

Arithmetic Operators
clear_body.spct

Theoretical clear body
energy_ratio

Energy:energy ratio
setInstrDesc

Set the "instr.desc" attribute
trim_tails

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

Solar spectral irradiance (simulated)
opaque.spct

Theoretical spectrum of an opaque material
date2seconds

date argument check and conversion
time2seconds

time argument check and conversion
fluence

Fluence
smooth_spct

Smooth a spectrum
minus-.generic_spct

Arithmetic Operators
class_spct

Query which is the class of an spectrum
subt_spectra

Subtract two spectra
photon_irradiance

Photon irradiance
qe_ratio

Photon:energy ratio
getInstrDesc

Get the "instr.desc" attribute
day_night

Times for sun positions
setMultipleWl

Set the "multiple.wl" attribute
e2qmol_multipliers

Calculate energy to quantum (mol) multipliers
getMspctVersion

Get the "mspct.version" attribute
print

Print a spectral object
rgb_spct

RGB color values
transmittance

Transmittance
oper_spectra

Binary operation on two spectra, even if the wavelengths values differ
^.generic_spct

Arithmetic Operators
waveband_ratio

Photon or energy ratio
getWhereMeasured

Get the "where.measured" attribute
absorbance

Absorbance
min

Wavelength minimum
wb2rect_spct

Create tagged spectrum from wavebands
integrate_xy

Gives irradiance from spectral irradiance.
insert_hinges

Insert wavelength values into spectral data.
is.generic_mspct

Query class of spectrum objects
is.waveband

Query if it is a waveband
polyester.spct

Transmittance spectrum of clear polyester film
setGenericSpct

Convert an R object into a spectrum object.
slash-.generic_spct

Arithmetic Operators
trim_waveband

Trim (or expand) head and/or tail
max

Wavelength maximum
w_length2rgb

Wavelength to rgb color conversion
black_body.spct

Theoretical black body
w_length_range2rgb

Wavelength range to rgb color conversion
rmDerivedMspct

Remove "generic_mspct" and derived class attributes.
range

Wavelength range
labels

Find labels from "waveband" object
summary

Summary of a spectral object
absorptance

Absorptance
sun_angles

Solar angles
sun.data

Solar spectral irradiance (simulated)
setBSWFUsed

Set the "bswf.used" attribute
q_fluence

Photon fluence
is_tagged

Query if it is an spectrum is tagged
absorbance_spct

Calculate absorbance from spectral absorbance.
check_spectrum

Sanity check of a spectrum.
check_w.length

Sanity check of wavelengths (internal function).
round

Rounding of Numbers
reflectance_spct

Calculate reflectance from spectral reflectance
convolve_each

Convolve function for collections of spectra
upgrade_spectra

Upgrade one or more spectral objects
setNormalized

Set the "normalized" attribute
setTimeUnit

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

Calculate response from spectral response
setScaled

Set the "scaled" attribute
setWhereMeasured

Set the "where.measured" attribute
date2tod

Convert date to time-of-day in hours
split_irradiance

Energy or photon irradiance for split spectrum regions
setWhenMeasured

Set the "when.measured" attribute
div_spectra

Divide two spectra, even if the wavelengths values differ
wb2spct

Create spectrum from wavebands
e_fluence

Energy fluence
shared_member_class

Classes common to all collection members.
twilight2angle

twilight argument check and conversion
e_response

Energy-based photo-response
energy_irradiance

Calculate (energy) irradiance from spectral irradiance
fshift_spct

fshift a spectrum
valleys

Valleys or local minima
is.generic_spct

Query class of spectrum objects
waveband

Waveband constructor method
is.summary_generic_spct

Query class of spectrum summary objects
yellow_gel.spct

Transmittance spectrum of yellow theatrical gel.
is_scaled

Query whether a generic spectrum has been scaled
q_irrad

Photon irradiance
sun.daily.spct

Daily solar spectral irradiance (simulated)
reflectance

Reflectance
untag

Remove tags
as_energy

Convert spectral photon irradiance into spectral energy irradiance
average_spct

Average spectral data.
ciexyzCMF2.spct

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

Light-source spectral output
getBSWFUsed

Get the "bswf.used" attribute
insert_spct_hinges

Insert new wavelength values into a spectrum
is.old_spct

Query if an object has old class names
getSpctVersion

Get the "spct.version" attribute
peaks

Peaks or local maxima
normalized_diff_ind

Calculate a normalized index.
normalize_range_arg

Normalize a range argument into a true numeric range
response

Integrated response
v_insert_hinges

Insert wavelength values into spectral data.
white_body.spct

Theoretical white body
Trig

Trigonometric Functions
ciexyzCC10.spct

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

CIE xyz chromaticity coordinates 2 deg data
getInstrSettings

Get the "instr.settings" attribute
interpolate_spct

Map a spectrum to new wavelength values.
getWhenMeasured

Get the "when.measured" attribute
irradiance

Photon (quantum) irradiance from spectral (energy) irradiance.
clip_wl

Clip head and/or tail of a spectrum
is_effective

Is an R object "effective"
is_normalized

Query whether a generic spectrum has been normalized.
photobiology-package

'Photobiological' Calculations
s_e_irrad2rgb

Spectrum to rgb color conversion
spread

Length of object in wavelength units
summary_spct_classes

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

Arithmetic Operators
upgrade_spct

Upgrade one spectral object
trim_spct

Trim (or expand) head and/or tail
split_photon_irradiance

Photon irradiance for split spectrum regions