photobiology0.11.3 package

Photobiological Calculations

normalization

Normalization of an R object

photobiology-package

photobiology: Photobiological Calculations

beesxyzCMF.spct

Honeybee xyz chromaticity colour matching function data

fscale

Rescale a spectrum using a summary function

fshift_spct

fshift a spectrum

fshift

Shift the scale of a spectrum using a summary function

generic_mspct

Collection-of-spectra constructor

get_attributes

Get the metadata attributes

get_peaks

Get peaks and valleys in a spectrum

getFilterProperties

Get the "filter.properties" attribute

dim.generic_mspct

Dimensions of an Object

div_spectra

Divide two spectra, even if the wavelengths values differ

div-.generic_spct

Arithmetic Operators

drop_user_cols

Drop user columns

e_fluence

Energy fluence

e_fraction

Energy:energy fraction

e_irrad

Energy irradiance

e_ratio

Energy:energy ratio

e_response

Energy-based photo-response

e2q

Convert energy-based quantities into photon-based quantities.

e2qmol_multipliers

Calculate energy to quantum (mol) multipliers

getScaled

Get the "scaled" attribute

is.old_spct

Query if an object has old class names

is.solar_time

Query class

is.summary_generic_spct

Query class of spectrum summary objects

is.waveband

Query if it is a waveband

isValidInstrDesc

Check the "instr.desc" attribute

isValidInstrSettings

Check the "instr.settings" attribute

join_mspct

Join all spectra in a collection

make_var_labels

Column or variable labels

is_tagged

Query if a spectrum is tagged

c

Combine collections of spectra

checkTimeUnit

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

class_spct

Query which is the class of a spectrum

clean_spct

Clean a spectrum

clean

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

any2T

Convert filter quantities.

A2T

Convert absorbance into transmittance

absorbance_spct

Calculate absorbance from spectral absorbance.

absorbance

Absorbance

absorptance_spct

Calculate absorptance from spectral absorptance.

absorptance

Absorptance

adaptive_smoothing

Custom smoothing

add_attr2tb

Copy attributes from members of a generic_mspct

Afr2T

Convert transmittance into absorptance.

as_energy

Convert spectral photon irradiance into spectral energy irradiance

as_quantum_mol

Convert spectral energy irradiance into spectral photon irradiance

as_quantum

Convert spectral energy irradiance into spectral photon irradiance

as_tod

Convert datetime to time-of-day

as.calibration_mspct

Coerce to a collection-of-spectra

as.calibration_spct

Coerce to a spectrum

clear_photobio.cache

Clear the spectral weights cache

as.chroma_mspct

Coerce to a collection-of-spectra

as.chroma_spct

Coerce to a spectrum

as.cps_mspct

Coerce to a collection-of-spectra

as.cps_spct

Coerce to a spectrum

as.filter_mspct

Coerce to a collection-of-spectra

as.filter_spct

Coerce or convert into a filter spectrum

as.generic_mspct

Coerce to a collection-of-spectra

as.generic_spct

Coerce to a spectrum

as.matrix-mspct

Coerce a collection of spectra into a matrix

as.object_mspct

Coerce to a collection-of-spectra

as.object_spct

Coerce to a spectrum

as.solar_date

Convert a solar_time object into solar_date object

as.raw_mspct

Coerce to a collection-of-spectra

as.raw_spct

Coerce to a spectrum

as.reflector_mspct

Coerce to a collection-of-spectra

as.reflector_spct

Coerce to a spectrum

as.response_mspct

Coerce to a collection-of-spectra

as.response_spct

Coerce to a spectrum

as.solute_mspct

Coerce to a collection-of-spectra

as.solute_spct

Coerce to a solute spectrum

as.source_mspct

Coerce to a collection-of-spectra

as.source_spct

Coerce to a spectrum

auto_hinges

Guess whether insertion of hinges is needed or not

average_spct

Average spectral data.

calc_multipliers

Spectral weights

calc_source_output

Scaled and/or interpolated light-source spectral output

check_and_rename_vars

check and rename variables

check_spct

Check validity of spectral objects

check_spectrum

Sanity check a spectrum

