R: Clip head and/or tail of a spectrum

clip_wl {photobiology} | R Documentation

## Clip head and/or tail of a spectrum

### Description

Clip head and tail of a spectrum based on wavelength limits, no interpolation used at range boundaries.

### Usage

    clip_wl(x, range, ...)

    ## Default S3 method:
    clip_wl(x, range, ...)

    ## S3 method for class 'generic_spct'
    clip_wl(x, range = NULL, ...)

    ## S3 method for class 'generic_mspct'
    clip_wl(x, range = NULL, ...)

    ## S3 method for class 'waveband'
    clip_wl(x, range = NULL, ...)

    ## S3 method for class 'list'
    clip_wl(x, range = NULL, ...)

### Arguments

`x` | an R object.
`range` | a numeric vector of length two, or any other object for which function `range()` will return range of wavelengths expressed in nanometres.
`...` | ignored (possibly used by derived methods).

### Value

A copy of `x`, most frequently of a shorter length, and never longer.

### Methods (by class)

- `default`: Default for generic function

- `generic_spct`: Clip an object of class "generic_spct" or derived.

- `generic_mspct`: Clip an object of class "generic_mspct" or derived.

- `waveband`: Clip an object of class "waveband".

- `list`: Clip a list (of objects of class "waveband").

### Note

The condition tested is `wl >= range[1] & wl < (range[2] + 1e-13)`.

### See Also

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

### Examples

    clip_wl(sun.spct, range = c(400, 500))
    clip_wl(sun.spct, range = c(NA, 500))
    clip_wl(sun.spct, range = c(400, NA))

[Package photobiology version 0.9.21 Index]