Learn R Programming

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

photobiology (version 0.9.6)

'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

649

Version

0.9.6

License

GPL (>= 3)

Maintainer

Pedro Aphalo

Last Published

April 2nd, 2016

Functions in photobiology (0.9.6)

FEL_spectrum

Incandescent "FEL" lamp emission spectrum
as.generic_mspct

Collection-of-spectra copy-constructor
check_spct

Check validity of spectral objects
clear_body.spct

Theoretical clear body
ciexyzCC2.spct

CIE xyz chromaticity coordinates 2 deg data
black_body.spct

Theoretical black body
clean

Clean (=replace) off-range values in a spectrum
dim.generic_mspct

Dimensions of an Object
copy_attributes

Copy attributes
e2q

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

Extract or replace members of a collection of spectra
getScaled

Get the "scaled" attribute
e2qmol_multipliers

Calculate energy to quantum (mol) multipliers
is_normalized

Query whether a generic spectrum has been normalized.
getWhereMeasured

Get the "where.measured" attribute
is_effective

Is an R object "effective"
min

Wavelength minimum
log

Logarithms and Exponentials
print.summary_generic_spct

Print spectral summary
is_absorbance_based

Query if a spectrum contains absorbance or transmittance data
response

Integrated response
rbindspct

Row-bind spectra
s_e_irrad2rgb

Spectrum to rgb color conversion
setTimeUnit

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

Length of object in wavelength units
A.illuminant.spct

CIE A illuminant data
setInstrDesc

Set the "instr.desc" attribute
D2_spectrum

Calculate deuterim lamp output spectrum from fitted constants
setScaled

Set the "scaled" attribute
Trig

Trigonometric Functions
peaks

Peaks or local maxima
absorbance

Absorbance
checkTimeUnit

Check the "time.unit" attribute of an existing source_spct object
D65.illuminant.spct

CIE D65 illuminant data
cps2irrad

Conversion from counts per second to physical quantities
summary

Summary of a spectral object
absorptance

Absorptance
day_night

Times for sun positions
defunct

Defunct functions and methods
as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance
calc_source_output

Light-source spectral output
untag

Remove tags
div-.generic_spct

Arithmetic Operators
fscale

Rescale a spectrum using a summary function
is.old_spct

Query if an object has old class names
l_insert_hinges

Insert wavelength values into spectral data.
interpolate_wl

Map spectra to new wavelength values.
class_spct

Query which is the class of an spectrum
generic_mspct

Collection-of-spectra constructor
yellow_gel.spct

Transmittance spectrum of yellow theatrical gel.
time2seconds

time argument check and conversion
checkSpctVersion

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

Calculate (energy) irradiance from spectral irradiance
ciev2.spct

Linear energy CIE 2008 luminous efficiency function 2 deg data
is.summary_generic_spct

Query class of spectrum summary objects
A2T

Convert absorbance into transmittance
normalize_range_arg

Normalize a range argument into a true numeric range
prod_spectra

Multiply two spectra, even if the wavelengths values differ
getInstrSettings

Get the "instr.settings" attribute
getInstrDesc

Get the "instr.desc" attribute
convertTimeUnit

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

Photon fluence
qe_ratio

Photon:energy ratio
polyester.spct

Transmittance spectrum of clear polyester film
ccd.spct

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

Gives irradiance from spectral irradiance.
setNormalized

Set the "normalized" attribute
photons_energy_ratio

Photon:energy ratio
date2tod

Convert date to time-of-day in hours
getTimeUnit

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

Solar spectral irradiance (simulated)
setWhereMeasured

Set the "where.measured" attribute
ciexyzCMF2.spct

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

Clean a spectrum
checkMspctVersion

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

Clip head and/or tail of a spectrum
labels

Find labels from "waveband" object
reflectance

Reflectance
e_ratio

Energy:energy ratio
waveband_ratio

Photon or energy ratio
eq_ratio

Energy:photon ratio
irradiance

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

Insert wavelength values into spectral data.
get_peaks

Get peaks and valleys in a spectrum
^.generic_spct

Arithmetic Operators
split_photon_irradiance

Photon irradiance for split spectrum regions
setGenericSpct

Convert an R object into a spectrum object.
sign

Sign
subt_spectra

Subtract two spectra
ciexyzCC10.spct

CIE xyz chromaticity coordinates (CC) 10 deg data
is.waveband

Query if it is a waveband
energy_ratio

Energy:energy ratio
trim_spct

Trim (or expand) head and/or tail
q2e

Convert photon-based quantities into energy-based quantities
q_response

Photon-based photo-response
getSpctVersion

Get the "spct.version" attribute
spct_classes

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

Calculate energy to quantum multipliers
fscale_spct

fscale a spectrum
sun_angles

Solar angles
beesxyzCMF.spct

Honeybee xyz chromaticity colour matching function data
merge.generic_spct

Merge two generic_spct objects
stepsize

Stepsize
getWhenMeasured

Get the "when.measured" attribute
interpolate_spectrum

Calculate spectral values at a different set of wavelengths
check_w.length

Sanity check of wavelengths (internal function).
photobiology-package

'Photobiological' Calculations
MathFun