check_w.length

Sanity check of wavelengths (internal function).

checkMspctVersion

Check that the "mspct.version" attribute is set

checkSpctVersion

Check that the "spct.version" attribute is set

clear.spct

Theoretical spectrum of clear and apaque materials

clip_wl

Clip head and/or tail of a spectrum

collect2mspct

Form a new collection

color_of

Color of an object

compare_spct

Coarse-grained comparison of two spectra

convertTfrType

Convert the "Tfr.type" attribute

convertThickness

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

convertTimeUnit

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

convolve_each

Convolve function for collections of spectra

copy_attributes

Copy attributes

cps2irrad

Conversion from counts per second to physical quantities

D2_spectrum

Calculate deuterium lamp output spectrum from fitted constants

D2.UV653

Data for typical calibration lamps

day_night

Times for sun positions

defunct

Defunct functions and methods

despike

Remove spikes from spectrum

diffraction_single_slit

Diffraction

e2quantum_multipliers

Calculate energy to quantum multipliers

enable_check_spct

Enable or disable checks

energy_as_default

Set spectral-data options

energy_irradiance

Calculate (energy) irradiance from spectral irradiance

energy_ratio

Energy:energy ratio

eq_ratio

Energy:photon ratio

ET_ref

Evapotranspiration

expanse

Expanse

extract_mspct

Extract or replace members of a collection of spectra

extract

Extract or replace parts of a spectrum

f_dispatcher_spct

Math function dispatcher for spectra

FEL_spectrum

Incandescent "FEL" lamp emission spectrum

filter_cps.mspct

Counts per second from a measurement of a plastic film

fscale_spct

fscale a spectrum

find_peaks

Find peaks in a spectrum

find_spikes

Find spikes

find_wls

Find wavelength values in a spectrum

findMultipleWl

Find repeated w.length values

fit_peaks

Refine position and value of extremes by fitting

fluence

Fluence

format.solar_time

Encode in a Common Format

format.tod_time

Encode in a Common Format

formatted_range

Compute range and format it

getHowMeasured

Get the "how.measured" attribute

getIdFactor

Get the "idfactor" attribute

getInstrDesc

Get the "instr.desc" attribute

getInstrSettings

Get the "instr.settings" attribute

getKType

Get the "K.type" attribute

getMspctVersion

Get the "mspct.version" attribute

getMultipleWl

Get the "multiple.wl" attribute

getNormalized

Query the "normalized" and "normalization" attributes

getSoluteProperties

Get the "solute.properties" attribute

getSpctVersion

Get the "spct.version" attribute

getTimeUnit

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

getWhatMeasured

Get the "what.measured" attribute

getWhenMeasured

Get the "when.measured" attribute

getWhereMeasured

Get the "where.measured" attribute

is.generic_mspct

Query class of spectrum objects

head_tail

Return the First and Last Parts of an Object

illuminance

Irradiance

insert_hinges

Insert wavelength values into spectral data.

insert_spct_hinges

Insert new wavelength values into a spectrum

integrate_spct

Integrate spectral data.

integrate_xy

Gives irradiance from spectral irradiance.

interpolate_spct

Map a spectrum to new wavelength values.

interpolate_spectrum

Calculate spectral values at a different set of wavelengths

interpolate_wl

Map spectra to new wavelength values.

irrad_extraterrestrial

Extraterrestrial irradiance

irrad

Irradiance

irradiance

Photon or energy irradiance from spectral energy or photon irradiance.

is.generic_spct

Query class of spectrum objects

is_absorbance_based

Query if a spectrum contains absorbance or transmittance data

is_effective

Is an R object "effective"

is_mole_based

Query if a spectrum contains mole or mass based data

is_normalized

Query whether a generic spectrum has been normalized.

is_photon_based

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

is_scaled

Query whether a generic spectrum has been scaled

julian_day

Solar astronomy using Meeus' algorithm

l_insert_hinges

Insert wavelength values into spectral data.

labels

Find labels from "waveband" object

Ler_leaf.spct

Green Arabidopsis leaf reflectance and transmittance.

log

Logarithms and Exponentials

make_wl_consistent

