Filter-class: Class Filter

Description Usage Arguments Slots Author(s)

Description

Class Filter contains the properties of a optical filter.

Method setFilter

Method getFilter

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
setFilter(name, description, reference.thickness, thickness, reflexion,
  reference.transmission)

## S4 method for signature 'character,character,numeric,numeric,numeric,matrix'
setFilter(name,
  description, reference.thickness, thickness, reflexion,
  reference.transmission)

getFilter(object, ref)

## S4 method for signature 'Filter,character'
getFilter(object, ref)

Arguments

name

character: Name of the filter

description

character: Description of the filter

reference.thickness

numeric: Reference thickness for the filter.

thickness

numeric: Actual filter thickness (by default, the reference thickness).

reflexion

numeric: Reflection of the filter (1-P) (between 0, which means that the signal is completely reflected, and 1, which means there is no reflection of the signal).

reference.transmission

matrix: Transmission matrix of the filter. The first column contains the wavelength [nm] and the second the transmission [0-1] at these wavelengths.

object

Filter: Filter

ref

character: Slot reference.

Slots

name

character: Name of the filter

description

character: Description of the filter

reference.thickness

numeric: Reference thickness for the filter.

thickness

numeric: Actual filter thickness (by default, the reference thickness).

reflexion

numeric: Reflection of the filter (1-P) (between 0, which means that the signal is completely reflected, and 1, which means there is no reflection of the signal).

reference.transmission

matrix: Transmission matrix of the filter for the reference.thickness. The first column contains the wavelength [nm] and the second the transmission [0-1] at these wavelengths.

transmission

matrix: Transmission matrix of the filter. The first column contains the wavelength [nm] and the second the transmission [0-1] at these wavelengths.

Author(s)

David Strebler


gadaviel/LumReader documentation built on May 16, 2019, 5:33 p.m.