R: Trim (or expand) head and/or tail

trim_waveband {photobiology} | R Documentation

## Trim (or expand) head and/or tail

### Description

Trimming of waveband boundaries can be required needed when the spectral data does not cover the whole waveband.

### Usage

    trim_waveband(w.band, range = NULL, low.limit = 0, high.limit = Inf,
      trim = getOption("photobiology.waveband.trim", default = TRUE),
      use.hinges = TRUE)

### Arguments

`w.band` | an object of class "waveband" or a list of such objects.
`range` | a numeric vector of length two, or any other object for which function range() will return a numeric vector of two wavelengths (nm).
`low.limit` | shortest wavelength to be kept (defaults to 0 nm).
`high.limit` | longest wavelength to be kept (defaults to Inf nm).
`trim` | logical (default is TRUE which trims the wavebands at the boundary, while FALSE discards wavebands that are partly off-boundary).
`use.hinges` | logical Flag indicating whether to insert "hinges" into the spectral data before integration so as to reduce interpolation errors at the boundaries of the wavebands.

### Value

A waveband object or a list of waveband objects trimmed or filtered depending on whether a single waveband object or a list of waveband objects was supplied as argument to formal parameter `w.band`.

### See Also

Other trim functions: `clip_wl`, `trim_spct`, `trim_wl`

### Examples

    VIS <- waveband(c(380, 760)) # nanometres

    trim_waveband(VIS, c(400,700))
    trim_waveband(VIS, low.limit = 400)
    trim_waveband(VIS, high.limit = 700)

[Package photobiology version 0.9.21 Index]