photobiology: midpoint – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

midpoint

Midpoint

Description

A function that returns the wavelength (or value) at the center of the of the wavelength range of a waveband or spectrum object (or numeric vector).

Usage

wl_midpoint(x, ...)

midpoint(x, ...)

## Default S3 method:
midpoint(x, ...)

## S3 method for class 'numeric'
midpoint(x, ...)

## S3 method for class 'waveband'
midpoint(x, ...)

## S3 method for class 'generic_spct'
midpoint(x, ...)

## S3 method for class 'generic_mspct'
midpoint(x, ..., idx = "spct.idx")

Arguments

`x`	an R object
`...`	not used in current version
`idx`	character Name of the column with the names of the members of the collection of spectra.

Value

A numeric value equal to (max(x) - min(x)) / 2. In the case of spectral objects a wavelength in nm. For any other R object, according to available definitions of min and max.

Methods (by class)

default: Default method for generic function
numeric: Default method for generic function
waveband: Wavelength at center of a "waveband".
generic_spct: Method for "generic_spct".
generic_mspct: Method for "generic_mspct" objects.

Examples

midpoint(10:20)
midpoint(sun.spct)
wl_midpoint(sun.spct)

midpoint(sun.spct)

photobiology

Photobiological Calculations

v0.10.10

GPL (>= 2)

Authors

Pedro J. Aphalo [aut, cre] (<https://orcid.org/0000-0003-3385-972X>), Titta K. Kotilainen [ctb] (<https://orcid.org/0000-0002-2822-9734>), Glenn Davis [ctb], Agnese Fazio [ctb]

Initial release

2022-03-24