midpoint: Midpoint

Description Usage Arguments Value Methods (by class) See Also Examples

View source: R/waveband.class.r

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
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 = !is.null(names(x)))

Arguments

x

an R object

...

not used in current version

idx

logical whether to add a column with the names of the elements of spct

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)

See Also

Other wavelength summaries: wl_min, wl_range, wl_stepsize

Other wavelength summaries: wl_min, wl_range, wl_stepsize

Other wavelength summaries: wl_min, wl_range, wl_stepsize

Examples

1
2
3
4
5

photobiology documentation built on April 3, 2018, 1:06 a.m.