is_effective: Is an R object "effective"

In photobiology: Photobiological Calculations

Is an R object "effective"

Description

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

Usage

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)

• is_effective(default): Default method.

• is_effective(waveband): Is a waveband object defining a method for calculating effective irradiance.

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

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

• is_effective(summary_generic_spct): Method for "summary_generic_spct".

• is_effective(summary_source_spct): Method for "summary_source_spct".

See Also

Other waveband attributes: labels(), normalization()

Examples

is_effective(summary(sun.spct))

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