ESR.Spectrum: ESR.Spectrum class objects

Description Usage Arguments Format Slots Methods Author(s) Examples

Description

Objects of class ESR, ESR.Spectrum are R6 objects and hence are usable in a more typical object-oriented language than R. For the user the main difference to R's internal S3 and S4 object implementation is that methods for R6 objects belong to the object itself. See details.

Usage

1
2
3
4
5
6
7
8
9
# ESR.Spectrum$new(originator, data)
# ESR.Spectrum$set_origin(originator)
# ESR.Spectrum$set_data(data)
# ESR.Spectrum$set_par(par)
# ESR.Spectrum$get_diff(x, order, ...)
# ESR.Spectrum$get_integral(x)
# ESR.Spectrum$get_spline(x, ...)
# ESR.Spectrum$get_gvalues(v, H, x)
# ESR.Spectrum$get_peaks(x, interval, th = 10)

Arguments

x

data.frame XY data of the ESR spectrum

originator

character name of the function call that created this object

data

data.frame XY values of the ESR spectrum

par

data.frame experimental parameters

order

integer order of the differential

v

numeric The microwave frequency in GHz

H

numeric A vector of magnetic field values in Gauss

interval

numeric a vector of length two specifying the range of x-values where peaks are searched

th

numeric: an integer specifying the number of neighbouring values to compare each x-value to

...

Further arguments passed to method specific functions.

Format

R6Class generator objects

Slots

originator

character Name of the function call that created this object

data

data.frame XY data of the ESR spectrum

parameter

data.frame experimental parameters

type

character currently unused

Methods

new(originator, data)

Initialize a new object of class ESR.Spectrum

set_data(data)

Sets the data of the object

set_origin(originator)

Sets the originator of the object

set_par(par)

Sets the experimental settings of the object

get_diff(x, order = 1, ...)

Returns the differential of the spectrum

get_integral(x)

Returns the integrant of the spectrum

get_spline(x, ...)

Returns a smoothed spectrum using the smooth.spline function

get_gvalues(v, H, x)

Calculates and returns the g-values of the spectrum

get_peaks(x, interval, th = 10)

Returns a vector of local minima and maxima in the spectrum. For details see find_Peaks.

Author(s)

Christoph Burow, University of Cologne (Germany)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
## create an object of class ESR.Spectrum
## and fill random data
x <- ESR.Spectrum$new()
x$set_data(data.frame(seq(3350, 3450, length.out = 1024), 
                                runif(1024, -1000, 1000)))

# plot the random data
plot(x)

## Not run: 
## public set methods
x$set_par()
x$set_data()
x$set_origin()

## End(Not run)

## public get methods
x$get_diff()
x$get_integral()
x$get_spline()
## Not run: 
x$get_gvalues()

## End(Not run)

tzerk/ESR documentation built on May 20, 2019, 1:12 p.m.