do_addNoise: Add Noise to Dataset

View source: R/calc_noise.r

do_addNoiseR Documentation

Add Noise to Dataset

Description

Manually add noise to a provided dataset.

Usage

do_addNoise(dataset, noiseFile = "def", md = getmd())

Arguments

dataset

An object of class 'aquap_data' as generated by gfd

noiseFile

Character length one. The name of the corresponding noise data file residing in the AQUAP2SH folder. Leave at the default 'def' to read in the value from the settings.r file (parameter noi_noiseDataFilename), or provide the name of an existing R-data file in your specified AQUAP2SH folder to use this as source for the noise data. If a value other than "def" is provided, this is overriding the value of "noiseFileName" in the metadata file. Please see noise_procedures for more information.

md

The metadata from where the name of the noise-file is taken.

Details

Select the noise-mode in the settings.r file (parameter noi_addMode). You need to have an R-data file with noise-spectra in your settings-home folder, please refer to noise_procedures for further information.

Value

The dataset with added noise.

See Also

noise_procedures

Other Noise procedures: genNoiseRecExp(), noise_procedures

Other Data pre-treatment functions: [,aquap_data-method, do_avg(), do_blowup(), do_detrend(), do_emsc(), do_gapDer(), do_msc(), do_resampleNIR(), do_sgolay(), dpt_modules, selectWls(), ssc()

Examples

## Not run: 
fd <- gfd()
fdNoise <- do_addNoise(fd)

## End(Not run)

bpollner/aquap2 documentation built on March 29, 2024, 7:33 a.m.