Miscellaneous Mathematical Functions
split2mspct

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

Set the "instr.settings" attribute
irrad

Irradiance
normalized_diff_ind

Calculate a normalized index.
rmDerivedMspct

Remove "generic_mspct" and derived class attributes.
range

Wavelength range
rgb_spct

RGB color values
plus-.generic_spct

Arithmetic Operators
calc_multipliers

Spectral weights
round

Rounding of Numbers
as.generic_spct

Spectral-object copy constructor
absorbance_spct

Calculate absorbance from spectral absorbance.
setBSWFUsed

Set the "bswf.used" attribute
setWhenMeasured

Set the "when.measured" attribute
c.generic_mspct

Combine collections of spectra
split_bands

List-of-wavebands constructor
split_irradiance

Energy or photon irradiance for split spectrum regions
e_fluence

Energy fluence
shared_member_class

Classes common to all collection members.
sun.daily.spct

Daily solar spectral irradiance (simulated)
summary_spct_classes

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

Daily solar spectral irradiance (simulated)
is_photon_based

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

Extract or replace parts of a spectrum
transmittance

Transmittance
waveband

Waveband constructor method
setTfrType

Set the "Tfr.type" attribute
trim_wl

Trim head and/or tail of a spectrum
convolve_each

Convolve function for collections of spectra
T2A

Convert transmittance into absorbance.
upgrade_spectra

Upgrade one or more spectral objects
altitude

function to be numerically minimized
v_insert_hinges

Insert wavelength values into spectral data.
normalize

Normalize spectral data
msmsply

Multi-spct transform methods
opaque.spct

Theoretical spectrum of an opaque material
valleys

Valleys or local minima
find_peaks

Find peaks in a spectrum
as_quantum

Convert spectral energy irradiance into spectral photon irradiance
q_ratio

Photon:photon ratio
e_irrad

Energy irradiance
as_energy

Convert spectral photon irradiance into spectral energy irradiance
sum_spectra

Add two spectra
wb2tagged_spct

Create tagged spectrum from wavebands
midpoint

Central wavelength value
getBSWFUsed

Get the "bswf.used" attribute
is.generic_spct

Query class of spectrum objects
getMultipleWl

Get the "multiple.wl" attribute
ciexyzCMF10.spct

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

Names of multi-spectra classes
transmittance_spct

Calculate transmittance from spectral transmittance.
integrate_spct

Integrate spectral data.
twilight2angle

twilight argument check and conversion
clear_photobio.cache

clear the spectral weights cache
oper_spectra

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

Spectral response of a GaAsP photodiode
normalization

Normalization of an R object
slash-.generic_spct

Arithmetic Operators
wb2spct

Create spectrum from wavebands
source_spct

Spectral-object constructor
color

Color of an object
f_dispatcher_spct

Math function dispatcher for spectra
setWhatMeasured

Set the "what.measured" attribute
white_body.spct

Theoretical white body
trim_tails

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

Linear energy CIE 2008 luminous efficiency function 10 deg data
getTfrType

Get the "Tfr.type" attribute
reflectance_spct

Calculate reflectance from spectral reflectance
is_tagged

Query if it is an spectrum is tagged
clear.spct

Theoretical spectrum of a clear clear material
photon_irradiance

Photon irradiance
mod-.generic_spct

Arithmetic Operators
print.waveband

Print a "waveband" object
resp_spct

Calculate response from spectral response
smooth_spct

Smooth a spectrum
split_energy_irradiance

Energy irradiance for split spectrum regions
setRfrType

Set the "Rfr.type" attribute
times-.generic_spct

Arithmetic Operators
w_length2rgb

Wavelength to rgb color conversion
upgrade_spct

Upgrade one spectral object
trim_waveband

Trim (or expand) head and/or tail
average_spct

Average spectral data.
date2seconds

date argument check and conversion
filter_cps.mspct

Counts per second from a measurement of a plastic film
fshift

Shift the scale of a spectrum using a summary function
getNormalized

Get the "normalized" attribute
getRfrType

Get the "Rfr.type" attribute
getWhatMeasured

Get the "what.measured" attribute
getMspctVersion

Get the "mspct.version" attribute
insert_spct_hinges

Insert new wavelength values into a spectrum
interpolate_spct

Map a spectrum to new wavelength values.
is_scaled

Query whether a generic spectrum has been scaled
max

Wavelength maximum
minus-.generic_spct

Arithmetic Operators
print

Print a spectral object
q_irrad

Photon irradiance
rmDerivedSpct

Remove "generic_spct" and derived class attributes.
w_length_range2rgb

Wavelength range to rgb color conversion
absorptance_spct

Calculate absorptance from spectral absorptance.
check_spectrum

Sanity check of a spectrum.
e_response

Energy-based photo-response
div_spectra

Divide two spectra, even if the wavelengths values differ
fluence

Fluence
fshift_spct

fshift a spectrum
is.generic_mspct

Query class of spectrum objects
photon_ratio

Photo:photon ratio
setMultipleWl

Set the "multiple.wl" attribute
subset2mspct

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

Solar spectral irradiance (simulated)
tag

Tag a spectrum
wb2rect_spct

Create tagged spectrum from wavebands