midpoint: Midpoint

View source: R/waveband.class.r

wl_midpointR Documentation

Midpoint

Description

A method that returns the wavelength [nm] (or value) at the center of the wavelength range of objects of classes waveband or of class generic_spct or derived (or the midpoint from a 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 [nm]. For any other R object, according to available definitions of min and max.

Methods (by class)

  • midpoint(default): Default method for generic function

  • midpoint(numeric): Default method for generic function

  • midpoint(waveband): Wavelength at center of a "waveband".

  • midpoint(generic_spct): Method for "generic_spct".

  • midpoint(generic_mspct): Method for "generic_mspct" objects.

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

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

midpoint(sun.spct)


photobiology documentation built on Oct. 21, 2023, 1:06 a.m.