Make wavelengths consistent

MathFun

Miscellaneous Mathematical Functions

max

Wavelength maximum

merge_attributes

Merge and copy attributes

merge2object_spct

Merge into object_spct

midpoint

Midpoint

min

Wavelength minimum

minus-.generic_spct

Arithmetic Operators

mod-.generic_spct

Arithmetic Operators

msmsply

Multi-spct transform methods

mspct_classes

Names of multi-spectra classes

na.omit

Handle Missing Values in Objects

net_irradiance

Net radiation flux

normalize_range_arg

Normalize a range argument into a true numeric range

normalize

Normalize spectral data

normalized_diff_ind

Calculate a normalized difference.

oper_spectra

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

peaks

Peaks or local maxima

phenylalanine.spct

Molar spectral attenuation coefficient of phenylalanine

photon_irradiance

Photon irradiance

photon_ratio

Photo:photon ratio

photons_energy_ratio

Photon:energy ratio

plus-.generic_spct

Arithmetic Operators

pow-.generic_spct

Arithmetic Operators

print.generic_spct

Print spectral objects

print.metadata

Print methods for metadata records

print.solar_time

Print solar time and solar date objects

print.summary_generic_spct

Print spectral summary

print.tod_time

Print time-of-day objects

print.waveband

Print a "waveband" object

prod_spectra

Multiply two spectra, even if the wavelengths values differ

pull_sample

Random sample of spectra

q_fluence

Photon fluence

q_fraction

Photon:photon fraction

q_irrad

Photon irradiance

q_ratio

Photon:photon ratio

q_response

Photon-based photo-response

q2e

Convert photon-based quantities into energy-based quantities

qe_ratio

Photon:energy ratio

r4p_pkgs

Packages in R for Photobiology suite

range

Wavelength range

rbindspct

Row-bind spectra

reflectance_spct

Calculate reflectance from spectral reflectance

reflectance

Reflectance

relative_AM

Relative Air Mass (AM)

select_spct_attributes

Merge user supplied attribute names with default ones

replace_bad_pixs

Replace bad pixels in a spectrum

resp_spct

Calculate response from spectral response

response

Integrated response

Rfr_fraction

reflectance:reflectance fraction

Rfr_from_n

Reflectance at a planar boundary

Rfr_normdiff

reflectance:reflectance normalised difference

Rfr_ratio

reflectance:reflectance ratio

rgb_spct

RGB color values

rmDerivedMspct

Remove "generic_mspct" and derived class attributes.

rmDerivedSpct

Remove "generic_spct" and derived class attributes.

round

Rounding of Numbers

rowwise

rowwise functions for collections of spectra

s_e_irrad2rgb

Spectral irradiance to rgb color conversion

s_mean_se_band

Mean plus and minus standard error from collection of spectra

spikes

Spikes

s_mean_se

Mean and standard error from collection of spectra

s_mean

Mean from collection of spectra

s_median

Median of a collection of spectra

s_prod

Product from collection of spectra

s_range

Range of a collection of spectra

s_sd

Standard Deviation of a collection of spectra

s_se

Standard Error of a collection of spectra

s_sum

Sum from collection of spectra

s_var

Variance of a collection of spectra

se.m

Standard error of the mean

se.p

Standard error of the mean

se

Standard error of the mean

setBSWFUsed

The "bswf.used" attribute

setFilterProperties

Set the "filter.properties" attribute

setGenericSpct

Convert an R object into a spectrum object.

setHowMeasured

Set the "how.measured" attribute

setIdFactor

Set the "idfactor" attribute

setInstrDesc

Set the "instr.desc" attribute

setInstrSettings

Set the "instr.settings" attribute

setKType

Set the "K.type" attribute

setMultipleWl

Set the "multiple.wl" attribute

setNormalized

Set the "normalized" and "normalization" attributes

split2mspct

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

setResponseType

Set the "response.type" attribute

setRfrType

The "Rfr.type" attribute

setScaled

Set the "scaled" attribute

setSoluteProperties

Set the "solute.properties" attribute

setTfrType

The "Tfr.type" attribute

setTimeUnit

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

setWhatMeasured

