is_effective: Is an R object "effective"

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

Description

A generic function for quering if a biological spectral weighting function (BSWF) has been applied to an object or is included in its definition.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
is_effective(x)

## Default S3 method:
is_effective(x)

## S3 method for class 'waveband'
is_effective(x)

## S3 method for class 'generic_spct'
is_effective(x)

## S3 method for class 'source_spct'
is_effective(x)

## S3 method for class 'summary_generic_spct'
is_effective(x)

## S3 method for class 'summary_source_spct'
is_effective(x)

Arguments

x

an R object

Value

A logical.

Methods (by class)

  • default: Default method.

  • waveband: Is a waveband object defining a method for calcualtaing effective irradiance.

  • generic_spct: Does a source_spct object contain effective spectral irradiance values.

  • source_spct: Does a source_spct object contain effective spectral irradiance values.

  • summary_generic_spct: Method for "summary_generic_spct".

  • summary_source_spct: Method for "summary_source_spct".

See Also

Other waveband attributes: labels, normalization

Examples

1


Search within the photobiology package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.