Set the "what.measured" attribute

setWhenMeasured

Set the "when.measured" attribute

setWhereMeasured

Set the "where.measured" attribute

shared_member_class

Classes common to all collection members.

sign

Sign

sinc

sinc

slash-.generic_spct

Arithmetic Operators

smooth_spct

Smooth a spectrum

solar_time

Local solar time

source_spct

Spectral-object constructors

spct_attr2tb

Copy attributes into a tibble

spct_classes

Function returning a vector containing the names of spectra classes.

spct_metadata

Access metadata

spct_wide2long

Convert spectrum from wide to long form

split_bands

List-of-wavebands constructor

split_energy_irradiance

Energy irradiance for split spectrum regions

split_irradiance

Energy or photon irradiance for split spectrum regions

split_photon_irradiance

Photon irradiance for split spectrum regions

stepsize

Stepsize

subset_attributes

Subset the metadata attributes

subset

Subsetting spectra

subset2mspct

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

subt_spectra

Subtract two spectra

sum_spectra

Add two spectra

summary_spct_classes

Function that returns a vector containing the names of spectral summar...

summary.generic_spct

Summary of one or more spectra

sun_angles

Solar angles

sun_daily.spct

Daily solar spectral irradiance (simulated)

sun_evening.spct

Time series of solar spectral irradiance (measured)

sun.spct

Solar spectral irradiance (simulated)

T2A

Convert transmittance into absorbance.

T2Afr

Convert transmittance into absorptance.

tag

Tag a spectrum

Tfr_fraction

transmittance:transmittance fraction

Tfr_normdiff

transmittance:transmittance normalised difference

Tfr_ratio

transmittance:transmittance ratio

thin_wl

Thin the density of wavelength values

times-.generic_spct

Arithmetic Operators

transmittance_spct

Calculate transmittance from spectral transmittance.

transmittance

Transmittance

Trig

Trigonometric Functions

trim_spct

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

trim_tails

Trim (or expand) head and/or tail

trim_waveband

Trim (or expand) head and/or tail

trim_wl

Trim head and/or tail of a spectrum

trimInstrDesc

Trim the "instr.desc" attribute

trimInstrSettings

Trim the "instr.settings" attribute

twilight2angle

twilight argument check and conversion

two_filters.spct

Transmittance spectrum of plastic films

two_irrads

Compute two irrads for ratio, fraction or normalised difference

two_reflectances

Compute two reflectances for ratio, fraction or normalised difference

two_transmittances

Compute two transmittances for ratio, fraction or normalised differenc...

tz_time_diff

Time difference between two time zones

uncollect2spct

Extract all members from a collection

untag

Remove tags

upgrade_spct

Upgrade one spectral object

upgrade_spectra

Upgrade one or more spectral objects

using_Tfr

Use photobiology options

v_insert_hinges

Insert spectral data values at new wavelength values.

v_replace_hinges

Overwrite spectral data values at existing wavelength values.

validate_geocode

Validate a geocode

valleys

Valleys or local minima

verbose_as_default

Set error reporting options

w_length_range2rgb

Wavelength range to rgb color conversion

w_length2rgb

Wavelength to rgb color conversion

water_vp_sat

Water vapour pressure

water.spct

Molar spectral attenuation coefficient of water

waveband_ratio

Photon or energy ratio

waveband

Waveband constructor method

wb_trim_as_default

Set computation options

wb2rect_spct

Create tagged spectrum from wavebands

wb2spct

Create spectrum from wavebands

wb2tagged_spct

Create tagged spectrum from wavebands

white_led.source_spct

White led bulb spectrum

wl2wavenumber

Wavelength conversions

wls_at_target

Find wavelengths values corresponding to a target spectral value

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: peaks, valleys and spikes. Conversion between energy-and photon-based units. Wavelength interpolation. Astronomical calculations related solar angles and day length. Colours and vision. This package is part of the 'r4photobiology' suite, Aphalo, P. J. (2015) <doi:10.19232/uv4pb.2015.1.14>.

  • Maintainer: Pedro J. Aphalo
  • License: GPL (>= 2)
  • Last published: 2024-08-25